Package com.jidesoft.swing
Class CheckBoxTreeCellRenderer
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- com.jidesoft.swing.CheckBoxTreeCellRenderer
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
,javax.swing.tree.TreeCellRenderer
public class CheckBoxTreeCellRenderer extends javax.swing.JPanel implements javax.swing.tree.TreeCellRenderer, java.io.Serializable
Renderers an item in a tree using JCheckBox.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description protected javax.swing.tree.TreeCellRenderer
_actualTreeRenderer
The label which appears after the check box.protected TristateCheckBox
_checkBox
The checkbox that is used to paint the check box in cell rendererprotected javax.swing.JComponent
_emptyBox
protected javax.swing.JCheckBox
_protoType
-
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 CheckBoxTreeCellRenderer()
Constructs a default renderer object for an item in a list.CheckBoxTreeCellRenderer(javax.swing.tree.TreeCellRenderer renderer)
CheckBoxTreeCellRenderer(javax.swing.tree.TreeCellRenderer renderer, TristateCheckBox checkBox)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected TristateCheckBox
createCheckBox()
Create the check box in the cell.javax.swing.tree.TreeCellRenderer
getActualTreeRenderer()
java.lang.String
getToolTipText(java.awt.event.MouseEvent event)
java.awt.Component
getTreeCellRendererComponent(javax.swing.JTree tree, java.lang.Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)
void
setActualTreeRenderer(javax.swing.tree.TreeCellRenderer actualTreeRenderer)
protected void
updateCheckBoxState(TristateCheckBox checkBox, javax.swing.tree.TreePath path, CheckBoxTreeSelectionModel selectionModel)
Updates the check box state based on the selection in the selection model.-
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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, 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, 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
-
-
-
-
Field Detail
-
_checkBox
protected TristateCheckBox _checkBox
The checkbox that is used to paint the check box in cell renderer
-
_emptyBox
protected javax.swing.JComponent _emptyBox
-
_protoType
protected javax.swing.JCheckBox _protoType
-
_actualTreeRenderer
protected javax.swing.tree.TreeCellRenderer _actualTreeRenderer
The label which appears after the check box.
-
-
Constructor Detail
-
CheckBoxTreeCellRenderer
public CheckBoxTreeCellRenderer()
Constructs a default renderer object for an item in a list.
-
CheckBoxTreeCellRenderer
public CheckBoxTreeCellRenderer(javax.swing.tree.TreeCellRenderer renderer)
-
CheckBoxTreeCellRenderer
public CheckBoxTreeCellRenderer(javax.swing.tree.TreeCellRenderer renderer, TristateCheckBox checkBox)
-
-
Method Detail
-
createCheckBox
protected TristateCheckBox createCheckBox()
Create the check box in the cell. By default, it creates a TristateCheckBox and set opaque to false.- Returns:
- the check box instance.
-
getActualTreeRenderer
public javax.swing.tree.TreeCellRenderer getActualTreeRenderer()
-
setActualTreeRenderer
public void setActualTreeRenderer(javax.swing.tree.TreeCellRenderer actualTreeRenderer)
-
getTreeCellRendererComponent
public java.awt.Component getTreeCellRendererComponent(javax.swing.JTree tree, java.lang.Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)
- Specified by:
getTreeCellRendererComponent
in interfacejavax.swing.tree.TreeCellRenderer
-
updateCheckBoxState
protected void updateCheckBoxState(TristateCheckBox checkBox, javax.swing.tree.TreePath path, CheckBoxTreeSelectionModel selectionModel)
Updates the check box state based on the selection in the selection model. By default, we check if the path is selected. If yes, we mark the check box as TristateCheckBox.SELECTED. If not, we will check if the path is partially selected, if yes, we set the check box as null or TristateCheckBox.DONT_CARE to indicate the path is partially selected. Otherwise, we set it to TristateCheckBox.NOT_SELECTED.- Parameters:
checkBox
- the TristateCheckBox for the particular tree path.path
- the tree path.selectionModel
- the CheckBoxTreeSelectionModel.
-
getToolTipText
public java.lang.String getToolTipText(java.awt.event.MouseEvent event)
- Overrides:
getToolTipText
in classjavax.swing.JComponent
-
-