info.bioinfweb.libralign.multiplealignments

Class MultipleAlignmentsContainer

java.lang.Object

info.bioinfweb.tic.TICComponent

info.bioinfweb.libralign.multiplealignments.MultipleAlignmentsContainer

public class MultipleAlignmentsContainer
extends TICComponent

This class allows to use multiple instances of AlignmentArea, that are coupled related to horizontal scrolling. This can e.g. be used to display a data area with heading information (e.g. SequenceIndexArea) which always remains visible independently of the vertical scrolling of the alignment it belongs to. (To achieve this you would add to alignment areas to an instance of this class, one containing the heading data area and the other one containing the alignment.)

Note that it makes only sense to combine alignment areas that display related information and therefore have an equal number of according columns (except the area containing only data areas).

Since:

0.3.0

Author:

Ben Stöver

Field Summary

Fields inherited from class info.bioinfweb.tic.TICComponent

DISPATCHER_MAP, repaintRequested

Constructor Summary

Constructors

Constructor and Description
MultipleAlignmentsContainer()

Method Summary

Modifier and Type	Method and Description
void	assignSizeToAll()
AlignmentAreaList	getAlignmentAreas() Use the returned instance to change the alignment areas contained in this container.
EditSettings	getEditSettings() Returns the edit settings that are shared among all contained alignment areas.
AlignmentArea	getFocusedAlignmentArea() Returns the alignment area contained in this component, that currently has the focus.
java.util.Set<java.lang.String>	getPaintSettingsToSynchronize() Returns a set of property names that are synchronized between the paint setting objects of the alignment areas contained in this container.
java.awt.Dimension	getSize()
protected java.lang.String	getSwingComponentClassName(java.lang.Object... parameters)
protected java.lang.String	getSWTComponentClassName(java.lang.Object... parameters)
protected java.lang.Object[]	getSWTComponentConstructorParameters(java.lang.Object... parameters)
ToolkitSpecificMultipleAlignmentsContainer	getToolkitComponent()
boolean	isDistributeRemainingSpace() Returns whether remaining space shall be distributed among all scrollable alignments.
void	paint(TICPaintEvent event)
void	redistributeHeight()
void	setAllPaintSettingPropertiesToSynchronize() Sets all properties of PaintSettings to be synchronized between all alignment areas in this container.
void	setDistributeRemainingSpace(boolean distributeRemainingSpace) If the height of this container is higher than the height that is needed to display all alignments without scrolling, you can specify here how the remaining space shall be distributed among the alignments.

Methods inherited from class info.bioinfweb.tic.TICComponent

addKeyListener, addMouseListener, addMouseWheelListener, assignSize, dispatchEvent, getCurrentToolkit, getKeyListenersSet, getMouseListenersSet, getMouseWheelListenersSet, getSwingComponentConstructorParameters, hasDefinedSize, hasToolkitComponent, isUpdateOngoing, removeKeyListener, removeMouseListener, removeWheelMouseListener, repaint, setToolkitComponent, setUpdateOngoing

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleAlignmentsContainer

public MultipleAlignmentsContainer()

Method Detail

getAlignmentAreas

public AlignmentAreaList getAlignmentAreas()

Use the returned instance to change the alignment areas contained in this container.

Returns:

a reference to the list with the alignment areas currently contained in this container

getEditSettings

public EditSettings getEditSettings()

Returns the edit settings that are shared among all contained alignment areas.

Returns:

the edit settings object

isDistributeRemainingSpace

public boolean isDistributeRemainingSpace()

Returns whether remaining space shall be distributed among all scrollable alignments. (See setDistributeRemainingSpace(boolean) for further details.)

Returns:

true is the height shall be distributed, false if the bottom most alignment shall get all the space

setDistributeRemainingSpace

public void setDistributeRemainingSpace(boolean distributeRemainingSpace)

If the height of this container is higher than the height that is needed to display all alignments without scrolling, you can specify here how the remaining space shall be distributed among the alignments.

Parameters:

distributeRemainingSpace - Specify true here if you want the additional height to be distributed equally among all alignments that are marked as vertically scrollable. If you specify false the whole space is provided to the bottom most alignment (no matter if it is scrollable or not).

getSwingComponentClassName

protected java.lang.String getSwingComponentClassName(java.lang.Object... parameters)

Overrides:

getSwingComponentClassName in class TICComponent

getSWTComponentClassName

protected java.lang.String getSWTComponentClassName(java.lang.Object... parameters)

Overrides:

getSWTComponentClassName in class TICComponent

getSWTComponentConstructorParameters

protected java.lang.Object[] getSWTComponentConstructorParameters(java.lang.Object... parameters)

Overrides:

getSWTComponentConstructorParameters in class TICComponent

getSize

public java.awt.Dimension getSize()

Overrides:

getSize in class TICComponent

paint

public void paint(TICPaintEvent event)

Overrides:

paint in class TICComponent

getToolkitComponent

public ToolkitSpecificMultipleAlignmentsContainer getToolkitComponent()

Overrides:

getToolkitComponent in class TICComponent

assignSizeToAll

public void assignSizeToAll()

redistributeHeight

public void redistributeHeight()

getFocusedAlignmentArea

public AlignmentArea getFocusedAlignmentArea()

Returns the alignment area contained in this component, that currently has the focus. (It is also possible, that a subcomponent if the returned area (e.g. a sequence or data area) has the focus.)

Note that this method behaves slightly different if used in Swing or in SWT. In Swing applications the components contained in an alignment area may loose their focus, if the user clicks on a menu entry (unless the JRootPane is not set unfocusable) or a button. Therefore the focused alignment area may not be correctly determined inside an action attached to another Swing component (e.g. a button or a menu item), because this component then has the focus. This problem will not occur if an action is invoked using a keyboard shortcut.

In SWT applications the focused alignment area can usually still be determined, even if a button or menu item is currently active.

Returns:

the focused alignment area in this component or null of the focus is not inside this container

getPaintSettingsToSynchronize

public java.util.Set<java.lang.String> getPaintSettingsToSynchronize()

Returns a set of property names that are synchronized between the paint setting objects of the alignment areas contained in this container. By default all properties are synchronized. Application code can add names to define single paint settings as global. (Such a property will than be changed in all alignment areas of this container, as soon as it is modified in one of them.)

Note that all simple properties of PaintSettings can be added here, but it is not possible to synchronize token painters.

Returns:

a modifiable set of paint setting property names

See Also:

PaintSettings

setAllPaintSettingPropertiesToSynchronize

public void setAllPaintSettingPropertiesToSynchronize()

Sets all properties of PaintSettings to be synchronized between all alignment areas in this container.