javax.swing.text.html
Class OptionListModel

java.lang.Object
  javax.swing.AbstractListModel
      javax.swing.DefaultListModel
          javax.swing.text.html.OptionListModel

All Implemented Interfaces:

ListModel, ListSelectionModel, Serializable

class OptionListModel

extends DefaultListModel

implements ListSelectionModel, 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

private int	anchorIndex
private int	firstChangedIndex
private BitSet	initialValue
private boolean	isAdjusting
private int	lastChangedIndex
protected boolean	leadAnchorNotificationEnabled
private int	leadIndex
protected EventListenerList	listenerList
private static int	MAX
private int	maxIndex
private static int	MIN
private int	minIndex
private int	selectionMode
private BitSet	value

Fields inherited from class javax.swing.DefaultListModel

Fields inherited from interface javax.swing.ListSelectionModel

MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION

Constructor Summary

(package private)

OptionListModel()

Method Summary

void	addListSelectionListener(ListSelectionListener l) 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.
private void	changeSelection(int clearMin, int clearMax, int setMin, int setMax)
private void	changeSelection(int clearMin, int clearMax, int setMin, int setMax, boolean clearFirst)
private void	clear(int r)
void	clearSelection() Change the selection to the empty set.
Object	clone() Returns a clone of the receiver with the same selection.
private boolean	contains(int a, int b, int i)
private void	fireValueChanged()
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 firstIndex, int lastIndex, boolean isAdjusting)
int	getAnchorSelectionIndex() Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
BitSet	getInitialSelection() Fetches the BitSet that represents the initial set of selected items in the list.
int	getLeadSelectionIndex() Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
ListSelectionListener[]	getListSelectionListeners() Returns an array of all the ListSelectionListeners added to this OptionListModel with addListSelectionListener().
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	isLeadAnchorNotificationEnabled() Returns the value of the leadAnchorNotificationEnabled flag.
boolean	isSelectedIndex(int index) Returns true if the specified index is selected.
boolean	isSelectionEmpty() Returns true if no indices are selected.
private void	markAsDirty(int r)
void	removeIndexInterval(int index0, int index1) Remove the indices in the interval index0,index1 (inclusive) from the selection model.
void	removeListSelectionListener(ListSelectionListener l) 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.
private void	set(int r)
void	setAnchorSelectionIndex(int anchorIndex) Set the anchor selection index, leaving all selection values unchanged.
void	setInitialSelection(int i) This method is responsible for storing the state of the initial selection.
void	setLeadAnchorNotificationEnabled(boolean flag) Sets the value of the leadAnchorNotificationEnabled flag.
void	setLeadSelectionIndex(int leadIndex) Set the lead selection index, ensuring that values between the anchor and the new lead are either all selected or all deselected.
void	setSelectionInterval(int index0, int index1) Change the selection to be between index0 and index1 inclusive.
void	setSelectionMode(int selectionMode) Set the selection mode.
private void	setState(int index, boolean state)
void	setValueIsAdjusting(boolean isAdjusting) This property is true if upcoming changes to the value of the model should be considered a single event.
String	toString() Returns a string that displays and identifies this object's properties.
private void	updateLeadAnchorIndices(int anchorIndex, int leadIndex)

Methods inherited from class javax.swing.DefaultListModel

add, addElement, capacity, clear, contains, copyInto, elementAt, elements, ensureCapacity, firstElement, get, getElementAt, getSize, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, removeAllElements, removeElement, removeElementAt, removeRange, set, setElementAt, setSize, size, toArray, trimToSize

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListener

Methods inherited from class java.lang.Object

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

Field Detail

MIN

private static final int MIN

See Also:

Constant Field Values

MAX

private static final int MAX

See Also:

Constant Field Values

selectionMode

private int selectionMode

minIndex

private int minIndex

maxIndex

private int maxIndex

anchorIndex

private int anchorIndex

leadIndex

private int leadIndex

firstChangedIndex

private int firstChangedIndex

lastChangedIndex

private int lastChangedIndex

isAdjusting

private boolean isAdjusting

value

private BitSet value

initialValue

private BitSet initialValue

listenerList

protected EventListenerList listenerList

leadAnchorNotificationEnabled

protected boolean leadAnchorNotificationEnabled

Constructor Detail

OptionListModel

OptionListModel()

Method Detail

getMinSelectionIndex

public int getMinSelectionIndex()

Description copied from interface: ListSelectionModel

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

Specified by:

getMinSelectionIndex in interface ListSelectionModel

getMaxSelectionIndex

public int getMaxSelectionIndex()

Description copied from interface: ListSelectionModel

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

Specified by:

getMaxSelectionIndex in interface ListSelectionModel

getValueIsAdjusting

public boolean getValueIsAdjusting()

Description copied from interface: ListSelectionModel

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:

ListSelectionModel.setValueIsAdjusting(boolean)

getSelectionMode

public int getSelectionMode()

Description copied from interface: ListSelectionModel

Returns the current selection mode.

Specified by:

getSelectionMode in interface ListSelectionModel

Returns:

The value of the selectionMode property.

See Also:

ListSelectionModel.setSelectionMode(int)

setSelectionMode

public void setSelectionMode(int selectionMode)

Description copied from interface: ListSelectionModel

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

See Also:

ListSelectionModel.getSelectionMode()

isSelectedIndex

public boolean isSelectedIndex(int index)

Description copied from interface: ListSelectionModel

Returns true if the specified index is selected.

Specified by:

isSelectedIndex in interface ListSelectionModel

isSelectionEmpty

public boolean isSelectionEmpty()

Description copied from interface: ListSelectionModel

Returns true if no indices are selected.

Specified by:

isSelectionEmpty in interface ListSelectionModel

addListSelectionListener

public void addListSelectionListener(ListSelectionListener l)

Description copied from interface: ListSelectionModel

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

Specified by:

addListSelectionListener in interface ListSelectionModel

Parameters:

l - the ListSelectionListener

See Also:

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

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener l)

Description copied from interface: ListSelectionModel

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

Specified by:

removeListSelectionListener in interface ListSelectionModel

Parameters:

l - the ListSelectionListener

See Also:

ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)

getListSelectionListeners

public ListSelectionListener[] getListSelectionListeners()

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

Returns:

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

Since:

1.4

fireValueChanged

protected void fireValueChanged(boolean isAdjusting)

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

fireValueChanged

protected void fireValueChanged(int firstIndex,
                                int lastIndex)

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

fireValueChanged

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

Parameters:

firstIndex - The first index in the interval.

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

See Also:

EventListenerList

fireValueChanged

private void fireValueChanged()

markAsDirty

private void markAsDirty(int r)

set

private void set(int r)

clear

private void clear(int r)

setLeadAnchorNotificationEnabled

public void setLeadAnchorNotificationEnabled(boolean flag)

Sets the value of the leadAnchorNotificationEnabled flag.

See Also:

isLeadAnchorNotificationEnabled()

isLeadAnchorNotificationEnabled

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:

the value of the leadAnchorNotificationEnabled flag

See Also:

setLeadAnchorNotificationEnabled(boolean)

updateLeadAnchorIndices

private void updateLeadAnchorIndices(int anchorIndex,
                                     int leadIndex)

contains

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

changeSelection

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

changeSelection

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

clearSelection

public void clearSelection()

Description copied from interface: ListSelectionModel

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:

ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)

setSelectionInterval

public void setSelectionInterval(int index0,
                                 int index1)

Description copied from interface: ListSelectionModel

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:

ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)

addSelectionInterval

public void addSelectionInterval(int index0,
                                 int index1)

Description copied from interface: ListSelectionModel

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:

ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)

removeSelectionInterval

public void removeSelectionInterval(int index0,
                                    int index1)

Description copied from interface: ListSelectionModel

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:

ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)

setState

private void setState(int index,
                      boolean state)

insertIndexInterval

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

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.

Specified by:

insertIndexInterval in interface ListSelectionModel

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

Specified by:

removeIndexInterval in interface ListSelectionModel

setValueIsAdjusting

public void setValueIsAdjusting(boolean isAdjusting)

Description copied from interface: ListSelectionModel

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:

isAdjusting - The new value of the property.

See Also:

ListSelectionModel.getValueIsAdjusting()

toString

public String toString()

Description copied from class: DefaultListModel

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

Overrides:

toString in class DefaultListModel

Returns:

a String representation of this object

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class Object

Returns:

a clone of the receiver

Throws:

CloneNotSupportedException - if the receiver does not both (a) implement the Cloneable interface and (b) define a clone method

See Also:

Cloneable

getAnchorSelectionIndex

public int getAnchorSelectionIndex()

Description copied from interface: ListSelectionModel

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

See Also:

ListSelectionModel.getLeadSelectionIndex(), ListSelectionModel.setSelectionInterval(int, int), ListSelectionModel.addSelectionInterval(int, int)

getLeadSelectionIndex

public int getLeadSelectionIndex()

Description copied from interface: ListSelectionModel

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

Specified by:

getLeadSelectionIndex in interface ListSelectionModel

See Also:

ListSelectionModel.getAnchorSelectionIndex(), ListSelectionModel.setSelectionInterval(int, int), ListSelectionModel.addSelectionInterval(int, int)

setAnchorSelectionIndex

public void setAnchorSelectionIndex(int anchorIndex)

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

Specified by:

setAnchorSelectionIndex in interface ListSelectionModel

See Also:

getAnchorSelectionIndex(), setLeadSelectionIndex(int)

setLeadSelectionIndex

public void setLeadSelectionIndex(int leadIndex)

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 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 deslecting 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.

Specified by:

setLeadSelectionIndex in interface ListSelectionModel

See Also:

getLeadSelectionIndex(), setAnchorSelectionIndex(int)

setInitialSelection

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.

getInitialSelection

public BitSet getInitialSelection()

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