SelectionModel

java.lang.Object
- info.bioinfweb.libralign.alignmentarea.selection.SelectionModel

```
public class SelectionModel
extends java.lang.Object
```
The selection model of AlignmentArea. Stores the cursor position and height as well as the selected area.

Since:

0.0.0

Author:

Ben Stöver

See Also:

AlignmentArea

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addSelectionListener(SelectionListener<info.bioinfweb.commons.events.GenericEventObject<SelectionModel>> listener)` Adds a lister to this object that will be informed about future changes of the selection.
`void`	`adoptFromOther(SelectionModel otherModel)` Adopts the selection from another instance.
`void`	`clear()` Clears the current selection.
`protected void`	`fireSelectionChanged()` Informs all listeners that the selection changed.
`int`	`getCursorColumn()` Returns the current column position of the alignment cursor.
`int`	`getCursorHeight()` Returns the current height of the alignment cursor (which is equal to the height of a possible selection).
`int`	`getCursorRow()` Returns the topmost row included in the current alignment cursor.
`int`	`getFirstColumn()` Returns the index of the first column that is contained in the selection.
`int`	`getFirstRow()` Returns the index of the the first row that is contained in the selection.
`int`	`getLastColumn()` Returns the index of the the last column that is contained in the selection.
`int`	`getLastRow()` Returns the index of the the last row that is contained in the selection.
`AlignmentArea`	`getOwner()` Returns the alignment content area that uses this selection object.
`int`	`getStartColumn()` Returns the column where the current selection was started.
`int`	`getStartRow()` Returns the row where the current selection was started.
`SelectionType`	`getType()` Returns the currently used selection pattern.
`int`	`getWidth()` Returns the number of columns that are currently part of the selection.
`boolean`	`isEmpty()` Checks if any columns or rows are currently selected.
`boolean`	`isSelected(int column, int row)` Checks if the specified cell is contained in this selection.
`boolean`	`removeSelectionListener(SelectionListener<info.bioinfweb.commons.events.GenericEventObject<SelectionModel>> listener)` Removes the specified listener from this objects list.
`void`	`selectAll()` Selects all cells in the alignment.
`void`	`setNewCursorColumn(int column)` Moves the cursor to a new column, leaving its row and height unchanged.
`void`	`setNewCursorPosition(int column, int row)` Specifies a new location of the cursor.
`void`	`setNewCursorPosition(int column, int row, int height)` Specifies a new location and height for the cursor.
`void`	`setNewCursorRow(int row)` Specifies a new row position of the cursor.
`void`	`setSelectionEnd(int column, int row)` Extends the current selection to include the specified cell and positions the cursor there.
`void`	`setType(SelectionType type)` Switches the selection type.

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

- Constructor Detail
  - SelectionModel
```
public SelectionModel(AlignmentArea owner)
```
    Creates a new instance of this class.
    
    Parameters:
    
    owner - the alignment content area that will be using this selection object
- Method Detail
  - getOwner
```
public AlignmentArea getOwner()
```
    Returns the alignment content area that uses this selection object.
  - getType
```
public SelectionType getType()
```
    Returns the currently used selection pattern.
  - setType
```
public void setType(SelectionType type)
```
    Switches the selection type.
    If a change from SelectionType.CELLS to SelectionType.COLUMN_ONLY is done, all rows become automatically selected, if the column selection is not empty. If a change from SelectionType.CELLS to SelectionType.ROW_ONLY is done, all columns become automatically selected, if the row selection is not empty.
    
    Parameters:
    
    type - the new selection type
  - getCursorColumn
```
public int getCursorColumn()
```
    Returns the current column position of the alignment cursor.
    
    Returns:
    
    the index of the column where the cursor is currently located
  - getCursorRow
```
public int getCursorRow()
```
    Returns the topmost row included in the current alignment cursor.
    
    Returns:
    
    the index of topmost row where the cursor is currently located
  - getCursorHeight
```
public int getCursorHeight()
```
    Returns the current height of the alignment cursor (which is equal to the height of a possible selection).
    
    Returns:
    
    a value greater 0
    
    See Also:
    
    getWidth()
  - getStartColumn
```
public int getStartColumn()
```
    Returns the column where the current selection was started.
    
    Returns:
    
    the column which was first added to the current selection
  - getStartRow
```
public int getStartRow()
```
    Returns the row where the current selection was started.
    
    Returns:
    
    the row which was first added to the current selection
  - setNewCursorColumn
```
public void setNewCursorColumn(int column)
```
    Moves the cursor to a new column, leaving its row and height unchanged.
    The selection will always be empty after calling this method.
    
    Parameters:
    
    column - the new column where the cursor shall be located
  - setNewCursorRow
```
public void setNewCursorRow(int row)
```
    Specifies a new row position of the cursor. Column and height remain unchanged.
    The selection will always be empty after calling this method.
    
    Parameters:
    
    row - the new top most row of the cursor
  - setNewCursorPosition
```
public void setNewCursorPosition(int column,
                                 int row)
```
    Specifies a new location of the cursor. The height will remain unchanged if there is enough space in the alignment.
    The selection will always be empty after calling this method.
    
    Parameters:
    
    column - the column where the cursor shall be located
    
    row - the new top most row of the cursor
  - adoptFromOther
```
public void adoptFromOther(SelectionModel otherModel)
```
    Adopts the selection from another instance.
    
    Parameters:
    
    otherModel - another selection model instance
  - setNewCursorPosition
```
public void setNewCursorPosition(int column,
                                 int row,
                                 int height)
```
    Specifies a new location and height for the cursor. The selection will always be empty after calling this method.
    
    Parameters:
    
    column - the column where the cursor shall be located
    
    row - the new top most row of the cursor
    
    height - the new height of the cursor (must be >= 1)
  - setSelectionEnd
```
public void setSelectionEnd(int column,
                            int row)
```
    Extends the current selection to include the specified cell and positions the cursor there.
    The end of the selection does not necessarily have to be on the bottom right side of the selected rectangle, but can be at any side.
    
    Parameters:
    
    column - the new cursor position
    
    row - the new cursor position
  - selectAll
```
public void selectAll()
```
    Selects all cells in the alignment.
  - isSelected
```
public boolean isSelected(int column,
                          int row)
```
    Checks if the specified cell is contained in this selection.
    If the selection type is SelectionType.COLUMN_ONLY (or SelectionType.ROW_ONLY) and the selection is not empty all row (or columns) are considered as selected.
    
    Parameters:
    
    column - the column index of the cell to be checked
    
    row - the row index of the cell to be checked
    
    Returns:
    
    true if the specified cell is contained in the selection, false otherwise
  - getFirstColumn
```
public int getFirstColumn()
```
    Returns the index of the first column that is contained in the selection.
    
    Returns:
    
    the index of the first selected column or the cursor position if the selection is empty
  - getLastColumn
```
public int getLastColumn()
```
    Returns the index of the the last column that is contained in the selection.
    
    Returns:
    
    the index of the last selected column or the cursor position if the selection is empty
  - getFirstRow
```
public int getFirstRow()
```
    Returns the index of the the first row that is contained in the selection.
    
    Returns:
    
    the index of the first selected row or the topmost cursor row if the selection is empty
  - getLastRow
```
public int getLastRow()
```
    Returns the index of the the last row that is contained in the selection.
    
    Returns:
    
    the index of the last selected row or the bottommost cursor row if the selection is empty
  - getWidth
```
public int getWidth()
```
    Returns the number of columns that are currently part of the selection.
    
    Returns:
    
    a value greater than 0 or 0 if the selection is empty
    
    See Also:
    
    getCursorHeight()
  - clear
```
public void clear()
```
    Clears the current selection. (The cursor height will not be influenced by this operation.)
  - isEmpty
```
public boolean isEmpty()
```
    Checks if any columns or rows are currently selected.
    
    Returns:
    
    true if no cells are currently contained in the selection, false otherwise
  - addSelectionListener
```
public boolean addSelectionListener(SelectionListener<info.bioinfweb.commons.events.GenericEventObject<SelectionModel>> listener)
```
    Adds a lister to this object that will be informed about future changes of the selection.
    
    Parameters:
    
    listener - the listener object to be notified in the future
    
    Returns:
    
    true (as specified by Collection.add(Object))
  - removeSelectionListener
```
public boolean removeSelectionListener(SelectionListener<info.bioinfweb.commons.events.GenericEventObject<SelectionModel>> listener)
```
    Removes the specified listener from this objects list.
    
    Parameters:
    
    listener - the listener to be removed
    
    Returns:
    
    true if this list contained the specified element
  - fireSelectionChanged
```
protected void fireSelectionChanged()
```
    Informs all listeners that the selection changed.

Class SelectionModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SelectionModel

Method Detail

getOwner

getType

setType

getCursorColumn

getCursorRow

getCursorHeight

getStartColumn

getStartRow

setNewCursorColumn

setNewCursorRow

setNewCursorPosition

adoptFromOther

setNewCursorPosition

setSelectionEnd

selectAll

isSelected

getFirstColumn

getLastColumn

getFirstRow

getLastRow

getWidth

clear

isEmpty

addSelectionListener

removeSelectionListener

fireSelectionChanged