com.jidesoft.combobox
Class CheckBoxTreeChooserPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.combobox.PopupPanel
                      com.jidesoft.combobox.TreeChooserPanel
                          com.jidesoft.combobox.CheckBoxTreeChooserPanel

All Implemented Interfaces:

DefaultButtonProvider, ItemListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible

public class CheckBoxTreeChooserPanel
extends TreeChooserPanel
implements DefaultButtonProvider

CheckBoxTreeChooserPanel is a PopupPanel that can choose values from a check box _checkBoxTree. It is similar to TreeChooserPanel except it uses CheckBox as the _checkBoxTree leaf and multiple values could be selected.

Since:

3.4.1

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

protected Action	_cancelAction
protected JButton	_cancelButton
protected Action	_okAction
protected JButton	_okButton

Fields inherited from class com.jidesoft.combobox.TreeChooserPanel

_model, keyListener, mouseListener, mouseMotionListener, treeMouseListener, treeMouseMotionListener, treeSelectionListener

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

CheckBoxTreeChooserPanel()
Creates a new CheckBoxTreeChooserPanel.

CheckBoxTreeChooserPanel(Action okAction, Action cancelAction)
Creates a new CheckBoxTreeChooserPanel.

CheckBoxTreeChooserPanel(TreeModel model)
Creates a new CheckBoxTreeChooserPanel with a TreeModel.

CheckBoxTreeChooserPanel(TreeModel model, Action okAction, Action cancelAction)
Creates a new CheckBoxTreeChooserPanel with a TreeModel.

Method Summary

Component	createButtonPanel(int alignment)
protected JTree	createTree(TreeModel model) Subclass can override this method to create a custom tree.
Action	getCancelAction()
JButton	getDefaultButton() Gets the default button
Action	getOkAction()
protected void	initComponents()
void	itemStateChanged(ItemEvent e) Setup tree selections when item state changed
void	setCancelAction(Action cancelAction)
void	setOkAction(Action okAction)
protected void	setupTree(JTree tree) Configures the tree.

Methods inherited from class com.jidesoft.combobox.TreeChooserPanel

convertMouseEvent, createItemListener, createKeyListener, createListDataListener, createMouseListener, createMouseMotionListener, createPropertyChangeListener, createTreeModel, createTreeMouseListener, createTreeMouseMotionListener, createTreeSelectionListener, customizeScroller, getCellRenderer, getDefaultTreeModel, getMaximumRowCount, getTree, installTreeListeners, isDoubleClickExpand, isSearchUserObjectToSelect, isValidSelection, setCellRenderer, setDoubleClickExpand, setMaximumRowCount, setSearchUserObjectToSelect, updateTreeSelectionForEvent

Methods inherited from class com.jidesoft.combobox.PopupPanel

addItemListener, addItemListener, fireItemStateChanged, getActualPreferredSize, getDefaultFocusComponent, getItemListeners, getMouseListener, getMouseMotionListener, getPreferredSize, getPreviousSelectedObject, getResizableCorners, getSelectedObject, getSelectedObjects, getTitle, isResetButtonVisible, isResizable, isStretchToFit, needsButtons, removeAllListeners, 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

Field Detail

_okButton

protected JButton _okButton

_cancelButton

protected JButton _cancelButton

_okAction

protected Action _okAction

_cancelAction

protected Action _cancelAction

Constructor Detail

CheckBoxTreeChooserPanel

public CheckBoxTreeChooserPanel()

Creates a new CheckBoxTreeChooserPanel.

CheckBoxTreeChooserPanel

public CheckBoxTreeChooserPanel(Action okAction,
                                Action cancelAction)

Creates a new CheckBoxTreeChooserPanel.

Parameters:

okAction - the ok action

cancelAction - the cancel action

CheckBoxTreeChooserPanel

public CheckBoxTreeChooserPanel(TreeModel model)

Creates a new CheckBoxTreeChooserPanel with a TreeModel.

Parameters:

model - the TreeModel to create tree odel

CheckBoxTreeChooserPanel

public CheckBoxTreeChooserPanel(TreeModel model,
                                Action okAction,
                                Action cancelAction)

Creates a new CheckBoxTreeChooserPanel with a TreeModel.

Parameters:

model - the tree model

okAction - the ok action

cancelAction - the cancel action

Method Detail

createTree

protected JTree createTree(TreeModel model)

Description copied from class: TreeChooserPanel

Subclass can override this method to create a custom tree. The Searchable is installed in this method. If you override, you need to install the Searchable on the tree by yourself. Please note, you must use the model passed in as parameter for the tree you created. If you want to use your own model, please pass it in through the constructor of TreeChooserPanel.

Overrides:

createTree in class TreeChooserPanel

Parameters:

model - the tree model.

Returns:

the tree

setupTree

protected void setupTree(JTree tree)

Configures the tree. The base class sets cell renderer and add mouse/key listener in this method. Subclass can override this method to do additional setup.

Overrides:

setupTree in class TreeChooserPanel

Parameters:

tree - the JTree

setOkAction

public void setOkAction(Action okAction)

getOkAction

public Action getOkAction()

setCancelAction

public void setCancelAction(Action cancelAction)

getCancelAction

public Action getCancelAction()

getDefaultButton

public JButton getDefaultButton()

Description copied from interface: DefaultButtonProvider

Gets the default button

Specified by:

getDefaultButton in interface DefaultButtonProvider

Returns:

the default button

createButtonPanel

public Component createButtonPanel(int alignment)

initComponents

protected void initComponents()

Overrides:

initComponents in class TreeChooserPanel

itemStateChanged

public void itemStateChanged(ItemEvent e)

Setup tree selections when item state changed

Specified by:

itemStateChanged in interface ItemListener

Overrides:

itemStateChanged in class TreeChooserPanel

Parameters:

e - the item change event