info.bioinfweb.libralign.alignmentarea.paintsettings

Class PaintSettings

java.lang.Object

info.bioinfweb.libralign.alignmentarea.paintsettings.PaintSettings

public class PaintSettings
extends java.lang.Object

Object that manages properties related to painting the contents of an AlignmentArea.

Since:

0.4.0

Author:

Ben Stöver

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_CURSOR_LINE_WIDTH The initial cursor line width.

Constructor Summary

Constructors

Constructor and Description
PaintSettings(AlignmentArea owner) Creates a new instance of this class using default values for the properties.

Method Summary

Modifier and Type	Method and Description
boolean	addListener(PaintSettingsListener listener) Attaches a paint settings listener to this instance.
protected void	firePropertyChanged(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
protected void	fireTokenPainterListChange()
protected void	fireTokenPainterReplaced(TokenPainter previousPainter, TokenPainter newPainter, int index)
protected void	fireZoomChange(double oldZoomX, double oldZoomY)
java.awt.Color	getCursorColor()
double	getCursorLineWidth()
AlignmentArea	getOwner() Returns the alignment area using this instance.
java.awt.Color	getSelectionColor()
double	getTokenHeight() Returns the height of tokens displayed in this alignment recognizing the current value of getZoomY().
java.awt.Font	getTokenHeightFont() Returns a sans serif plain font object with the size according to the token height in the current zoom factor.
TokenPainterList	getTokenPainterList() Returns the list of token painters to be used for the output of the data from the alignment model.
double	getTokenWidth(int columnIndex) Returns the width of the column with the specified index.
double	getZoomX() Returns the vertical zoom factor in an alignment area, that e.g.
double	getZoomY() Returns the horizontal zoom factor in an alignment area, that e.g.
boolean	isChangeZoomXOnMouseWheel() Indicates whether the horizontal zoom factor shall be changed, if the user moves the mouse wheel while pressing the control button (or meta button on Macs).
boolean	isChangeZoomYOnMouseWheel() Indicates whether the vertical zoom factor shall be changed, if the user moves the mouse wheel while pressing the control button (or meta button on Macs).
double	maxTokenWidth() Returns the maximal token width in the alignment according to the current zoom factor.
double	minTokenWidth() Returns the minimal token width in the alignment according to the current zoom factor.
boolean	removeListener(PaintSettingsListener listener) Removes a paint settings listener from this instance.
void	setChangeZoomXOnMouseWheel(boolean zoomXOnMouseWheel)
void	setChangeZoomYOnMouseWheel(boolean zoomYOnMouseWheel)
void	setCursorColor(java.awt.Color cursorColor) Sets a new color to paint the alignment cursor.
void	setCursorLineWidth(double cursorLineWidth)
void	setSelectionColor(java.awt.Color selectionColor) Sets a new color of the selection in the owning alignment area.
void	setZoom(double zoomX, double zoomY) Allows to specify a new horizontal and vertical zoom factor in a single operation.
void	setZoomX(double zoomX) Allows to specify a new horizontal zoom factor.
void	setZoomY(double zoomY) Allows to specify a new vertical zoom factor.
java.awt.Font	zoomFont(java.awt.Font font)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CURSOR_LINE_WIDTH

public static final double DEFAULT_CURSOR_LINE_WIDTH

The initial cursor line width.

See Also:

Constant Field Values

Constructor Detail

PaintSettings

public PaintSettings(AlignmentArea owner)

Creates a new instance of this class using default values for the properties.

Parameters:

owner - the alignment area using this instance

Method Detail

getOwner

public AlignmentArea getOwner()

Returns the alignment area using this instance.

Returns:

the associated alignment area

getTokenPainterList

public TokenPainterList getTokenPainterList()

Returns the list of token painters to be used for the output of the data from the alignment model. If an concatenated alignment model is used, this list holds one painter for each part (column range), otherwise it will only contain one.

The size and the order of the list are updated automatically depending on alignment model changes (events).

Returns:

the token painter list

getCursorColor

public java.awt.Color getCursorColor()

setCursorColor

public void setCursorColor(java.awt.Color cursorColor)

Sets a new color to paint the alignment cursor.

Parameters:

cursorColor - the new cursor color

Throws:

java.lang.NullPointerException - if null is specified

getSelectionColor

public java.awt.Color getSelectionColor()

setSelectionColor

public void setSelectionColor(java.awt.Color selectionColor)

Sets a new color of the selection in the owning alignment area.

Parameters:

selectionColor - the new selection color

Throws:

java.lang.NullPointerException - if null is specified

getCursorLineWidth

public double getCursorLineWidth()

setCursorLineWidth

public void setCursorLineWidth(double cursorLineWidth)

getZoomX

public double getZoomX()

Returns the vertical zoom factor in an alignment area, that e.g. determines the token width.

Returns:

the zoom factor where 1.0 indicates 100 % zoom (original size)

getZoomY

public double getZoomY()

Returns the horizontal zoom factor in an alignment area, that e.g. determines the token width.

Returns:

the zoom factor where 1.0 indicates 100 % zoom (original size)

setZoomX

public void setZoomX(double zoomX)

Allows to specify a new horizontal zoom factor.

Note that setZoom(double, double) should always be preferred (when both properties are to be set) over calling both single parameter setters in sequence to avoid unnecessary repaint and resize operations.

Parameters:

zoomX - the new horizontal zoom factor

Throws:

java.lang.IllegalArgumentException - if a zoom factor <= 0 is specified

See Also:

setZoom(double, double), setChangeZoomXOnMouseWheel(boolean)

setZoomY

public void setZoomY(double zoomY)

Allows to specify a new vertical zoom factor.

Note that setZoom(double, double) should always be preferred (when both properties are to be set) over calling both single parameter setters in sequence to avoid unnecessary repaint and resize operations.

Parameters:

zoomY - the new vertical zoom factor

Throws:

java.lang.IllegalArgumentException - if a zoom factor <= 0 is specified

See Also:

setZoom(double, double), setChangeZoomYOnMouseWheel(boolean)

setZoom

public void setZoom(double zoomX,
                    double zoomY)

Allows to specify a new horizontal and vertical zoom factor in a single operation. Only one event indicating both changes will be fired.

Parameters:

zoomX - the new horizontal zoom factor

zoomY - the new vertical zoom factor

Throws:

java.lang.IllegalArgumentException - if a zoom factor <= 0 is specified

See Also:

setChangeZoomXOnMouseWheel(boolean), setChangeZoomYOnMouseWheel(boolean)

isChangeZoomXOnMouseWheel

public boolean isChangeZoomXOnMouseWheel()

Indicates whether the horizontal zoom factor shall be changed, if the user moves the mouse wheel while pressing the control button (or meta button on Macs).

Returns:

true if the zoom will be changed, false otherwise

setChangeZoomXOnMouseWheel

public void setChangeZoomXOnMouseWheel(boolean zoomXOnMouseWheel)

isChangeZoomYOnMouseWheel

public boolean isChangeZoomYOnMouseWheel()

Indicates whether the vertical zoom factor shall be changed, if the user moves the mouse wheel while pressing the control button (or meta button on Macs).

Returns:

true if the zoom will be changed, false otherwise

setChangeZoomYOnMouseWheel

public void setChangeZoomYOnMouseWheel(boolean zoomYOnMouseWheel)

getTokenWidth

public double getTokenWidth(int columnIndex)

Returns the width of the column with the specified index. If the index is out of bounds (the specified column does not exist in the alignment model) or no alignment model is defined in the owning alignment area, the token width of the default token painter is returned.

Parameters:

columnIndex - the index of the column to determine the width from

Returns:

the width of column in pixels

maxTokenWidth

public double maxTokenWidth()

Returns the maximal token width in the alignment according to the current zoom factor.

The preferred with of a respective default painter is considered if a painter for at least one alignment model (if model models are present using ConcatenatedAlignmentModel) is missing in the list.

Returns:

the maximal token width in pixels

minTokenWidth

public double minTokenWidth()

Returns the minimal token width in the alignment according to the current zoom factor.

The preferred with of a respective default painter is considered if a painter for at least one alignment model (if model models are present using ConcatenatedAlignmentModel) is missing in the list.

Returns:

the minimal token width in pixels

getTokenHeight

public double getTokenHeight()

Returns the height of tokens displayed in this alignment recognizing the current value of getZoomY().

Returns:

the height in pixels

getTokenHeightFont

public java.awt.Font getTokenHeightFont()

Returns a sans serif plain font object with the size according to the token height in the current zoom factor.

Returns:

the font object

zoomFont

public java.awt.Font zoomFont(java.awt.Font font)

addListener

public boolean addListener(PaintSettingsListener listener)

Attaches a paint settings listener to this instance.

Parameters:

listener - the listener to be attached

Returns:

true if the new listener was added, false if that listener was already attached

removeListener

public boolean removeListener(PaintSettingsListener listener)

Removes a paint settings listener from this instance.

Parameters:

listener - the listener to be removed

Returns:

true if the listener was removed, false if it was not attached before calling this method

firePropertyChanged

protected void firePropertyChanged(java.lang.String propertyName,
                                   java.lang.Object oldValue,
                                   java.lang.Object newValue)

fireZoomChange

protected void fireZoomChange(double oldZoomX,
                              double oldZoomY)

fireTokenPainterReplaced

protected void fireTokenPainterReplaced(TokenPainter previousPainter,
                                        TokenPainter newPainter,
                                        int index)

fireTokenPainterListChange

protected void fireTokenPainterListChange()