JChoice (GATE JavaDoc)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - gate.swing.JChoice<E>

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible
```
public class JChoice<E>
extends JPanel
implements ItemSelectable
```
A GUI component intended to allow quick selection from a set of options. When the number of choices is small (i.e less or equal to maximumFastChoices) then the options are represented as a set of buttons in a flow layout. If more options are available, a simple JComboBox is used instead.

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_FAST_CHOICES` The default value for the `maximumFastChoices` parameter.
`static int`	`DEFAULT_MAX_WIDTH` The default value for the `maximumWidth` parameter.

Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
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

Constructor Summary

Constructors
Constructor and Description
`JChoice()` Creates a FastChoice with a default empty data model.
`JChoice(ComboBoxModel<E> model)` Creates a FastChoice with the given data model.
`JChoice(E[] items)` Creates a FastChoice with a default data model populated from the provided array of objects.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActionListener(ActionListener l)`
`void`	`addItemListener(ItemListener listener)`
`void`	`addListDataListener(ListDataListener l)`
`Insets`	`getDefaultButtonMargin()`
`Object`	`getElementAt(int index)`
`int`	`getItemCount()`
`int`	`getMaximumFastChoices()`
`int`	`getMaximumWidth()`
`ComboBoxModel<E>`	`getModel()`
`Dimension`	`getPreferredSize()`
`Object`	`getSelectedItem()`
`Object[]`	`getSelectedObjects()`
`static void`	`main(String[] args)`
`void`	`removeActionListener(ActionListener l)`
`void`	`removeItemListener(ItemListener listener)`
`void`	`removeListDataListener(ListDataListener l)`
`void`	`setDefaultButtonMargin(Insets defaultButtonMargin)`
`void`	`setMaximumFastChoices(int maximumFastChoices)`
`void`	`setMaximumWidth(int maximumWidth)`
`void`	`setModel(ComboBoxModel<E> model)`
`void`	`setSelectedItem(Object anItem)`

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

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, 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 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 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

- Field Detail
  - DEFAULT_MAX_WIDTH
```
public static final int DEFAULT_MAX_WIDTH
```
    The default value for the maximumWidth parameter.
    
    See Also:
    Constant Field Values
  - DEFAULT_MAX_FAST_CHOICES
```
public static final int DEFAULT_MAX_FAST_CHOICES
```
    The default value for the maximumFastChoices parameter.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - JChoice
```
public JChoice()
```
    Creates a FastChoice with a default empty data model.
  - JChoice
```
public JChoice(ComboBoxModel<E> model)
```
    Creates a FastChoice with the given data model.
  - JChoice
```
public JChoice(E[] items)
```
    Creates a FastChoice with a default data model populated from the provided array of objects.
- Method Detail
  - getSelectedObjects
```
public Object[] getSelectedObjects()
```
    Specified by:
    
    getSelectedObjects in interface ItemSelectable
  - main
```
public static void main(String[] args)
```
  - removeActionListener
```
public void removeActionListener(ActionListener l)
```
    Parameters:
    l -
    See Also:
    JComboBox.removeActionListener(java.awt.event.ActionListener)
  - removeItemListener
```
public void removeItemListener(ItemListener listener)
```
    Specified by:
    
    removeItemListener in interface ItemSelectable
    
    Parameters:
    listener -
    See Also:
    JComboBox.removeItemListener(java.awt.event.ItemListener)
  - addActionListener
```
public void addActionListener(ActionListener l)
```
    Parameters:
    l -
    See Also:
    JComboBox.addActionListener(java.awt.event.ActionListener)
  - addItemListener
```
public void addItemListener(ItemListener listener)
```
    Specified by:
    
    addItemListener in interface ItemSelectable
    
    Parameters:
    listener -
    See Also:
    JComboBox.addItemListener(java.awt.event.ItemListener)
  - addListDataListener
```
public void addListDataListener(ListDataListener l)
```
    Parameters:
    l -
    See Also:
    ListModel.addListDataListener(javax.swing.event.ListDataListener)
  - getElementAt
```
public Object getElementAt(int index)
```
    See Also:
    ListModel.getElementAt(int)
  - getSelectedItem
```
public Object getSelectedItem()
```
    See Also:
    ComboBoxModel.getSelectedItem()
  - getItemCount
```
public int getItemCount()
```
    See Also:
    ListModel.getSize()
  - removeListDataListener
```
public void removeListDataListener(ListDataListener l)
```
    Parameters:
    l -
    See Also:
    ListModel.removeListDataListener(javax.swing.event.ListDataListener)
  - setSelectedItem
```
public void setSelectedItem(Object anItem)
```
    Parameters:
    anItem -
    See Also:
    ComboBoxModel.setSelectedItem(java.lang.Object)
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Overrides:
    
    getPreferredSize in class JComponent
  - getMaximumFastChoices
```
public int getMaximumFastChoices()
```
    Returns:
    the maximumFastChoices
  - setMaximumFastChoices
```
public void setMaximumFastChoices(int maximumFastChoices)
```
    Parameters:
    maximumFastChoices - the maximumFastChoices to set
  - getModel
```
public ComboBoxModel<E> getModel()
```
    Returns:
    the model
  - setModel
```
public void setModel(ComboBoxModel<E> model)
```
    Parameters:
    model - the model to set
  - getMaximumWidth
```
public int getMaximumWidth()
```
    Returns:
    the maximumWidth
  - setMaximumWidth
```
public void setMaximumWidth(int maximumWidth)
```
    Parameters:
    maximumWidth - the maximumWidth to set
  - getDefaultButtonMargin
```
public Insets getDefaultButtonMargin()
```
    Returns:
    the defaultButtonMargin
  - setDefaultButtonMargin
```
public void setDefaultButtonMargin(Insets defaultButtonMargin)
```
    Parameters:
    defaultButtonMargin - the defaultButtonMargin to set

Class JChoice<E>

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_WIDTH

DEFAULT_MAX_FAST_CHOICES

Constructor Detail

JChoice

JChoice

JChoice

Method Detail

getSelectedObjects

main

removeActionListener

removeItemListener

addActionListener

addItemListener

addListDataListener

getElementAt

getSelectedItem

getItemCount

removeListDataListener

setSelectedItem

getPreferredSize

getMaximumFastChoices

setMaximumFastChoices

getModel

setModel

getMaximumWidth

setMaximumWidth

getDefaultButtonMargin

setDefaultButtonMargin