info.bioinfweb.libralign.dataarea.implementations

Class LabelDataArea

java.lang.Object

info.bioinfweb.tic.TICComponent

info.bioinfweb.libralign.alignmentarea.content.AlignmentSubArea

info.bioinfweb.libralign.dataarea.DataArea

info.bioinfweb.libralign.dataarea.implementations.LabelDataArea

All Implemented Interfaces:

AlignmentModelChangeListener

public class LabelDataArea
extends DataArea

A simple data area implementation that displays one line of text.

Since:

0.7.0

Author:

Ben Stöver

Field Summary

Fields inherited from class info.bioinfweb.tic.TICComponent

DISPATCHER_MAP, repaintRequested

Constructor Summary

Constructors

Constructor and Description
LabelDataArea(AlignmentContentArea owner, AlignmentArea labeledArea)
LabelDataArea(AlignmentContentArea owner, AlignmentArea labeledArea, java.lang.String text)
LabelDataArea(AlignmentContentArea owner, AlignmentArea labeledArea, java.lang.String text, boolean alignToFirstColumn, boolean alignToScrollPosition)

Method Summary

Modifier and Type	Method and Description
<T,U> void	afterModelChanged(AlignmentModel<T> previous, AlignmentModel<U> current) Called if this listener was moved to another instance of AlignmentModel.
<T> void	afterSequenceChange(SequenceChangeEvent<T> e) Called after a sequence has been inserted, removed or replaced.
<T> void	afterSequenceRenamed(SequenceRenamedEvent<T> e) Called after a sequence was renamed.
<T> void	afterTokenChange(TokenChangeEvent<T> e) Called after a single token or a set of tokens has been inserted, removed or replaced.
java.awt.Color	getBackgroundColor()
java.awt.Font	getFont() Returns the font used to display the text in this data area.
double	getHeight() Returns the height in pixels considering the current zoom factor this component needs.
java.lang.String	getText()
java.awt.Color	getTextColor()
boolean	isAlignToFirstColumn() Determines whether the start of the text is displayed at the left end of the component or at the left end of the first column of the alignment.
boolean	isAlignToScrollPosition() Determines whether the start of the text of this component should move if the component is scrolled horizontally.
void	paintPart(AlignmentPaintEvent e) Implementations of this method perform the painting of a part of the component.
void	setAlignToFirstColumn(boolean alignToFirstColumn)
void	setAlignToScrollPosition(boolean alignToScrollPosition)
void	setBackgroundColor(java.awt.Color backgroundColor)
void	setFont(java.awt.Font font)
void	setText(java.lang.String text)
void	setTextColor(java.awt.Color textColor)
java.util.Set<DataAreaListType>	validLocations() The result should enumerate all valid locations where the implementing data area is allowed to be located.

Methods inherited from class info.bioinfweb.libralign.dataarea.DataArea

getLabeledAlignmentArea, getLabeledAlignmentModel, getLengthAfterEnd, getLengthBeforeStart, getList, isVisible, setList, setVisible

Methods inherited from class info.bioinfweb.libralign.alignmentarea.content.AlignmentSubArea

createLabelSubArea, getLabelSubArea, getOwner, getSize, paint, repaint

Methods inherited from class info.bioinfweb.tic.TICComponent

addKeyListener, addMouseListener, addMouseWheelListener, assignSize, dispatchEvent, getCurrentToolkit, getKeyListenersSet, getMouseListenersSet, getMouseWheelListenersSet, getSwingComponentClassName, getSwingComponentConstructorParameters, getSWTComponentClassName, getSWTComponentConstructorParameters, getToolkitComponent, hasDefinedSize, hasToolkitComponent, isUpdateOngoing, removeKeyListener, removeMouseListener, removeWheelMouseListener, setToolkitComponent, setUpdateOngoing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelDataArea

public LabelDataArea(AlignmentContentArea owner,
                     AlignmentArea labeledArea)

LabelDataArea

public LabelDataArea(AlignmentContentArea owner,
                     AlignmentArea labeledArea,
                     java.lang.String text)

LabelDataArea

public LabelDataArea(AlignmentContentArea owner,
                     AlignmentArea labeledArea,
                     java.lang.String text,
                     boolean alignToFirstColumn,
                     boolean alignToScrollPosition)

Method Detail

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

getFont

public java.awt.Font getFont()

Returns the font used to display the text in this data area.

Note that the size of the returned font applies to 100 % zoom.

Returns:

the font object for 100 % zoom

setFont

public void setFont(java.awt.Font font)

isAlignToScrollPosition

public boolean isAlignToScrollPosition()

Determines whether the start of the text of this component should move if the component is scrolled horizontally.

Returns:

true if the start of the text moves within the component to stay visible during scrolling or false if it remains at a fixed position

setAlignToScrollPosition

public void setAlignToScrollPosition(boolean alignToScrollPosition)

isAlignToFirstColumn

public boolean isAlignToFirstColumn()

Determines whether the start of the text is displayed at the left end of the component or at the left end of the first column of the alignment. (These two positions are different if data areas occupy space left of the alignment.)

Note that the text may start even further right, if isAlignToScrollPosition() is set too, depending on the scroll position.

Returns:

true if the text should start above the first column or false if it always starts at the left of the component

setAlignToFirstColumn

public void setAlignToFirstColumn(boolean alignToFirstColumn)

getTextColor

public java.awt.Color getTextColor()

setTextColor

public void setTextColor(java.awt.Color textColor)

getBackgroundColor

public java.awt.Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)

validLocations

public java.util.Set<DataAreaListType> validLocations()

Description copied from class: DataArea

The result should enumerate all valid locations where the implementing data area is allowed to be located.

An implementation for a data area could be located everywhere could look like this:

return EnumSet.of(DataAreaListType.TOP, DataAreaListType.BOTTOM, DataAreaListType.SEQUENCE);

Specified by:

validLocations in class DataArea

Returns:

a non-empty set of locations

paintPart

public void paintPart(AlignmentPaintEvent e)

Description copied from class: AlignmentSubArea

Implementations of this method perform the painting of a part of the component. It is used when an AlignmentArea is set to contain no subcomponents but to paint its contents directly.

This default implementation always throws an UnsupportedOperationException. Note that therefore inherited classes must either overwrite this method or #createComponent() in order to return an instance there that does not delegate to this method.

Note that the aim of this method is to allow painting very wide components, which may have a width larger than Integer.MAX_VALUE. Therefore painting coordinates are stored as double values (using Graphics2D and Rectangle2D.Double). Implementations should not calculate pixel coordinates as ints at any time to avoid overflows, but only use double (or possibly long if necessary).

Overrides:

paintPart in class AlignmentSubArea

Parameters:

e - the paint event providing information on the area to be painted, the graphics context and tool methods.

getHeight

public double getHeight()

Description copied from class: AlignmentSubArea

Returns the height in pixels considering the current zoom factor this component needs.

Specified by:

getHeight in class AlignmentSubArea

Returns:

a double value > 0

afterSequenceChange

public <T> void afterSequenceChange(SequenceChangeEvent<T> e)

Description copied from interface: AlignmentModelChangeListener

Called after a sequence has been inserted, removed or replaced.

Parameters:

e - the event object containing information on the change

afterSequenceRenamed

public <T> void afterSequenceRenamed(SequenceRenamedEvent<T> e)

Description copied from interface: AlignmentModelChangeListener

Called after a sequence was renamed.

Parameters:

e - the event object containing information on the change

afterTokenChange

public <T> void afterTokenChange(TokenChangeEvent<T> e)

Description copied from interface: AlignmentModelChangeListener

Called after a single token or a set of tokens has been inserted, removed or replaced.

Parameters:

e - the event object containing information on the change

afterModelChanged

public <T,U> void afterModelChanged(AlignmentModel<T> previous,
                                    AlignmentModel<U> current)

Description copied from interface: AlignmentModelChangeListener

Called if this listener was moved to another instance of AlignmentModel.

This happens if the alignment model of an AlignmentArea was changed.

Parameters:

previous - the alignment model this listener was attached to before the event happened

current - the new alignment model this listener is attached to now