info.bioinfweb.libralign.multiplealignments

Interface ToolkitSpecificMultipleAlignmentsContainer

All Superinterfaces:

ToolkitComponent

All Known Implementing Classes:

SwingMultipleAlignmentsContainer, SWTMultipleAlignmentsContainer

public interface ToolkitSpecificMultipleAlignmentsContainer
extends ToolkitComponent

Common interface for toolkit specific components displaying the contents of a MultipleAlignmentsContainer.

Since:

0.2.0

Author:

Ben Stöver

Method Summary

Modifier and Type	Method and Description
void	adoptChildAreas() This method is used internally by MultipleAlignmentsContainer if the order or set of contained alignment areas changes and these changes shall be reflected by the underlying GUI component.
int	getAvailableHeight() Returns the height that is currently available to be distributed among all contained alignment areas.
AlignmentArea	getFocusedAlignmentArea() Returns the alignment area contained in this component, that currently has the focus.
int	getNeededHeight(int alignmentIndex) Return the height needed for the specified alignment to be displayed without scroll bars.
void	setDividerLocations(int[] heights) Sets the divider locations to distribute the available height among the contained alignment areas.

Methods inherited from interface info.bioinfweb.tic.toolkit.ToolkitComponent

assignSize, getIndependentComponent, getLocationInParent, getTargetToolkit, getToolkitSize, isFocusOwner, repaint, requestFocus

Method Detail

adoptChildAreas

void adoptChildAreas()

This method is used internally by MultipleAlignmentsContainer if the order or set of contained alignment areas changes and these changes shall be reflected by the underlying GUI component.

getAvailableHeight

int getAvailableHeight()

Returns the height that is currently available to be distributed among all contained alignment areas.

Returns:

the sum of the heights of all visible rectangles of the contained scrolled components

getNeededHeight

int getNeededHeight(int alignmentIndex)

Return the height needed for the specified alignment to be displayed without scroll bars.

Parameters:

alignmentIndex - the current index of the alignment in the container

Returns:

the height in pixels

setDividerLocations

void setDividerLocations(int[] heights)

Sets the divider locations to distribute the available height among the contained alignment areas.

Parameters:

heights - an array containing the heights for all alignment areas

getFocusedAlignmentArea

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 application developers should use MultipleAlignmentsContainer.getFocusedAlignmentArea() instead of calling this method directly, because that method also checks, if a toolkit-specific component has already been created.

Returns:

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

See Also:

MultipleAlignmentsContainer.getFocusedAlignmentArea()