OptionsListModel (Starjava TOPCAT API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList
  - - uk.ac.starlink.topcat.OptionsListModel

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.List, javax.swing.ListModel
```
public class OptionsListModel
extends java.util.AbstractList
implements javax.swing.ListModel
```
Provides storage for a list of options with listeners. This class implements both List and ListModel (which ListModel really ought to do itself), and also provides methods to create some useful models like JComboBoxModel based on the same data.

Author:

Mark Taylor (Starlink)

Field Summary
- Fields inherited from class java.util.AbstractList
  modCount

Constructor Summary

Constructors
Constructor Description

OptionsListModel()

Constructors
Constructor	Description
`OptionsListModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`add(java.lang.Object obj)`
`void`	`addListDataListener(javax.swing.event.ListDataListener l)`
`void`	`fireContentsChanged(int i0, int i1)`
`void`	`fireIntervalAdded(int i0, int i1)`
`void`	`fireIntervalRemoved(int i0, int i1)`
`java.lang.Object`	`get(int index)`
`java.lang.Object`	`getElementAt(int index)`
`int`	`getSize()`
`int`	`idToIndex(int id)`	Returns the index at which an option with the given ID currently resides.
`int`	`indexToId(int index)`	Returns the unique ID value for the option currently at a given index in this list.
`CheckBoxMenu`	`makeCheckBoxMenu(java.lang.String menuName)`
`javax.swing.JComboBox`	`makeComboBox()`	Makes a new JComboBox from this model.
`javax.swing.ComboBoxModel`	`makeComboBoxModel()`	Constructs a new ComboBoxModel backed by this list.
`javax.swing.JMenu`	`makeJMenu(java.lang.String menuName, javax.swing.Action menuAction)`	Constructs a new JMenu backed by this list.
`java.lang.Object`	`remove(int irow)`
`void`	`removeListDataListener(javax.swing.event.ListDataListener l)`
`java.lang.Object`	`set(int irow, java.lang.Object obj)`
`int`	`size()`

Methods inherited from class java.util.AbstractCollection
addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.util.AbstractList
add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OptionsListModel
```
public OptionsListModel()
```
- Method Detail
  - get
```
public java.lang.Object get(int index)
```
    Specified by:
    
    get in interface java.util.List
    
    Specified by:
    
    get in class java.util.AbstractList
  - getElementAt
```
public java.lang.Object getElementAt(int index)
```
    Specified by:
    
    getElementAt in interface javax.swing.ListModel
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection
    
    Specified by:
    
    size in interface java.util.List
    
    Specified by:
    
    size in class java.util.AbstractCollection
  - getSize
```
public int getSize()
```
    Specified by:
    
    getSize in interface javax.swing.ListModel
  - add
```
public boolean add(java.lang.Object obj)
```
    Specified by:
    
    add in interface java.util.Collection
    
    Specified by:
    
    add in interface java.util.List
    
    Overrides:
    
    add in class java.util.AbstractList
  - set
```
public java.lang.Object set(int irow,
                            java.lang.Object obj)
```
    Specified by:
    
    set in interface java.util.List
    
    Overrides:
    
    set in class java.util.AbstractList
  - remove
```
public java.lang.Object remove(int irow)
```
    Specified by:
    
    remove in interface java.util.List
    
    Overrides:
    
    remove in class java.util.AbstractList
  - indexToId
```
public int indexToId(int index)
```
    Returns the unique ID value for the option currently at a given index in this list. The ID value for a given option is a small integer which does not change. ID values are not re-used within a given instance of this class.
    
    Parameters:
    
    index - current index for option
    
    Returns:
    
    identifier for option
  - idToIndex
```
public int idToIndex(int id)
```
    Returns the index at which an option with the given ID currently resides. If no option with the given ID is present, -1 is returned.
    
    Parameters:
    
    id - unique identifier
    
    Returns:
    
    index of option with id, or -1
    
    See Also:
    
    indexToId(int)
  - makeComboBoxModel
```
public javax.swing.ComboBoxModel makeComboBoxModel()
```
    Constructs a new ComboBoxModel backed by this list.
    
    See Also:
    
    makeComboBox()
  - makeComboBox
```
public javax.swing.JComboBox makeComboBox()
```
    Makes a new JComboBox from this model. This adds to the functionality of makeComboBoxModel() by ensuring that the box is revalidated when new items are added to the model; otherwise the box can end up too small. It also ensures that the box is rendered by using the name of the RowSubset is written.
    
    Returns:
    
    a combo box from which items in this model can be selected
  - makeJMenu
```
public javax.swing.JMenu makeJMenu(java.lang.String menuName,
                                   javax.swing.Action menuAction)
```
    Constructs a new JMenu backed by this list. One entry is added to the menu for each option in this list; the menu item will be labelled by the list item (using its toString method) and will activate the supplied menuAction action if selected. In this case the action's actionPerformed method will be called with an ActionEvent that has an id corresponding to its position in this list and a command string which is the same as its toString method.
    
    Parameters:
    
    menuName - the name of the menu
    
    menuAction - the action to activate
  - makeCheckBoxMenu
```
public CheckBoxMenu makeCheckBoxMenu(java.lang.String menuName)
```
  - addListDataListener
```
public void addListDataListener(javax.swing.event.ListDataListener l)
```
    Specified by:
    
    addListDataListener in interface javax.swing.ListModel
  - removeListDataListener
```
public void removeListDataListener(javax.swing.event.ListDataListener l)
```
    Specified by:
    
    removeListDataListener in interface javax.swing.ListModel
  - fireContentsChanged
```
public void fireContentsChanged(int i0,
                                int i1)
```
  - fireIntervalAdded
```
public void fireIntervalAdded(int i0,
                              int i1)
```
  - fireIntervalRemoved
```
public void fireIntervalRemoved(int i0,
                                int i1)
```

Class OptionsListModel

Field Summary

Fields inherited from class java.util.AbstractList

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.util.AbstractList

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Methods inherited from class java.lang.Object

Constructor Detail

OptionsListModel

Method Detail

get

getElementAt

size

getSize

add

set

remove

indexToId

idToIndex

makeComboBoxModel

makeComboBox

makeJMenu

makeCheckBoxMenu

addListDataListener

removeListDataListener

fireContentsChanged

fireIntervalAdded

fireIntervalRemoved