JIDE 3.4.0

com.jidesoft.combobox
Class CheckBoxListChooserPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by com.jidesoft.combobox.PopupPanel
                      extended by com.jidesoft.combobox.ButtonPopupPanel
                          extended by com.jidesoft.combobox.MultiSelectListChooserPanel
                              extended by com.jidesoft.combobox.CheckBoxListChooserPanel
All Implemented Interfaces:
DefaultButtonProvider, ItemListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, ListDataListener

public class CheckBoxListChooserPanel
extends MultiSelectListChooserPanel

CheckBoxListChooserPanel is a PopupPanel that can choose a value from a CheckBoxList. It is similar to MultiSelectListChooserPanel except it is uses CheckBoxList to allow multiple selection.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.jidesoft.combobox.MultiSelectListChooserPanel
MultiSelectListChooserPanel.Handler
 
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 inherited from class com.jidesoft.combobox.MultiSelectListChooserPanel
_class, _list, _listModel, listMouseListener, listMouseMotionListener, mouseListener, mouseMotionListener
 
Fields inherited from class com.jidesoft.combobox.ButtonPopupPanel
_cancelAction, _cancelButton, _okAction, _okButton
 
Fields inherited from class com.jidesoft.combobox.PopupPanel
_previousSelectedObject, SELECTED_BY_MOUSE_ROLLOVER
 
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
CheckBoxListChooserPanel()
           
CheckBoxListChooserPanel(Action okAction, Action cancelAction)
           
CheckBoxListChooserPanel(ComboBoxModel model, Class<?> clazz)
           
CheckBoxListChooserPanel(ComboBoxModel model, Class<?> clazz, Action okAction, Action cancelAction)
           
CheckBoxListChooserPanel(ComboBoxModel model, Class<?> clazz, ConverterContext elementConverterContext)
           
CheckBoxListChooserPanel(ComboBoxModel model, Class<?> clazz, ConverterContext elementConverterContext, Action okAction, Action cancelAction)
           
CheckBoxListChooserPanel(Object[] objects, Class<?> clazz)
           
CheckBoxListChooserPanel(Object[] objects, Class<?> clazz, Action okAction, Action cancelAction)
           
CheckBoxListChooserPanel(Vector<?> objects, Class<?> clazz)
           
CheckBoxListChooserPanel(Vector<?> objects, Class<?> clazz, Action okAction, Action cancelAction)
           
 
Method Summary
protected  JList createList(ComboBoxModel comboBoxModel)
          Subclass can override this method to create a custom JList.
protected  void customizeScroller(JScrollPane scroller)
          Configures the scrollable portion which holds the list within the combo box popup.
protected  boolean isAutoScroll()
           
protected  Object[] retrieveListSelection()
           
protected  void setupList(JList list)
          Configures the list.
protected  void updateListSelection(Object selectedObject)
           
 
Methods inherited from class com.jidesoft.combobox.MultiSelectListChooserPanel
configureListModel, contentsChanged, convertComboBoxModelToVector, convertMouseEvent, createListModel, createListMouseListener, createListMouseMotionListener, createMouseListener, createMouseMotionListener, createPropertyChangeListener, getConverter, getConverterContext, getList, getMaximumRowCount, getRenderer, getSelectedObject, initComponents, installListListeners, intervalAdded, intervalRemoved, itemStateChanged, setConverter, setConverterContext, setMaximumRowCount, setRenderer
 
Methods inherited from class com.jidesoft.combobox.ButtonPopupPanel
createButtonPanel, getCancelAction, getDefaultButton, getOkAction, getOkButton, setCancelAction, setOkAction
 
Methods inherited from class com.jidesoft.combobox.PopupPanel
addItemListener, addItemListener, fireItemStateChanged, getActualPreferredSize, getDefaultFocusComponent, getItemListeners, getMouseListener, getMouseMotionListener, getPreferredSize, getPreviousSelectedObject, getResizableCorners, getSelectedObjects, getTitle, isResetButtonVisible, isResizable, isStretchToFit, needsButtons, removeItemListener, requestFocus, setDefaultFocusComponent, setNeedButtons, setPreferredSize, setResizable, setResizableCorners, setSelectedObject, setSelectedObject, setSelectedObject, setSelectedObject, setStretchToFit, setTitle
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CheckBoxListChooserPanel

public CheckBoxListChooserPanel()

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(Action okAction,
                                Action cancelAction)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(Object[] objects,
                                Class<?> clazz)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(Object[] objects,
                                Class<?> clazz,
                                Action okAction,
                                Action cancelAction)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(Vector<?> objects,
                                Class<?> clazz)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(Vector<?> objects,
                                Class<?> clazz,
                                Action okAction,
                                Action cancelAction)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(ComboBoxModel model,
                                Class<?> clazz)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(ComboBoxModel model,
                                Class<?> clazz,
                                Action okAction,
                                Action cancelAction)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(ComboBoxModel model,
                                Class<?> clazz,
                                ConverterContext elementConverterContext)

CheckBoxListChooserPanel

public CheckBoxListChooserPanel(ComboBoxModel model,
                                Class<?> clazz,
                                ConverterContext elementConverterContext,
                                Action okAction,
                                Action cancelAction)
Method Detail

customizeScroller

protected void customizeScroller(JScrollPane scroller)
Configures the scrollable portion which holds the list within the combo box popup. This method is called when the UI class is created.

Overrides:
customizeScroller in class MultiSelectListChooserPanel
Parameters:
scroller - the scroll pane to be customized.

createList

protected JList createList(ComboBoxModel comboBoxModel)
Subclass can override this method to create a custom JList.

Overrides:
createList in class MultiSelectListChooserPanel
Parameters:
comboBoxModel - the combobox model which is used to create a CheckBoxList.
Returns:
the list

setupList

protected void setupList(JList list)
Configures the list. The base class sets cell renderer and add mouse/key listener in this method. Subclass can override this method to do additional setup. The Searchable is installed in this method. If you override, you need to install the Searchable on the list by yourself.

Overrides:
setupList in class MultiSelectListChooserPanel
Parameters:
list - the check box list

retrieveListSelection

protected Object[] retrieveListSelection()
Overrides:
retrieveListSelection in class MultiSelectListChooserPanel

updateListSelection

protected void updateListSelection(Object selectedObject)
Overrides:
updateListSelection in class MultiSelectListChooserPanel

isAutoScroll

protected boolean isAutoScroll()
Overrides:
isAutoScroll in class MultiSelectListChooserPanel

JIDE 3.4.0