AlignmentLabelArea

java.lang.Object
- info.bioinfweb.tic.TICComponent
- - info.bioinfweb.libralign.alignmentarea.label.AlignmentLabelArea

```
public class AlignmentLabelArea
extends TICComponent
```
A toolkit independent GUI component displaying the sequence names in an AlignmentArea.
Application developers will not need to create instances of this class directly but should use AlignmentArea.

Since:

0.2.0

Author:

Ben Stöver

Field Summary

Fields
Modifier and Type Field and Description

static int BORDER_WIDTH

static double RECALCULATE_VALUE
- Fields inherited from class info.bioinfweb.tic.TICComponent
  DISPATCHER_MAP, repaintRequested

Fields
Modifier and Type	Field and Description
`static int`	`BORDER_WIDTH`
`static double`	`RECALCULATE_VALUE`

Constructor Summary

Constructors
Constructor and Description

AlignmentLabelArea(AlignmentArea owner)
Creates a new instance of this class.

Constructors
Constructor and Description
`AlignmentLabelArea(AlignmentArea owner)` Creates a new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignSizeToAll()`
`double`	`getGlobalMaxNeededWidth()` Returns the maximum needed width to label the alignment calculated over all alignments contained in the parent `MultipleAlignmentsContainer`.
`double`	`getLocalMaximumNeededWidth()` Calculates the needed with to label the associated alignment.
`AlignmentArea`	`getOwner()` Returns the alignment area that uses this instance.
`java.awt.Dimension`	`getSize()`
`protected java.lang.String`	`getSwingComponentClassName(java.lang.Object... parameters)`
`protected java.lang.String`	`getSWTComponentClassName(java.lang.Object... parameters)`
`ToolkitSpecificAlignmentLabelArea`	`getToolkitComponent()`
`void`	`paint(TICPaintEvent event)`
`void`	`setLocalMaxWidthRecalculate()` Flags the needed width to display all labels to be recalculated the next time it is accessed.
`void`	`setLocalMaxWidthRecalculateToAll()`
`AlignmentLabelSubAreaIterator`	`subAreaIterator()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BORDER_WIDTH
```
public static final int BORDER_WIDTH
```
    See Also:
    
    Constant Field Values
  - RECALCULATE_VALUE
```
public static final double RECALCULATE_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AlignmentLabelArea
```
public AlignmentLabelArea(AlignmentArea owner)
```
    Creates a new instance of this class.
    
    Parameters:
    
    owner - the alignment area that uses this instance
    
    position - Specify here whether this area will be used to label the head, the content, or the bottom part of the alignment area.
- Method Detail
  - getOwner
```
public AlignmentArea getOwner()
```
    Returns the alignment area that uses this instance.
    
    Returns:
    
    the owning alignment area
  - subAreaIterator
```
public AlignmentLabelSubAreaIterator subAreaIterator()
```
  - getLocalMaximumNeededWidth
```
public double getLocalMaximumNeededWidth()
```
    Calculates the needed with to label the associated alignment. Note that the actual width of this component is calculated using getGlobalMaxNeededWidth().
    
    Returns:
    
    a value >= 0
  - setLocalMaxWidthRecalculate
```
public void setLocalMaxWidthRecalculate()
```
    Flags the needed width to display all labels to be recalculated the next time it is accessed.
    Note that this method only marks the needed width of this area to be recalculated. setLocalMaxWidthRecalculateToAll() should always be called instead, unless this method is called manually for all areas inside an MultipleAlignmentsContainer.
    Application code will usually not have to call this method directly.
  - setLocalMaxWidthRecalculateToAll
```
public void setLocalMaxWidthRecalculateToAll()
```
  - getGlobalMaxNeededWidth
```
public double getGlobalMaxNeededWidth()
```
    Returns the maximum needed width to label the alignment calculated over all alignments contained in the parent MultipleAlignmentsContainer. If the parent alignment area is not contained in such a container, the return value is equal to getLocalMaximumNeededWidth().
    
    Returns:
    
    a value >= 0
  - getSize
```
public java.awt.Dimension getSize()
```
    Overrides:
    
    getSize in class TICComponent
  - assignSizeToAll
```
public void assignSizeToAll()
```
  - paint
```
public void paint(TICPaintEvent event)
```
    Overrides:
    
    paint in class TICComponent
  - 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
  - getToolkitComponent
```
public ToolkitSpecificAlignmentLabelArea getToolkitComponent()
```
    Overrides:
    
    getToolkitComponent in class TICComponent

Class AlignmentLabelArea

Field Summary

Fields inherited from class info.bioinfweb.tic.TICComponent

Constructor Summary

Method Summary

Methods inherited from class info.bioinfweb.tic.TICComponent

Methods inherited from class java.lang.Object

Field Detail

BORDER_WIDTH

RECALCULATE_VALUE

Constructor Detail

AlignmentLabelArea

Method Detail

getOwner

subAreaIterator

getLocalMaximumNeededWidth

setLocalMaxWidthRecalculate

setLocalMaxWidthRecalculateToAll

getGlobalMaxNeededWidth

getSize

assignSizeToAll

paint

getSwingComponentClassName

getSWTComponentClassName

getToolkitComponent