APIdia Launch Partner
Top Description Fields Constructors Methods
javax.swing.text.html

pack-priv Class OptionListModel<E>

extends DefaultListModel<E>
implements ListSelectionModel, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, javax.swing.ListSelectionModel
Annotations
@SuppressWarnings:serial
Imports
javax.swing.*, javax.swing.event.*, java.util.BitSet, java.io.Serializable

This class extends DefaultListModel, and also implements the ListSelectionModel interface, allowing for it to store state relevant to a SELECT form element which is implemented as a List. If SELECT has a size attribute whose value is greater than 1, or if allows multiple selection then a JList is used to represent it and the OptionListModel is used as its model. It also stores the initial state of the JList, to ensure an accurate reset, if the user requests a reset of the form.
Author
Sunita Mani

Field Summary

Modifier and TypeField and Description
private int
private int
private BitSet
private boolean
private int
protected boolean
private int
protected EventListenerList
private static final int
private int
private static final int
private int
private int
private BitSet

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
addListSelectionListener(ListSelectionListener l)

Implements javax.swing.ListSelectionModel.addListSelectionListener.

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

public void
addSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.addSelectionInterval.

Changes the selection to be the set union of the current selection and the indices between index0 and index1 inclusive.

private void
changeSelection(int clearMin, int clearMax, int setMin, int setMax, boolean clearFirst)

private void
changeSelection(int clearMin, int clearMax, int setMin, int setMax)

private void
clear(int r)

public void
clearSelection()

Implements javax.swing.ListSelectionModel.clearSelection.

Change the selection to the empty set.

public Object

Returns:

a clone of the receiver
clone
()

Overrides java.lang.Object.clone.

Returns a clone of the receiver with the same selection.

private boolean
contains(int a, int b, int i)

protected void
fireValueChanged(boolean isAdjusting)

Notify listeners that we are beginning or ending a series of value changes

protected void
fireValueChanged(int firstIndex, int lastIndex)

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

protected void
fireValueChanged(int
The first index in the interval.
firstIndex
,
int
The last index in the interval.
lastIndex
,
boolean
True if this is the final change in a series of them.
isAdjusting
)

private void
public int
getAnchorSelectionIndex()

Implements javax.swing.ListSelectionModel.getAnchorSelectionIndex.

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

public BitSet
getInitialSelection()

Fetches the BitSet that represents the initial set of selected items in the list.

public int
getLeadSelectionIndex()

Implements javax.swing.ListSelectionModel.getLeadSelectionIndex.

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

public ListSelectionListener[]

Returns:

all of the ListSelectionListeners added or an empty array if no listeners have been added
getListSelectionListeners
()

Returns an array of all the ListSelectionListeners added to this OptionListModel with addListSelectionListener().

public int
getMaxSelectionIndex()

Implements javax.swing.ListSelectionModel.getMaxSelectionIndex.

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

public int
getMinSelectionIndex()

Implements javax.swing.ListSelectionModel.getMinSelectionIndex.

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

public int
getSelectionMode()

Implements javax.swing.ListSelectionModel.getSelectionMode.

Returns the current selection mode.

public boolean
getValueIsAdjusting()

Implements javax.swing.ListSelectionModel.getValueIsAdjusting.

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

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

Implements javax.swing.ListSelectionModel.insertIndexInterval.

Insert length indices beginning before/after index.

public boolean

Returns:

the value of the leadAnchorNotificationEnabled flag
isLeadAnchorNotificationEnabled
()

Returns the value of the leadAnchorNotificationEnabled flag.

public boolean
isSelectedIndex(int index)

Implements javax.swing.ListSelectionModel.isSelectedIndex.

Returns true if the specified index is selected.

public boolean
isSelectionEmpty()

Implements javax.swing.ListSelectionModel.isSelectionEmpty.

Returns true if no indices are selected.

private void
markAsDirty(int r)

public void
removeIndexInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.removeIndexInterval.

Remove the indices in the interval index0,index1 (inclusive) from the selection model.

public void
removeListSelectionListener(ListSelectionListener l)

Implements javax.swing.ListSelectionModel.removeListSelectionListener.

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

public void
removeSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.removeSelectionInterval.

Changes the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive.

private void
set(int r)

public void
setAnchorSelectionIndex(int anchorIndex)

Implements javax.swing.ListSelectionModel.setAnchorSelectionIndex.

Set the anchor selection index, leaving all selection values unchanged.

public void
setInitialSelection(int i)

This method is responsible for storing the state of the initial selection.

public void
setLeadAnchorNotificationEnabled(boolean flag)

Sets the value of the leadAnchorNotificationEnabled flag.

public void
setLeadSelectionIndex(int leadIndex)

Implements javax.swing.ListSelectionModel.setLeadSelectionIndex.

Set the lead selection index, ensuring that values between the anchor and the new lead are either all selected or all deselected.

public void
setSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.setSelectionInterval.

Changes the selection to be between index0 and index1 inclusive.

public void
setSelectionMode(int selectionMode)

Implements javax.swing.ListSelectionModel.setSelectionMode.

Sets the selection mode.

private void
setState(int index, boolean state)

public void
setValueIsAdjusting(boolean isAdjusting)

Implements javax.swing.ListSelectionModel.setValueIsAdjusting.

Sets the valueIsAdjusting property, which indicates whether or not upcoming selection changes should be considered part of a single change.

public String
toString()

Overrides javax.swing.DefaultListModel.toString.

Returns a string that displays and identifies this object's properties.

private void
updateLeadAnchorIndices(int anchorIndex, int leadIndex)

Inherited from javax.swing.DefaultListModel:
addaddAlladdAlladdElementcapacityclearcontainscopyIntoelementAtelementsensureCapacityfirstElementgetgetElementAtgetSizeindexOfindexOfinsertElementAtisEmptylastElementlastIndexOflastIndexOfremoveremoveAllElementsremoveElementremoveElementAtremoveRangesetsetElementAtsetSizesizetoArraytrimToSize

Field Detail

anchorIndexback to summary
private int anchorIndex
firstChangedIndexback to summary
private int firstChangedIndex
initialValueback to summary
private BitSet initialValue
isAdjustingback to summary
private boolean isAdjusting
lastChangedIndexback to summary
private int lastChangedIndex
leadAnchorNotificationEnabledback to summary
protected boolean leadAnchorNotificationEnabled
leadIndexback to summary
private int leadIndex
listenerListback to summary
protected EventListenerList listenerList

Hides javax.swing.AbstractListModel.listenerList.

MAXback to summary
private static final int MAX
maxIndexback to summary
private int maxIndex
MINback to summary
private static final int MIN
minIndexback to summary
private int minIndex
selectionModeback to summary
private int selectionMode
valueback to summary
private BitSet value

Constructor Detail

OptionListModelback to summary
pack-priv OptionListModel()

Method Detail

addListSelectionListenerback to summary
public void addListSelectionListener(ListSelectionListener l)

Implements javax.swing.ListSelectionModel.addListSelectionListener.

Doc from javax.swing.ListSelectionModel.addListSelectionListener.

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

addSelectionIntervalback to summary
public void addSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.addSelectionInterval.

Doc from javax.swing.ListSelectionModel.addSelectionInterval.

Changes the selection to be the set union of the current selection and the indices between index0 and index1 inclusive. index0 doesn't have to be less than or equal to index1.

In SINGLE_SELECTION selection mode, this is equivalent to calling setSelectionInterval, and only the second index is used. In SINGLE_INTERVAL_SELECTION selection mode, this method behaves like setSelectionInterval, unless the given interval is immediately adjacent to or overlaps the existing selection, and can therefore be used to grow the selection.

If this represents a change to the current selection, then each ListSelectionListener is notified of the change.

changeSelectionback to summary
private void changeSelection(int clearMin, int clearMax, int setMin, int setMax, boolean clearFirst)
changeSelectionback to summary
private void changeSelection(int clearMin, int clearMax, int setMin, int setMax)
clearback to summary
private void clear(int r)
clearSelectionback to summary
public void clearSelection()

Implements javax.swing.ListSelectionModel.clearSelection.

Doc from javax.swing.ListSelectionModel.clearSelection.

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

cloneback to summary
public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Returns a clone of the receiver with the same selection. listenerLists are not duplicated.

Returns:Object

a clone of the receiver

Exceptions
CloneNotSupportedException:
if the receiver does not both (a) implement the Cloneable interface and (b) define a clone method
containsback to summary
private boolean contains(int a, int b, int i)
fireValueChangedback to summary
protected void fireValueChanged(boolean isAdjusting)

Notify listeners that we are beginning or ending a series of value changes

fireValueChangedback to summary
protected void fireValueChanged(int firstIndex, int lastIndex)

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

fireValueChangedback to summary
protected void fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)
Parameters
firstIndex:int

The first index in the interval.

lastIndex:int

The last index in the interval.

isAdjusting:boolean

True if this is the final change in a series of them.

See Also
EventListenerList
fireValueChangedback to summary
private void fireValueChanged()
getAnchorSelectionIndexback to summary
public int getAnchorSelectionIndex()

Implements javax.swing.ListSelectionModel.getAnchorSelectionIndex.

Doc from javax.swing.ListSelectionModel.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.

getInitialSelectionback to summary
public BitSet getInitialSelection()

Fetches the BitSet that represents the initial set of selected items in the list.

getLeadSelectionIndexback to summary
public int getLeadSelectionIndex()

Implements javax.swing.ListSelectionModel.getLeadSelectionIndex.

Doc from javax.swing.ListSelectionModel.getLeadSelectionIndex.

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

getListSelectionListenersback to summary
public ListSelectionListener[] getListSelectionListeners()

Returns an array of all the ListSelectionListeners added to this OptionListModel with addListSelectionListener().

Returns:ListSelectionListener[]

all of the ListSelectionListeners added or an empty array if no listeners have been added

Since
1.4
getMaxSelectionIndexback to summary
public int getMaxSelectionIndex()

Implements javax.swing.ListSelectionModel.getMaxSelectionIndex.

Doc from javax.swing.ListSelectionModel.getMaxSelectionIndex.

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

getMinSelectionIndexback to summary
public int getMinSelectionIndex()

Implements javax.swing.ListSelectionModel.getMinSelectionIndex.

Doc from javax.swing.ListSelectionModel.getMinSelectionIndex.

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

getSelectionModeback to summary
public int getSelectionMode()

Implements javax.swing.ListSelectionModel.getSelectionMode.

Doc from javax.swing.ListSelectionModel.getSelectionMode.

Returns the current selection mode.

getValueIsAdjustingback to summary
public boolean getValueIsAdjusting()

Implements javax.swing.ListSelectionModel.getValueIsAdjusting.

Doc from javax.swing.ListSelectionModel.getValueIsAdjusting.

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

insertIndexIntervalback to summary
public void insertIndexInterval(int index, int length, boolean before)

Implements javax.swing.ListSelectionModel.insertIndexInterval.

Insert length indices beginning before/after index. If the value at index is itself selected, set all of the newly inserted items, otherwise leave them unselected. This method is typically called to sync the selection model with a corresponding change in the data model.

isLeadAnchorNotificationEnabledback to summary
public boolean isLeadAnchorNotificationEnabled()

Returns the value of the leadAnchorNotificationEnabled flag. When leadAnchorNotificationEnabled is true the model generates notification events with bounds that cover all the changes to the selection plus the changes to the lead and anchor indices. Setting the flag to false causes a norrowing of the event's bounds to include only the elements that have been selected or deselected since the last change. Either way, the model continues to maintain the lead and anchor variables internally. The default is true.

Returns:boolean

the value of the leadAnchorNotificationEnabled flag

See Also
setLeadAnchorNotificationEnabled(boolean)
isSelectedIndexback to summary
public boolean isSelectedIndex(int index)

Implements javax.swing.ListSelectionModel.isSelectedIndex.

Doc from javax.swing.ListSelectionModel.isSelectedIndex.

Returns true if the specified index is selected.

isSelectionEmptyback to summary
public boolean isSelectionEmpty()

Implements javax.swing.ListSelectionModel.isSelectionEmpty.

Doc from javax.swing.ListSelectionModel.isSelectionEmpty.

Returns true if no indices are selected.

markAsDirtyback to summary
private void markAsDirty(int r)
removeIndexIntervalback to summary
public void removeIndexInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.removeIndexInterval.

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. Note that (as always) index0 can be greater than index1.

removeListSelectionListenerback to summary
public void removeListSelectionListener(ListSelectionListener l)

Implements javax.swing.ListSelectionModel.removeListSelectionListener.

Doc from javax.swing.ListSelectionModel.removeListSelectionListener.

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

removeSelectionIntervalback to summary
public void removeSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.removeSelectionInterval.

Doc from javax.swing.ListSelectionModel.removeSelectionInterval.

Changes the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive. index0 doesn't have to be less than or equal to index1.

In SINGLE_INTERVAL_SELECTION selection mode, if the removal would produce two disjoint selections, the removal is extended through the greater end of the selection. For example, if the selection is 0-10 and you supply indices 5,6 (in any order) the resulting selection is 0-4.

If this represents a change to the current selection, then each ListSelectionListener is notified of the change.

setback to summary
private void set(int r)
setAnchorSelectionIndexback to summary
public void setAnchorSelectionIndex(int anchorIndex)

Implements javax.swing.ListSelectionModel.setAnchorSelectionIndex.

Set the anchor selection index, leaving all selection values unchanged.

See Also
getAnchorSelectionIndex, setLeadSelectionIndex
setInitialSelectionback to summary
public void setInitialSelection(int i)

This method is responsible for storing the state of the initial selection. If the selectionMode is the default, i.e allowing only for SINGLE_SELECTION, then the very last OPTION that has the selected attribute set wins.

setLeadAnchorNotificationEnabledback to summary
public void setLeadAnchorNotificationEnabled(boolean flag)

Sets the value of the leadAnchorNotificationEnabled flag.

See Also
isLeadAnchorNotificationEnabled()
setLeadSelectionIndexback to summary
public void setLeadSelectionIndex(int leadIndex)

Implements javax.swing.ListSelectionModel.setLeadSelectionIndex.

Set the lead selection index, ensuring that values between the anchor and the new lead are either all selected or all deselected. If the value at the anchor index is selected, first clear all the values in the range [anchor, oldLeadIndex], then select all the values in the range [anchor, newLeadIndex], where oldLeadIndex is the old leadIndex and newLeadIndex is the new one.

If the value at the anchor index is not selected, do the same thing in reverse, selecting values in the old range and deselecting values in the new one.

Generate a single event for this change and notify all listeners. For the purposes of generating minimal bounds in this event, do the operation in a single pass; that way the first and last index inside the ListSelectionEvent that is broadcast will refer to cells that actually changed value because of this method. If, instead, this operation were done in two steps the effect on the selection state would be the same but two events would be generated and the bounds around the changed values would be wider, including cells that had been first cleared and only to later be set.

This method can be used in the mouseDragged() method of a UI class to extend a selection.

See Also
getLeadSelectionIndex, setAnchorSelectionIndex
setSelectionIntervalback to summary
public void setSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.setSelectionInterval.

Doc from javax.swing.ListSelectionModel.setSelectionInterval.

Changes the selection to be between index0 and index1 inclusive. index0 doesn't have to be less than or equal to index1.

In SINGLE_SELECTION selection mode, only the second index is used.

If this represents a change to the current selection, then each ListSelectionListener is notified of the change.

setSelectionModeback to summary
public void setSelectionMode(int selectionMode)

Implements javax.swing.ListSelectionModel.setSelectionMode.

Doc from javax.swing.ListSelectionModel.setSelectionMode.

Sets the selection mode. The following list describes the accepted selection modes:

  • ListSelectionModel.SINGLE_SELECTION - Only one list index can be selected at a time. In this mode, setSelectionInterval and addSelectionInterval are equivalent, both replacing the current selection with the index represented by the second argument (the "lead").
  • ListSelectionModel.SINGLE_INTERVAL_SELECTION - Only one contiguous interval can be selected at a time. In this mode, addSelectionInterval behaves like setSelectionInterval (replacing the current selection), unless the given interval is immediately adjacent to or overlaps the existing selection, and can therefore be used to grow it.
  • ListSelectionModel.MULTIPLE_INTERVAL_SELECTION - In this mode, there's no restriction on what can be selected.
setStateback to summary
private void setState(int index, boolean state)
setValueIsAdjustingback to summary
public void setValueIsAdjusting(boolean isAdjusting)

Implements javax.swing.ListSelectionModel.setValueIsAdjusting.

Doc from javax.swing.ListSelectionModel.setValueIsAdjusting.

Sets the valueIsAdjusting property, which indicates whether or not upcoming selection changes should be considered part of a single change. The value of this property is used to initialize the valueIsAdjusting property of the ListSelectionEvents that are generated.

For example, if the selection is being updated in response to a user drag, this property can be set to true when the drag is initiated and set to false when the drag is finished. During the drag, listeners receive events with a valueIsAdjusting property set to true. At the end of the drag, when the change is finalized, listeners receive an event with the value set to false. Listeners can use this pattern if they wish to update only when a change has been finalized.

Setting this property to true begins a series of changes that is to be considered part of a single change. When the property is changed back to false, an event is sent out characterizing the entire selection change (if there was one), with the event's valueIsAdjusting property set to false.

toStringback to summary
public String toString()

Overrides javax.swing.DefaultListModel.toString.

Doc from javax.swing.DefaultListModel.toString.

Returns a string that displays and identifies this object's properties.

updateLeadAnchorIndicesback to summary
private void updateLeadAnchorIndices(int anchorIndex, int leadIndex)