info.bioinfweb.libralign.alignmentarea.selection

Class OneDimensionalSelection

java.lang.Object

info.bioinfweb.libralign.alignmentarea.selection.OneDimensionalSelection

public class OneDimensionalSelection
extends java.lang.Object

Manages the selection of columns or rows.

Warning: This class is meant only for internal use in LibrAlign and its API is not guaranteed to remain stable within on major version number.

Since:

0.0.0

Author:

Ben Stöver

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_SELECTION

Constructor Summary

Constructors

Constructor and Description
OneDimensionalSelection(SelectionModel owner, SelectionDimension dimension)

Method Summary

Modifier and Type	Method and Description
void	adoptFromOther(OneDimensionalSelection other)
void	clear() Clears this selection.
void	extendSelectionRelatively(int posCount) Extends the selection to the left (or to the bottom).
void	extendSelectionTo(int pos) Extends the selection in either direction so that the specified column (or row) and all previously selected columns (or rows) are included.
SelectionDimension	getDimension() Determines of this selection represent columns or rows.
int	getFirstPos() Returns the first column (or row) that is contained in the selection.
int	getLastPos() Returns the last column (or row) that is contained in the selection.
int	getLength()
SelectionModel	getOwner()
int	getStartPos() Returns the position where the current selection process started.
boolean	isEmpty() Checks if any columns or row (depending on getDimension()) is selected.
boolean	isSelected(int pos) Checks if the specified column (or row) is included in this selection.
void	moveSelection(int count) Moves the selection by the specified number of columns (or rows).
void	selectAll() Selects all columns or rows (depending on getDimension()).
void	setFirstPos(int firstPos) Sets the first column (or row) of the selection.
void	setLastPos(int lastPos) Sets the last column (or row) of the selection.
void	setNewSelection(int pos) Deletes the current selection and selects the column (or row) at the specified position.
void	setSelectionEnd(int pos)
void	setStartPos(int startPos)

Methods inherited from class java.lang.Object

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

Field Detail

NO_SELECTION

public static final int NO_SELECTION

See Also:

Constant Field Values

Constructor Detail

OneDimensionalSelection

public OneDimensionalSelection(SelectionModel owner,
                               SelectionDimension dimension)

Method Detail

getOwner

public SelectionModel getOwner()

getDimension

public SelectionDimension getDimension()

Determines of this selection represent columns or rows.

Returns:

either SelectionDimension.COLUMN or SelectionDimension.ROW

getFirstPos

public int getFirstPos()

Returns the first column (or row) that is contained in the selection.

Returns:

the index of the first selected position or NO_SELECTION if the selection is empty

getLastPos

public int getLastPos()

Returns the last column (or row) that is contained in the selection.

Returns:

the index of the last selected position or NO_SELECTION if the selection is empty

getStartPos

public int getStartPos()

Returns the position where the current selection process started. This value is e.g. used to calculate the new selection range in a call of setSelectionEnd(int).

Returns:

the selection start position or NO_SELECTION if no selection process is ongoing

setStartPos

public void setStartPos(int startPos)

getLength

public int getLength()

setNewSelection

public void setNewSelection(int pos)

Deletes the current selection and selects the column (or row) at the specified position.

If a value below 0 (except NO_SELECTION) or greater than the length (or height) of the alignment is specified, the first or last column (or row) is selected.

Parameters:

pos - the index of the column (or row) to be selected

Throws:

java.lang.IllegalArgumentException - if NO_SELECTION is specified (Use clear() instead.)

setFirstPos

public void setFirstPos(int firstPos)

Sets the first column (or row) of the selection.

If the specified position is greater than getLastPos(), both values are swapped.

Parameters:

firstPos - the index of the new selection start

setLastPos

public void setLastPos(int lastPos)

Sets the last column (or row) of the selection.

If the specified position is lower than getFirstPos(), both values are swapped. If getFirstPos() was not set, it is set to the specified value as well.

Parameters:

firstPos - the index of the new selection start

adoptFromOther

public void adoptFromOther(OneDimensionalSelection other)

isSelected

public boolean isSelected(int pos)

Checks if the specified column (or row) is included in this selection.

Parameters:

pos - the index of the column or row to be checked

Returns:

true if the specified column or row is included, false otherwise

setSelectionEnd

public void setSelectionEnd(int pos)

moveSelection

public void moveSelection(int count)

Moves the selection by the specified number of columns (or rows). The new selection will only be one column (or row) wide, no matter how wide is was before.

This method may be useful move through the alignment with the keyboard if no cursor independent from the selection is used.

Parameters:

count - the number of columns (or rows) to move the selection (Can be positive or negative)

extendSelectionTo

public void extendSelectionTo(int pos)

Extends the selection in either direction so that the specified column (or row) and all previously selected columns (or rows) are included. If the previous selection is empty this method delegated to setNewSelection(int).

Parameters:

pos - the index of the column or row that shall additionally be included in this selection

extendSelectionRelatively

public void extendSelectionRelatively(int posCount)

Extends the selection to the left (or to the bottom).

Parameters:

posCount - the number of columns to be added to the selection.

selectAll

public void selectAll()

Selects all columns or rows (depending on getDimension()).

isEmpty

public boolean isEmpty()

Checks if any columns or row (depending on getDimension()) is selected.

Returns:

true if no column or row is selected, false otherwise.

clear

public void clear()

Clears this selection.