de.jaret.util.ui.table.model
Interface IJaretTableSelectionModel

All Known Implementing Classes:

JaretTableSelectionModelImpl

public interface IJaretTableSelectionModel

Selection model for the jaret table. The selection models controls the slection istelf and the possible selection modes.

Version:

$Id: IJaretTableSelectionModel.java 180 2007-01-07 18:44:01Z olk $

Author:

Peter Kliem

Method Summary

void	addSelectedCell(IJaretTableCell cell) Add a cell to the selection.
void	addSelectedColumn(IColumn column) Add a column to the selection.
void	addSelectedRow(IRow row) Add a row to the selection.
void	addTableSelectionModelListener(IJaretTableSelectionModelListener jtsm) Add a listener to listen to changes of the selection.
void	clearSelection() Clear the selection.
IJaretTableSelection	getSelection() retrieve the selected elements in the tabel selection structure.
boolean	isCellSelectionAllowed()
boolean	isFullColumnSelectionAllowed() Check whether full column selection is allowed.
boolean	isFullRowSelectionAllowed() Check whether full row selection is allowed.
boolean	isMultipleSelectionAllowed() Retrieve allowance for multiple elements selectable.
boolean	isOnlyRowSelectionAllowed() Check whether only row selection is allowed.
void	removeTableSelectionModelListener(IJaretTableSelectionModelListener jtsm) Remove a listener.
void	remSelectedCell(IJaretTableCell cell) Remove a cell from the selection.
void	remSelectedColumn(IColumn column) Remove a column from the selection.
void	remSelectedRow(IRow row) Remove a row from the selection.
void	setCellSelectionAllowed(boolean allowed) Set allowance for single cell selections.
void	setFullColumnSelectionAllowed(boolean allowed) Set the allowance for full column selection.
void	setFullRowSelectionAllowed(boolean allowed) Set the allowance for full row selection.
void	setMultipleSelectionAllowed(boolean allowed) Set the allowance for multiple selection.
void	setOnlyRowSelectionAllowed(boolean allowed) If set to true only row selection is allowed.

Method Detail

clearSelection

void clearSelection()

Clear the selection.

isFullRowSelectionAllowed

boolean isFullRowSelectionAllowed()

Check whether full row selection is allowed.

Returns:

true if full row selection is allowed.

setFullRowSelectionAllowed

void setFullRowSelectionAllowed(boolean allowed)

Set the allowance for full row selection.

Parameters:

allowed - true for allowed

isFullColumnSelectionAllowed

boolean isFullColumnSelectionAllowed()

Check whether full column selection is allowed.

Returns:

true if full column selection is allowed.

setFullColumnSelectionAllowed

void setFullColumnSelectionAllowed(boolean allowed)

Set the allowance for full column selection.

Parameters:

allowed - true for allowed

isCellSelectionAllowed

boolean isCellSelectionAllowed()

Returns:

true if selection of single cells is allowed

setCellSelectionAllowed

void setCellSelectionAllowed(boolean allowed)

Set allowance for single cell selections.

Parameters:

allowed - true for allowed

isMultipleSelectionAllowed

boolean isMultipleSelectionAllowed()

Retrieve allowance for multiple elements selectable.

Returns:

true if multiple elemets should be selectable

setMultipleSelectionAllowed

void setMultipleSelectionAllowed(boolean allowed)

Set the allowance for multiple selection.

Parameters:

allowed - true for allowed

isOnlyRowSelectionAllowed

boolean isOnlyRowSelectionAllowed()

Check whether only row selection is allowed.

Returns:

true if only rows should be selectable

setOnlyRowSelectionAllowed

void setOnlyRowSelectionAllowed(boolean allowed)

If set to true only row selection is allowed.

Parameters:

allowed - true for only row selection

addSelectedRow

void addSelectedRow(IRow row)

Add a row to the selection.

Parameters:

row - element to be added to the selection

remSelectedRow

void remSelectedRow(IRow row)

Remove a row from the selection.

Parameters:

row - element to be removed from the selection

addSelectedColumn

void addSelectedColumn(IColumn column)

Add a column to the selection.

Parameters:

column - element to be added to the selection

remSelectedColumn

void remSelectedColumn(IColumn column)

Remove a column from the selection.

Parameters:

column - element to be removed from the selection

addSelectedCell

void addSelectedCell(IJaretTableCell cell)

Add a cell to the selection.

Parameters:

cell - element to be added to the selection

remSelectedCell

void remSelectedCell(IJaretTableCell cell)

Remove a cell from the selection.

Parameters:

cell - element to be removed from the selection

getSelection

IJaretTableSelection getSelection()

retrieve the selected elements in the tabel selection structure.

Returns:

selected elements

addTableSelectionModelListener

void addTableSelectionModelListener(IJaretTableSelectionModelListener jtsm)

Add a listener to listen to changes of the selection.

Parameters:

jtsm - listener

removeTableSelectionModelListener

void removeTableSelectionModelListener(IJaretTableSelectionModelListener jtsm)

Remove a listener.

Parameters:

jtsm - listener to be removed