CheckBoxStack (Starjava TOPCAT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - uk.ac.starlink.topcat.CheckBoxStack

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListDataListener, javax.swing.event.ListSelectionListener, javax.swing.Scrollable
```
public class CheckBoxStack
extends javax.swing.JPanel
implements javax.swing.event.ListSelectionListener, javax.swing.event.ListDataListener, javax.swing.Scrollable
```
A component containing a column of checkboxes representing a set of choices. This component does pretty much the same job as a JList, but is easier to use for individually selecting and deselecting individual list items. Like a JList, it has an associated ListModel and ListSelectionModel, which may be shared with other views in the usual way.

Author:

Mark Taylor (Starlink)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CheckBoxStack.Annotator
Defines how to get annotations for check box items.
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class javax.swing.JPanel
  javax.swing.JPanel.AccessibleJPanel

Nested Classes
Modifier and Type	Class	Description
`static interface`	`CheckBoxStack.Annotator`	Defines how to get annotations for check box items.

Field Summary
- Fields inherited from class java.awt.Component
  accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
- Fields inherited from class javax.swing.JComponent
  listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Constructors
Constructor	Description
`CheckBoxStack()`	Constructs a new CheckBoxStack from a default list model.
`CheckBoxStack(javax.swing.ListModel listModel)`	Constructs a new CheckBoxStack with no annotations from a ListModel.
`CheckBoxStack(javax.swing.ListModel listModel, CheckBoxStack.Annotator annotator)`	Constructs a new CheckBoxStack from a ListModel with an optional annotator for labelling the boxes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`contentsChanged(javax.swing.event.ListDataEvent evt)`
`javax.swing.ListModel`	`getListModel()`
`java.awt.Dimension`	`getPreferredScrollableViewportSize()`
`int`	`getScrollableBlockIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)`
`boolean`	`getScrollableTracksViewportHeight()`
`boolean`	`getScrollableTracksViewportWidth()`
`int`	`getScrollableUnitIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)`
`javax.swing.ListSelectionModel`	`getSelectionModel()`
`void`	`intervalAdded(javax.swing.event.ListDataEvent evt)`
`void`	`intervalRemoved(javax.swing.event.ListDataEvent evt)`
`void`	`setListModel(javax.swing.ListModel listModel)`
`void`	`setSelectionModel(javax.swing.DefaultListSelectionModel selModel)`
`void`	`valueChanged(javax.swing.event.ListSelectionEvent evt)`

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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

- Constructor Detail
  - CheckBoxStack
```
public CheckBoxStack(javax.swing.ListModel listModel,
                     CheckBoxStack.Annotator annotator)
```
    Constructs a new CheckBoxStack from a ListModel with an optional annotator for labelling the boxes.
    
    Parameters:
    
    listModel - the model
    
    annotator - object to generate annotations for each check box
  - CheckBoxStack
```
public CheckBoxStack(javax.swing.ListModel listModel)
```
    Constructs a new CheckBoxStack with no annotations from a ListModel.
    
    Parameters:
    
    listModel - the model
  - CheckBoxStack
```
public CheckBoxStack()
```
    Constructs a new CheckBoxStack from a default list model.
- Method Detail
  - getSelectionModel
```
public javax.swing.ListSelectionModel getSelectionModel()
```
  - setSelectionModel
```
public void setSelectionModel(javax.swing.DefaultListSelectionModel selModel)
```
  - getListModel
```
public javax.swing.ListModel getListModel()
```
  - setListModel
```
public void setListModel(javax.swing.ListModel listModel)
```
  - valueChanged
```
public void valueChanged(javax.swing.event.ListSelectionEvent evt)
```
    Specified by:
    
    valueChanged in interface javax.swing.event.ListSelectionListener
  - intervalAdded
```
public void intervalAdded(javax.swing.event.ListDataEvent evt)
```
    Specified by:
    
    intervalAdded in interface javax.swing.event.ListDataListener
  - intervalRemoved
```
public void intervalRemoved(javax.swing.event.ListDataEvent evt)
```
    Specified by:
    
    intervalRemoved in interface javax.swing.event.ListDataListener
  - contentsChanged
```
public void contentsChanged(javax.swing.event.ListDataEvent evt)
```
    Specified by:
    
    contentsChanged in interface javax.swing.event.ListDataListener
  - getPreferredScrollableViewportSize
```
public java.awt.Dimension getPreferredScrollableViewportSize()
```
    Specified by:
    
    getPreferredScrollableViewportSize in interface javax.swing.Scrollable
  - getScrollableTracksViewportHeight
```
public boolean getScrollableTracksViewportHeight()
```
    Specified by:
    
    getScrollableTracksViewportHeight in interface javax.swing.Scrollable
  - getScrollableTracksViewportWidth
```
public boolean getScrollableTracksViewportWidth()
```
    Specified by:
    
    getScrollableTracksViewportWidth in interface javax.swing.Scrollable
  - getScrollableUnitIncrement
```
public int getScrollableUnitIncrement(java.awt.Rectangle visibleRect,
                                      int orientation,
                                      int direction)
```
    Specified by:
    
    getScrollableUnitIncrement in interface javax.swing.Scrollable
  - getScrollableBlockIncrement
```
public int getScrollableBlockIncrement(java.awt.Rectangle visibleRect,
                                       int orientation,
                                       int direction)
```
    Specified by:
    
    getScrollableBlockIncrement in interface javax.swing.Scrollable

Class CheckBoxStack

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class javax.swing.JPanel

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Fields inherited from class javax.swing.JComponent

Constructor Summary

Method Summary

Methods inherited from class java.awt.Component

Methods inherited from class java.awt.Container

Methods inherited from class javax.swing.JComponent

Methods inherited from class javax.swing.JPanel

Methods inherited from class java.lang.Object

Constructor Detail

CheckBoxStack

CheckBoxStack

CheckBoxStack

Method Detail

getSelectionModel

setSelectionModel

getListModel

setListModel

valueChanged

intervalAdded

intervalRemoved

contentsChanged

getPreferredScrollableViewportSize

getScrollableTracksViewportHeight

getScrollableTracksViewportWidth

getScrollableUnitIncrement

getScrollableBlockIncrement