com.fr.design.gui.itree.checkboxtree

类 CheckBoxTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

com.fr.design.gui.itree.checkboxtree.CheckBoxTree

所有已实现的接口:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

直接已知子类:

RefreshableJTree

public class CheckBoxTree
extends javax.swing.JTree

CheckBoxTree is a special JTree which uses UICheckBox as the tree renderer. In addition to regular JTree's features, it also allows you select any number of tree nodes in the tree by selecting the check boxes.

To select an element, user can mouse click on the check box, or select one or several tree nodes and press SPACE key to toggle the check box selection for all selected tree nodes.

In order to retrieve which tree paths are selected, you need to call getCheckBoxTreeSelectionModel(). It will return the selection model that keeps track of which tree paths have been checked. For example DefaultTreeSelectionModel.getSelectionPaths() will give the list of paths which have been checked.

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	CheckBoxTree.Handler

从类继承的嵌套类/接口 javax.swing.JTree

javax.swing.JTree.AccessibleJTree, javax.swing.JTree.DropLocation, javax.swing.JTree.DynamicUtilTreeNode, javax.swing.JTree.EmptySelectionModel, javax.swing.JTree.TreeModelHandler, javax.swing.JTree.TreeSelectionRedirector

从类继承的嵌套类/接口 javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

从类继承的嵌套类/接口 java.awt.Container

java.awt.Container.AccessibleAWTContainer

从类继承的嵌套类/接口 java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

字段概要

字段

限定符和类型	字段和说明
protected CheckBoxTreeCellRenderer	_treeCellRenderer
static java.lang.String	PROPERTY_CHECKBOX_ENABLED
static java.lang.String	PROPERTY_DIG_IN

从类继承的字段 javax.swing.JTree

ANCHOR_SELECTION_PATH_PROPERTY, CELL_EDITOR_PROPERTY, CELL_RENDERER_PROPERTY, cellEditor, cellRenderer, editable, EDITABLE_PROPERTY, EXPANDS_SELECTED_PATHS_PROPERTY, INVOKES_STOP_CELL_EDITING_PROPERTY, invokesStopCellEditing, LARGE_MODEL_PROPERTY, largeModel, LEAD_SELECTION_PATH_PROPERTY, ROOT_VISIBLE_PROPERTY, rootVisible, ROW_HEIGHT_PROPERTY, rowHeight, SCROLLS_ON_EXPAND_PROPERTY, scrollsOnExpand, SELECTION_MODEL_PROPERTY, selectionModel, selectionRedirector, SHOWS_ROOT_HANDLES_PROPERTY, showsRootHandles, TOGGLE_CLICK_COUNT_PROPERTY, toggleClickCount, TREE_MODEL_PROPERTY, treeModel, treeModelListener, VISIBLE_ROW_COUNT_PROPERTY, visibleRowCount

从类继承的字段 javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

从类继承的字段 java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

从接口继承的字段 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

构造器概要

构造器

构造器和说明
CheckBoxTree()
CheckBoxTree(java.util.Hashtable value)
CheckBoxTree(java.lang.Object[] value)
CheckBoxTree(javax.swing.tree.TreeModel newModel)
CheckBoxTree(javax.swing.tree.TreeNode root)
CheckBoxTree(javax.swing.tree.TreeNode root, boolean asksAllowsChildren)
CheckBoxTree(java.util.Vector value)

方法概要

方法

限定符和类型	方法和说明
protected CheckBoxTreeCellRenderer	createCellRenderer(javax.swing.tree.TreeCellRenderer renderer) Creates the cell renderer.
protected CheckBoxTreeSelectionModel	createCheckBoxTreeSelectionModel(javax.swing.tree.TreeModel model) Creates the CheckBoxTreeSelectionModel.
protected CheckBoxTree.Handler	createHandler() Creates the mouse listener and key listener used by CheckBoxTree.
javax.swing.tree.TreeCellRenderer	getActualCellRenderer() Gets the actual cell renderer.
javax.swing.tree.TreeCellRenderer	getCellRenderer() Gets the cell renderer with check box.
CheckBoxTreeSelectionModel	getCheckBoxTreeSelectionModel() Gets the selection model for the check boxes.
javax.swing.tree.TreePath	getNextMatch(java.lang.String prefix, int startingRow, javax.swing.text.Position.Bias bias)
protected void	init() Initialize the CheckBoxTree.
boolean	isCheckBoxEnabled() Gets the value of property checkBoxEnabled.
boolean	isCheckBoxEnabled(javax.swing.tree.TreePath path) Checks if check box is enabled.
boolean	isCheckBoxVisible(javax.swing.tree.TreePath path) Checks if check box is visible.
boolean	isDigIn() Gets the dig-in mode.
void	setCheckBoxEnabled(boolean checkBoxEnabled) Sets the value of property checkBoxEnabled.
void	setDigIn(boolean digIn) Sets the dig-in mode.
void	setModel(javax.swing.tree.TreeModel newModel)

从类继承的方法 javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, convertValueToText, createTreeModel, createTreeModelListener, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireTreeWillExpand, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getPreferredScrollableViewportSize, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getSelectionPaths, getSelectionRows, getShowsRootHandles, getToggleClickCount, getToolTipText, getTreeExpansionListeners, getTreeSelectionListeners, getTreeWillExpandListeners, getUI, getUIClassID, getVisibleRowCount, hasBeenExpanded, isCollapsed, isCollapsed, isEditable, isEditing, isExpanded, isExpanded, isFixedRowHeight, isLargeModel, isPathEditable, isPathSelected, isRootVisible, isRowSelected, isSelectionEmpty, isVisible, makeVisible, paramString, removeDescendantSelectedPaths, removeDescendantToggledPaths, removeSelectionInterval, removeSelectionPath, removeSelectionPaths, removeSelectionRow, removeSelectionRows, removeTreeExpansionListener, removeTreeSelectionListener, removeTreeWillExpandListener, scrollPathToVisible, scrollRowToVisible, setAnchorSelectionPath, setCellEditor, setCellRenderer, setDragEnabled, setDropMode, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, treeDidChange, updateUI

从类继承的方法 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

从类继承的方法 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

从类继承的方法 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

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

PROPERTY_CHECKBOX_ENABLED

public static final java.lang.String PROPERTY_CHECKBOX_ENABLED

另请参阅:

常量字段值

PROPERTY_DIG_IN

public static final java.lang.String PROPERTY_DIG_IN

另请参阅:

常量字段值

_treeCellRenderer

protected CheckBoxTreeCellRenderer _treeCellRenderer

构造器详细资料

CheckBoxTree

public CheckBoxTree()

CheckBoxTree

public CheckBoxTree(java.lang.Object[] value)

CheckBoxTree

public CheckBoxTree(java.util.Vector value)

CheckBoxTree

public CheckBoxTree(java.util.Hashtable value)

CheckBoxTree

public CheckBoxTree(javax.swing.tree.TreeNode root)

CheckBoxTree

public CheckBoxTree(javax.swing.tree.TreeNode root,
            boolean asksAllowsChildren)

CheckBoxTree

public CheckBoxTree(javax.swing.tree.TreeModel newModel)

方法详细资料

init

protected void init()

Initialize the CheckBoxTree.

createCheckBoxTreeSelectionModel

protected CheckBoxTreeSelectionModel createCheckBoxTreeSelectionModel(javax.swing.tree.TreeModel model)

Creates the CheckBoxTreeSelectionModel.

参数:

model - the tree model.

返回:

the CheckBoxTreeSelectionModel.

setModel

public void setModel(javax.swing.tree.TreeModel newModel)

覆盖:

setModel 在类中 javax.swing.JTree

getCellRenderer

public javax.swing.tree.TreeCellRenderer getCellRenderer()

Gets the cell renderer with check box.

覆盖:

getCellRenderer 在类中 javax.swing.JTree

返回:

CheckBoxTree's own cell renderer which has the check box. The actual cell renderer you set by setCellRenderer() can be accessed by using getActualCellRenderer().

getActualCellRenderer

public javax.swing.tree.TreeCellRenderer getActualCellRenderer()

Gets the actual cell renderer. Since CheckBoxTree has its own check box cell renderer, this method will give you access to the actual cell renderer which is either the default tree cell renderer or the cell renderer you set using JTree.setCellRenderer(javax.swing.tree.TreeCellRenderer).

返回:

the actual cell renderer

createCellRenderer

protected CheckBoxTreeCellRenderer createCellRenderer(javax.swing.tree.TreeCellRenderer renderer)

Creates the cell renderer.

参数:

renderer - the actual renderer for the tree node. This method will return a cell renderer that use a check box and put the actual renderer inside it.

返回:

the cell renderer.

createHandler

protected CheckBoxTree.Handler createHandler()

Creates the mouse listener and key listener used by CheckBoxTree.

返回:

the Handler.

getNextMatch

public javax.swing.tree.TreePath getNextMatch(java.lang.String prefix,
                                     int startingRow,
                                     javax.swing.text.Position.Bias bias)

覆盖:

getNextMatch 在类中 javax.swing.JTree

getCheckBoxTreeSelectionModel

public CheckBoxTreeSelectionModel getCheckBoxTreeSelectionModel()

Gets the selection model for the check boxes. To retrieve the state of check boxes, you should use this selection model.

返回:

the selection model for the check boxes.

isCheckBoxEnabled

public boolean isCheckBoxEnabled()

Gets the value of property checkBoxEnabled. If true, user can click on check boxes on each tree node to select and unselect. If false, user can't click but you as developer can programatically call API to select/unselect it.

返回:

the value of property checkBoxEnabled.

setCheckBoxEnabled

public void setCheckBoxEnabled(boolean checkBoxEnabled)

Sets the value of property checkBoxEnabled.

参数:

checkBoxEnabled - true to allow to check the check box. False to disable it which means user can see whether a row is checked or not but they cannot change it.

isCheckBoxEnabled

public boolean isCheckBoxEnabled(javax.swing.tree.TreePath path)

Checks if check box is enabled. There is no setter for it. The only way is to override this method to return true or false.

参数:

path - the tree path.

返回:

true or false. If false, the check box on the particular tree path will be disabled.

isCheckBoxVisible

public boolean isCheckBoxVisible(javax.swing.tree.TreePath path)

Checks if check box is visible. There is no setter for it. The only way is to override this method to return true or false.

参数:

path - the tree path.

返回:

true or false. If false, the check box on the particular tree path will be disabled.

isDigIn

public boolean isDigIn()

Gets the dig-in mode. If the CheckBoxTree is in dig-in mode, checking the parent node will check all the children. Correspondingly, getSelectionPaths() will only return the parent tree path. If not in dig-in mode, each tree node can be checked or unchecked independently

返回:

true or false.

setDigIn

public void setDigIn(boolean digIn)

Sets the dig-in mode. If the CheckBoxTree is in dig-in mode, checking the parent node will check all the children. Correspondingly, getSelectionPaths() will only return the parent tree path. If not in dig-in mode, each tree node can be checked or unchecked independently

参数:

digIn - the new digIn mode.