de.cismet.cismap.commons.features

Class FeatureCollectionAndListModel

java.lang.Object

de.cismet.cismap.commons.features.DefaultFeatureCollection

de.cismet.cismap.commons.features.FeatureCollectionAndListModel

All Implemented Interfaces:

FeatureCollection, MapListener, ServiceLayer, ListSelectionModel

public class FeatureCollectionAndListModel
extends DefaultFeatureCollection
implements ListSelectionModel

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten.hell@cismet.de

Field Summary

Fields

Modifier and Type	Field and Description
protected int	anchorIndex
protected int	leadIndex
protected Vector<ListSelectionListener>	listSelectionListeners
protected boolean	valueIsAdjusting

Fields inherited from class de.cismet.cismap.commons.features.DefaultFeatureCollection

features, holdAll, holdFeatures, listeners, selectedFeatures

Fields inherited from interface javax.swing.ListSelectionModel

MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION

Fields inherited from interface de.cismet.cismap.commons.ServiceLayer

LAYER_DISABLED_INVISIBLE, LAYER_DISABLED_VISIBLE, LAYER_ENABLED_INVISIBLE, LAYER_ENABLED_VISIBLE

Constructor Summary

Constructors

Constructor and Description
FeatureCollectionAndListModel()

Method Summary

Modifier and Type	Method and Description
void	addListSelectionListener(ListSelectionListener 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.
protected void	fireValueChanged(boolean isAdjusting) Notifies listeners that we have ended a series of adjustments.
protected void	fireValueChanged(int firstIndex, int lastIndex) Notifies ListSelectionListeners that the value of the selection, in the closed interval firstIndex, lastIndex, has changed.
protected void	fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting) DOCUMENT ME!
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() Returns the last selected index or -1 if the selection is empty.
int	getMinSelectionIndex() Returns the first selected index or -1 if the selection is empty.
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) Returns true if the specified index is selected.
boolean	isSelectionEmpty() Returns true if no indices are selected.
void	removeIndexInterval(int index0, int index1) Remove the indices in the interval index0,index1 (inclusive) from the selection model.
void	removeListSelectionListener(ListSelectionListener x) Remove a listener from the list that's notified each time a change to the selection occurs.
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.

Methods inherited from class de.cismet.cismap.commons.features.DefaultFeatureCollection

addFeature, addFeatureCollectionListener, addFeatures, addToSelection, addToSelection, addVetoableSelectionListener, areFeaturesEditable, canBeDisabled, checkForAndCorrectDoubleNaming, clear, contains, featuresAddedToMap, fireAllFeaturesRemoved, fireFeaturesAdded, fireFeaturesChanged, fireFeaturesRemoved, fireSelectionChanged, fireSelectionChanged, fireSelectionChanged, getAllFeatures, getFeature, getFeatureCount, getHoldFeatures, getLayerPosition, getName, getSelectedFeatures, getTranslucency, holdFeature, isEnabled, isHoldFeature, isSelected, isSingleSelection, reconsiderFeature, removeAllFeatures, removeFeature, removeFeatureCollectionListener, removeFeatures, removeFeaturesByInstance, removeVetoableSelectionListener, select, select, setEnabled, setFeatureAt, setHoldAll, setLayerPosition, setName, setSingleSelection, setTranslucency, substituteFeatures, unholdFeature, unselect, unselect, unselectAll, unselectAll

Methods inherited from class java.lang.Object

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

Field Detail

listSelectionListeners

protected Vector<ListSelectionListener> listSelectionListeners

leadIndex

protected int leadIndex

anchorIndex

protected int anchorIndex

valueIsAdjusting

protected boolean valueIsAdjusting

Constructor Detail

FeatureCollectionAndListModel

public FeatureCollectionAndListModel()

Method Detail

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.

Specified by:

setSelectionMode in interface ListSelectionModel

Parameters:

selectionMode - DOCUMENT ME!

Throws:

IllegalArgumentException - DOCUMENT ME!

See Also:

getSelectionMode()

setLeadSelectionIndex

public void setLeadSelectionIndex(int index)

Set the lead selection index.

Specified by:

setLeadSelectionIndex in interface ListSelectionModel

Parameters:

index - DOCUMENT ME!

See Also:

getLeadSelectionIndex()

setAnchorSelectionIndex

public void setAnchorSelectionIndex(int index)

Set the anchor selection index.

Specified by:

setAnchorSelectionIndex in interface ListSelectionModel

Parameters:

index - DOCUMENT ME!

See Also:

getAnchorSelectionIndex()

isSelectedIndex

public boolean isSelectedIndex(int index)

Returns true if the specified index is selected.

Specified by:

isSelectedIndex in interface ListSelectionModel

Parameters:

index - DOCUMENT ME!

Returns:

DOCUMENT ME!

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.

Specified by:

setValueIsAdjusting in interface ListSelectionModel

Parameters:

valueIsAdjusting - The new value of the property.

See Also:

getValueIsAdjusting()

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener x)

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

Specified by:

removeListSelectionListener in interface ListSelectionModel

Parameters:

x - the ListSelectionListener

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener)

addListSelectionListener

public void addListSelectionListener(ListSelectionListener x)

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

Specified by:

addListSelectionListener in interface ListSelectionModel

Parameters:

x - the ListSelectionListener

See Also:

removeListSelectionListener(javax.swing.event.ListSelectionListener), setSelectionInterval(int, int), addSelectionInterval(int, int), removeSelectionInterval(int, int), clearSelection(), insertIndexInterval(int, int, boolean), removeIndexInterval(int, int)

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.

Specified by:

insertIndexInterval in interface ListSelectionModel

Parameters:

index - DOCUMENT ME!

length - DOCUMENT ME!

before - DOCUMENT ME!

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.

Specified by:

setSelectionInterval in interface ListSelectionModel

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener)

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.

Specified by:

removeSelectionInterval in interface ListSelectionModel

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener)

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.

Specified by:

addSelectionInterval in interface ListSelectionModel

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener)

clearSelection

public void clearSelection()

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

Specified by:

clearSelection in interface ListSelectionModel

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener)

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.

Specified by:

getAnchorSelectionIndex in interface ListSelectionModel

Returns:

DOCUMENT ME!

See Also:

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

getLeadSelectionIndex

public int getLeadSelectionIndex()

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

Specified by:

getLeadSelectionIndex in interface ListSelectionModel

Returns:

DOCUMENT ME!

See Also:

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

getMaxSelectionIndex

public int getMaxSelectionIndex()

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

Specified by:

getMaxSelectionIndex in interface ListSelectionModel

Returns:

DOCUMENT ME!

getMinSelectionIndex

public int getMinSelectionIndex()

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

Specified by:

getMinSelectionIndex in interface ListSelectionModel

Returns:

DOCUMENT ME!

getSelectionMode

public int getSelectionMode()

Returns the current selection mode.

Specified by:

getSelectionMode in interface ListSelectionModel

Returns:

The value of the selectionMode property.

See Also:

setSelectionMode(int)

getValueIsAdjusting

public boolean getValueIsAdjusting()

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

Specified by:

getValueIsAdjusting in interface ListSelectionModel

Returns:

true if the value is currently adjusting

See Also:

setValueIsAdjusting(boolean)

isSelectionEmpty

public boolean isSelectionEmpty()

Returns true if no indices are selected.

Specified by:

isSelectionEmpty in interface ListSelectionModel

Returns:

DOCUMENT ME!

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.

Specified by:

removeIndexInterval in interface ListSelectionModel

Parameters:

index0 - DOCUMENT ME!

index1 - DOCUMENT ME!

fireValueChanged

protected void fireValueChanged(boolean isAdjusting)

Notifies listeners that we have ended a series of adjustments.

Parameters:

isAdjusting - DOCUMENT ME!

fireValueChanged

protected void fireValueChanged(int firstIndex,
                                int lastIndex)

Notifies ListSelectionListeners that the value of the selection, in the closed interval firstIndex, lastIndex, has changed.

Parameters:

firstIndex - DOCUMENT ME!

lastIndex - DOCUMENT ME!

fireValueChanged

protected void fireValueChanged(int firstIndex,
                                int lastIndex,
                                boolean isAdjusting)

DOCUMENT ME!

Parameters:

firstIndex - the first index in the interval

lastIndex - the last index in the interval

isAdjusting - true if this is the final change in a series of adjustments

See Also:

EventListenerList