org.cb.cardboard
Interface BoardSelectionModel

All Superinterfaces:

java.util.EventListener

All Known Implementing Classes:

DefaultBoardSelectionModel

public interface BoardSelectionModel

extends java.util.EventListener

The listener that's notified when a board selection value changes.

Version:

$Id: BoardSelectionModel.java 78 2004-04-13 04:25:57Z jerome $

Author:

jerome@coffeebreaks.org - last modified by $LastModifiedBy$

See Also:

BoardSelectionModel

Field Summary

static int	MULTIPLE_INTERVAL_SELECTION A value for the selectionMode property: select one or more contiguous ranges of indices at a time.
static int	SINGLE_INTERVAL_SELECTION A value for the selectionMode property: select one contiguous range of indices at a time.
static int	SINGLE_SELECTION A value for the selectionMode property: select one list index at a time.

Method Summary

void	addBoardSelectionListener(BoardSelectionListener x) Add a listener to the list that's notified each time a change to the selection occurs.
void	addSelectionInterval(int index0, int index1) Change the selection to be the set union of the current selection and the indices between index0 and index1 inclusive.
void	clearSelection() Change the selection to the empty set.
int	getAnchorSelectionIndex() Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
int	getLeadSelectionIndex() Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
int	getMaxSelectionIndex()
int	getMinSelectionIndex()
int	getSelectionMode() Returns the current selection mode.
boolean	getValueIsAdjusting() Returns true if the value is undergoing a series of changes.
void	insertIndexInterval(int index, int length, boolean before) Insert length indices beginning before/after index.
boolean	isSelectedIndex(int index)
boolean	isSelectionEmpty()
void	removeBoardSelectionListener(BoardSelectionListener x) Remove a listener from the list that's notified each time a change to the selection occurs.
void	removeIndexInterval(int index0, int index1) Remove the indices in the interval index0,index1 (inclusive) from the selection model.
void	removeSelectionInterval(int index0, int index1) Change the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive.
void	setAnchorSelectionIndex(int index) Set the anchor selection index.
void	setLeadSelectionIndex(int index) Set the lead selection index.
void	setSelectionInterval(int index0, int index1) Change the selection to be between index0 and index1 inclusive.
void	setSelectionMode(int selectionMode) Set the selection mode.
void	setValueIsAdjusting(boolean valueIsAdjusting) This property is true if upcoming changes to the value of the model should be considered a single event.

Field Detail

SINGLE_SELECTION

public static final int SINGLE_SELECTION

A value for the selectionMode property: select one list index at a time.

See Also:

setSelectionMode(int), Constant Field Values

SINGLE_INTERVAL_SELECTION

public static final int SINGLE_INTERVAL_SELECTION

A value for the selectionMode property: select one contiguous range of indices at a time.

See Also:

setSelectionMode(int), Constant Field Values

MULTIPLE_INTERVAL_SELECTION

public static final int MULTIPLE_INTERVAL_SELECTION

A value for the selectionMode property: select one or more contiguous ranges of indices at a time.

See Also:

setSelectionMode(int), Constant Field Values

Method Detail

setSelectionInterval

public void setSelectionInterval(int index0,
                                 int index1)

Change the selection to be between index0 and index1 inclusive. If this represents a change to the current selection, then notify each ListSelectionListener. Note that index0 doesn't have to be less than or equal to index1.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

See Also:

addBoardSelectionListener(org.cb.cardboard.BoardSelectionListener)

addSelectionInterval

public void addSelectionInterval(int index0,
                                 int index1)

Change the selection to be the set union of the current selection and the indices between index0 and index1 inclusive. If this represents a change to the current selection, then notify each ListSelectionListener. Note that index0 doesn't have to be less than or equal to index1.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

See Also:

addBoardSelectionListener(org.cb.cardboard.BoardSelectionListener)

removeSelectionInterval

public void removeSelectionInterval(int index0,
                                    int index1)

Change the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive. If this represents a change to the current selection, then notify each ListSelectionListener. Note that index0 doesn't have to be less than or equal to index1.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

See Also:

addBoardSelectionListener(org.cb.cardboard.BoardSelectionListener)

getMinSelectionIndex

public int getMinSelectionIndex()

Returns:

the first selected index or -1 if the selection is empty.

getMaxSelectionIndex

public int getMaxSelectionIndex()

Returns:

the last selected index or -1 if the selection is empty.

isSelectedIndex

public boolean isSelectedIndex(int index)

Returns:

true if the specified index is selected.

getAnchorSelectionIndex

public int getAnchorSelectionIndex()

Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval(). The most recent index0 is considered the "anchor" and the most recent index1 is considered the "lead". Some interfaces display these indices specially, e.g. Windows95 displays the lead index with a dotted yellow outline.

Returns:

the anchor selection index

See Also:

getLeadSelectionIndex(), setSelectionInterval(int, int), addSelectionInterval(int, int)

setAnchorSelectionIndex

public void setAnchorSelectionIndex(int index)

Set the anchor selection index.

See Also:

getAnchorSelectionIndex()

getLeadSelectionIndex

public int getLeadSelectionIndex()

Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().

See Also:

getAnchorSelectionIndex(), setSelectionInterval(int, int), addSelectionInterval(int, int)

setLeadSelectionIndex

public void setLeadSelectionIndex(int index)

Set the lead selection index.

See Also:

getLeadSelectionIndex()

clearSelection

public void clearSelection()

Change the selection to the empty set. If this represents a change to the current selection then notify each ListSelectionListener.

See Also:

addBoardSelectionListener(org.cb.cardboard.BoardSelectionListener)

isSelectionEmpty

public boolean isSelectionEmpty()

Returns:

true if no indices are selected.

insertIndexInterval

public void insertIndexInterval(int index,
                                int length,
                                boolean before)

Insert length indices beginning before/after index. This is typically called to sync the selection model with a corresponding change in the data model.

removeIndexInterval

public void removeIndexInterval(int index0,
                                int index1)

Remove the indices in the interval index0,index1 (inclusive) from the selection model. This is typically called to sync the selection model width a corresponding change in the data model.

setValueIsAdjusting

public void setValueIsAdjusting(boolean valueIsAdjusting)

This property is true if upcoming changes to the value of the model should be considered a single event. For example if the model is being updated in response to a user drag, the value of the valueIsAdjusting property will be set to true when the drag is initiated and be set to false when the drag is finished. This property allows listeners to to update only when a change has been finalized, rather than always handling all of the intermediate values.

Parameters:

valueIsAdjusting - The new value of the property.

See Also:

getValueIsAdjusting()

getValueIsAdjusting

public boolean getValueIsAdjusting()

Returns true if the value is undergoing a series of changes.

Returns:

true if the value is currently adjusting

See Also:

setValueIsAdjusting(boolean)

setSelectionMode

public void setSelectionMode(int selectionMode)

Set the selection mode. The following selectionMode values are allowed:

• SINGLE_SELECTION Only one list index can be selected at a time. In this mode the setSelectionInterval and addSelectionInterval methods are equivalent, and only the second index argument (the "lead index") is used.
• SINGLE_INTERVAL_SELECTION One contiguous index interval can be selected at a time. In this mode setSelectionInterval and addSelectionInterval are equivalent.
• MULTIPLE_INTERVAL_SELECTION In this mode, there's no restriction on what can be selected.

See Also:

getSelectionMode()

getSelectionMode

public int getSelectionMode()

Returns the current selection mode.

Returns:

The value of the selectionMode property.

See Also:

setSelectionMode(int)

addBoardSelectionListener

public void addBoardSelectionListener(BoardSelectionListener x)

Add a listener to the list that's notified each time a change to the selection occurs.

Parameters:

x - the ListSelectionListener

See Also:

removeBoardSelectionListener(org.cb.cardboard.BoardSelectionListener), setSelectionInterval(int, int), addSelectionInterval(int, int), removeSelectionInterval(int, int), clearSelection(), insertIndexInterval(int, int, boolean), removeIndexInterval(int, int)

removeBoardSelectionListener

public void removeBoardSelectionListener(BoardSelectionListener x)

Remove a listener from the list that's notified each time a change to the selection occurs.

Parameters:

x - the ListSelectionListener

See Also:

addBoardSelectionListener(org.cb.cardboard.BoardSelectionListener)