CategoryTreeBean (MiG Calendar API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.miginfocom.beans
Class CategoryTreeBean

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.miginfocom.beans.CategoryTreeBean

All Implemented Interfaces:: InteractionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class CategoryTreeBean
extends javax.swing.JPanel
implements InteractionListener
extends javax.swing.JPanel
implements InteractionListener

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`

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

Nested classes/interfaces inherited from class java.awt.Component
`java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy`

Field Summary
`static java.lang.String`	`CHECK_CLICKED` The Command Value in for the InteractionEvent that is fired when the label is clicked.
`static PropertyKey`	`CHECK_SELECTED_KEY` This is the default key used to set in the `Category` a `Boolean` object denoting if the check box is concidered selected or not.
`static java.lang.String`	`FOLDER_CHECK_BACKGROUND_SHAPE_NAME`
`static java.lang.String`	`FOLDER_CHECK_IMAGE_SHAPE_NAME`
`static java.lang.String`	`FOLDER_CHECK_OUTLINE_SHAPE_NAME`
`static java.lang.String`	`FOLDER_CONTAINER_SHAPE_NAME`
`static java.lang.String`	`FOLDER_LABEL_SHAPE_NAME`
`static java.lang.String`	`LABEL_CLICKED` The Command Value in for the InteractionEvent that is fired when the label is clicked.
`static PropertyKey`	`LABEL_SELECTED_KEY` This is the default key used to set in the `Category` a `Boolean` object denoting if the label is concidered selected or not.
`static java.lang.String`	`LEAF_CHECK_BACKGROUND_SHAPE_NAME`
`static java.lang.String`	`LEAF_CHECK_IMAGE_SHAPE_NAME`
`static java.lang.String`	`LEAF_CHECK_OUTLINE_SHAPE_NAME`
`static java.lang.String`	`LEAF_CONTAINER_SHAPE_NAME`
`static java.lang.String`	`LEAF_LABEL_SHAPE_NAME`
`static java.lang.String`	`ROOT_SHAPE_NAME`

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
`CategoryTreeBean()`

Method Summary
`void`	`addDecorator(Decorator decorator)` Adds a decorator.
`void`	`addDecorators(java.util.Collection decorators)` Calls `addDecorator(com.miginfocom.calendar.decorators.Decorator)` for every element in the collection.
`void`	`addInteractionListener(InteractionListener l)` Adds a listener that listens to `InteractionEvent`s.
`void`	`addInteractionListener(InteractionListener l, boolean asWeakRef)` Adds a listener that listens to `InteractionEvent`s.
`void`	`addNotify()`
`int`	`getAntiAliasHint()` Property: The anti alias hint for the label text.
`java.awt.Paint`	`getBackgroundPaint()` Sets the background paint.
`Category`	`getCategoryAtLocation(int x, int y)` A hit test that returns the Category for a point.
`boolean`	`getCategoryAutoRevalidate()` Property: If the categories in the `CategoryDepository` changes the tree will revalidate itself if there is a category root set.
`CategoryViewFilter`	`getCategoryViewFilter()` Property: A filter that can be used to filter out which Categories should be visible in the tree.
`static java.lang.Boolean`	`getCheckedState(PropertyKey key, Category cat)` Returns the checked state of a category.
`PropertyKey`	`getCheckSelectedKey()` Property: This is the key used to set in the `Category` a `Boolean` object denoting on if the check is concidered selected or not.
`java.util.List`	`getDecorators()` Returns a cloned list with the decorators currently installed in this tree.
`DemoDataBean`	`getDemoDataBean()` Property: A reference to a demo data bean that creates demo category data for this bean.
`java.awt.Paint`	`getFolderBackground()` Property: The anti alias hint for the label text.
`java.awt.Paint`	`getFolderCheckBackground()` Property: The paint to use for the background of the check.
`java.awt.Cursor`	`getFolderCheckCursor()` Property: The cursor for when the mouse is over the check.
`java.awt.Paint`	`getFolderCheckForeground()` Property: The paint to use for the foreground of the check.
`XtdImage`	`getFolderCheckHalfSelectedIcon()` Property: The icon for when a check is "half" selected, which menas that some children are checked and some are not.
`PlaceRect`	`getFolderCheckIconPlaceRect()` Property: Where in the check shape the icon of the actual check should be placed.
`java.awt.Paint`	`getFolderCheckMouseOverBackground()` Property: The paint to use for the background of the check when the mouse is hovering over it.
`java.awt.Paint`	`getFolderCheckMouseOverForeground()` Property: The paint to use for the foreground of the check when the mouse is hovering over it.
`PlaceRect`	`getFolderCheckPlaceRect()` Property: Where the check outline should be placed within the node.
`XtdImage`	`getFolderCheckSelectedIcon()` Property: The selected check icon.
`java.awt.Shape`	`getFolderCheckShape()` Property: The shape outline of the check box.
`int`	`getFolderCheckWidth()` Property: The width in pixels for the check.
`java.awt.Font`	`getFolderFont()` Property: The font used to draw the label.
`java.awt.Color`	`getFolderForeground()` Property: The foreground color used to draw the label.
`int`	`getFolderIconTextGap()` Property: The gap in pixels between the icon and text.
`java.awt.Cursor`	`getFolderLabelCursor()` Property: The hover mouse cursor over the label.
`java.awt.Paint`	`getFolderMouseOverBackground()` Property: Background paint when the mouse is hovering over the node.
`java.awt.Font`	`getFolderMouseOverFont()` Property: The font when the mouse is hovering over the node.
`java.awt.Color`	`getFolderMouseOverForeground()` Property: Foreground paint when the mouse is hovering over the node.
`java.lang.Integer`	`getFolderMouseOverUnderline()` Property: The underline width.
`int`	`getFolderRowHeight()` Property: The height in pixels for every row in the tree.
`java.awt.Paint`	`getFolderSelectedBackground()` Property: The background if the node label is selected.
`java.awt.Font`	`getFolderSelectedFont()` Property: The font if the node label is selected.
`java.awt.Color`	`getFolderSelectedForeground()` Property: The foreground if the node label is selected.
`java.lang.Integer`	`getFolderSelectedUnderline()` Property: The underline width if the node label is selected.
`java.lang.Integer`	`getFolderUnderline()` Property: The underline width in pixels.
`PropertyKey`	`getLabelSelectedKey()` Property: This is the key used to set in the `Category` a `Boolean` object denoting on if the label is concidered selected or not.
`java.awt.Paint`	`getLeafBackground()` Property: The background paint of the node.
`java.awt.Paint`	`getLeafCheckBackground()` Property: The paint to use for the background of the check.
`java.awt.Cursor`	`getLeafCheckCursor()` Property: The cursor set when the mouse is hovering over the check.
`java.awt.Paint`	`getLeafCheckForeground()` Property: The paint to use for the foreground of the check.
`XtdImage`	`getLeafCheckHalfSelectedIcon()` Property: The icon for when a check is "half" selected, which menas that some children are checked and some are not.
`PlaceRect`	`getLeafCheckIconPlaceRect()` Property: Where in the check shape the icon of the actual check should be placed.
`java.awt.Paint`	`getLeafCheckMouseOverBackground()` Property: The background for when the mouse is hovering over the check.
`java.awt.Paint`	`getLeafCheckMouseOverForeground()` Property: The foreground for when the mouse is hovering over the check.
`PlaceRect`	`getLeafCheckPlaceRect()` Property: Where the check outline should be placed within the node.
`XtdImage`	`getLeafCheckSelectedIcon()` Property: The icon/image for when the check is selected.
`java.awt.Shape`	`getLeafCheckShape()` Property: The shape outline of the check box.
`int`	`getLeafCheckWidth()` Property: The width in pixels for the check.
`java.awt.Font`	`getLeafFont()` Property: The font of the label.
`java.awt.Color`	`getLeafForeground()` Property: The foreground of the label.
`int`	`getLeafIconTextGap()` Property: The gap in pixels between the icon and text.
`java.awt.Cursor`	`getLeafLabelCursor()` Property: The cursor for when the mouse is hovering over the label.
`java.awt.Paint`	`getLeafMouseOverBackground()` Property: The background for when the mouse is hovering over the label.
`java.awt.Font`	`getLeafMouseOverFont()` Property: The font for when the mouse is hovering over the label.
`java.awt.Color`	`getLeafMouseOverForeground()` Property: The foreground for when the mouse is hovering over the label.
`java.lang.Integer`	`getLeafMouseOverUnderline()` Property: The underline in pixels for when the mouse is hovering over the label.
`int`	`getLeafRowHeight()` Property: The height in pixels for every row in the tree.
`java.awt.Paint`	`getLeafSelectedBackground()` Property: The background if the node label is selected.
`java.awt.Font`	`getLeafSelectedFont()` Property: The font if the node label is selected.
`java.awt.Color`	`getLeafSelectedForeground()` Property: The foreground if the node label is selected.
`java.lang.Integer`	`getLeafSelectedUnderline()` Property: The underline in pixels if the node label is selected.
`java.lang.Integer`	`getLeafUnderline()` Property: The underline width in pixels.
`java.awt.Dimension`	`getPreferredSize()`
`java.lang.Object`	`getRootCategoryId()` Returns the category ID of the root node.
`javax.swing.JScrollPane`	`getScrollPane()` Returns the scroll panel that is used to show the category tree.
`boolean`	`getShowsRootHandles()` Property: If the root handles should be visible.
`javax.swing.JTree`	`getTree()` Returns the JTree that is the backing component for this tree bean.
`void`	`interactionOccured(InteractionEvent e)` Called when an interaction has occured
`boolean`	`isFolderCheckSelectable()` Property: If the check can be selected.
`boolean`	`isFolderCheckVisible()` Property: If the check box is visible.
`boolean`	`isFolderLabelSelectable()` Property: If the label should be selectable (press-able)
`boolean`	`isFolderRouteLabelClickToCheck()` Property: If a click on the label should be transformed to a click on the check.
`boolean`	`isIgnoreInteractionEvents()` Returns if events are currently ignored.
`boolean`	`isLeafCheckSelectable()` Property: If the check should be selectable.
`boolean`	`isLeafCheckVisible()` Property: If the check box is visible.
`boolean`	`isLeafLabelSelectable()` Property: If the label should be selectable.
`boolean`	`isLeafRouteLabelClickToCheck()` Property: If a click on the label should be transformed to a click on the check.
`boolean`	`isRootVisible()` Property: If the root node should be visible.
`protected void`	`paintComponent(java.awt.Graphics g)`
`boolean`	`removeDecorator(java.lang.Class type, boolean inclSubClasses)` Removes the first decorator found with the class type `type`, including sub types id `inclSubClasses == true`.
`void`	`removeDecorator(Decorator decorator)` Removes a decorator.
`void`	`removeDecorators()` Removes all decorators.
`void`	`removeDecorators(java.util.Collection decorators)` Removes all decorators
`void`	`removeInteractionListener(InteractionListener l)` Removes the listener if it is added.
`void`	`removeNotify()`
`void`	`revalidateNodes(java.lang.Object fromCatId, boolean keepExpanded)` Revalidate the nodes starting from `fromCatId`.
`void`	`setAntiAliasHint(int hint)` Property: The anti alias hint for the label text.
`void`	`setBackgroundPaint(java.awt.Paint bgPaint)` Sets the background paint.
`void`	`setCategoryAutoRevalidate(boolean b)` Property: If the categories in the `CategoryDepository` changes the tree will revalidate itself if there is a category root set.
`void`	`setCategoryViewFilter(CategoryViewFilter filter)` Property: A filter that can be used to filter out which Categories should be visible in the tree.
`static void`	`setCheckedState(PropertyKey key, Category cat, boolean b)` Set the selected state for the category.
`void`	`setCheckSelectedKey(PropertyKey key)` Property: This is the key used to set in the `Category` a `Boolean` object denoting on if the check is concidered selected or not.
`void`	`setDecorators(java.util.Collection decorators)` Sets the decorators to use.
`void`	`setDemoDataBean(DemoDataBean b)` Property: A reference to a demo data bean that creates demo category data for this bean.
`void`	`setFolderBackground(java.awt.Paint p)` Property: The anti alias hint for the label text.
`void`	`setFolderCheckBackground(java.awt.Paint p)` Property: The paint to use for the background of the check.
`void`	`setFolderCheckCursor(java.awt.Cursor cur)` Property: The cursor for when the mouse is over the check.
`void`	`setFolderCheckForeground(java.awt.Paint p)` Property: The paint to use for the foreground of the check.
`void`	`setFolderCheckHalfSelectedIcon(XtdImage image)` Property: The icon for when a check is "half" selected, which menas that some children are checked and some are not.
`void`	`setFolderCheckIconPlaceRect(PlaceRect r)` Property: Where in the check shape the icon of the actual check should be placed.
`void`	`setFolderCheckMouseOverBackground(java.awt.Paint p)` Property: The paint to use for the background of the check when the mouse is hovering over it.
`void`	`setFolderCheckMouseOverForeground(java.awt.Paint p)` Property: The paint to use for the foreground of the check when the mouse is hovering over it.
`void`	`setFolderCheckPlaceRect(PlaceRect r)` Property: Where the check outline should be placed within the node.
`void`	`setFolderCheckSelectable(boolean b)` Property: If the check can be selected.
`void`	`setFolderCheckSelectedIcon(XtdImage image)` Property: The selected check icon.
`void`	`setFolderCheckShape(java.awt.Shape s)` Property: The shape outline of the check box.
`void`	`setFolderCheckVisible(boolean b)` Property: If the check box is visible.
`void`	`setFolderCheckWidth(int w)` Property: The width in pixels for the check.
`void`	`setFolderFont(java.awt.Font f)` Property: The font used to draw the label.
`void`	`setFolderForeground(java.awt.Color c)` Property: The foreground color used to draw the label.
`void`	`setFolderIconTextGap(int gap)` Property: The gap in pixels between the icon and text.
`void`	`setFolderLabelCursor(java.awt.Cursor cur)` Property: The hover mouse cursor over the label.
`void`	`setFolderLabelSelectable(boolean b)` Property: If the label should be selectable (press-able)
`void`	`setFolderMouseOverBackground(java.awt.Paint p)` Property: Background paint when the mouse is hovering over the node.
`void`	`setFolderMouseOverFont(java.awt.Font f)` Property: The font when the mouse is hovering over the node.
`void`	`setFolderMouseOverForeground(java.awt.Color c)` Property: Foreground paint when the mouse is hovering over the node.
`void`	`setFolderMouseOverUnderline(java.lang.Integer b)` Property: The underline width.
`void`	`setFolderRouteLabelClickToCheck(boolean b)` Property: If a click on the label should be transformed to a click on the check.
`void`	`setFolderRowHeight(int height)` Property: The height in pixels for every row in the tree.
`void`	`setFolderSelectedBackground(java.awt.Paint p)` Property: The background if the node label is selected.
`void`	`setFolderSelectedFont(java.awt.Font f)` Property: The font if the node label is selected.
`void`	`setFolderSelectedForeground(java.awt.Color c)` Property: The foreground if the node label is selected.
`void`	`setFolderSelectedUnderline(java.lang.Integer width)` Property: The underline width if the node label is selected.
`void`	`setFolderUnderline(java.lang.Integer b)` Property: The underline width in pixels.
`boolean`	`setIgnoreInteractionEvents(boolean b)` Sets if events should be ignored, and thus not fired.
`void`	`setLabelSelectedKey(PropertyKey key)` Property: This is the key used to set in the `Category` a `Boolean` object denoting on if the label is concidered selected or not.
`void`	`setLeafBackground(java.awt.Paint p)` Property: The background paint of the node.
`void`	`setLeafCheckBackground(java.awt.Paint p)` Property: The paint to use for the background of the check.
`void`	`setLeafCheckCursor(java.awt.Cursor cur)` Property: The cursor set when the mouse is hovering over the check.
`void`	`setLeafCheckForeground(java.awt.Paint p)` Property: The paint to use for the foreground of the check.
`void`	`setLeafCheckHalfSelectedIcon(XtdImage image)` Property: The icon for when a check is "half" selected, which menas that some children are checked and some are not.
`void`	`setLeafCheckIconPlaceRect(PlaceRect r)` Property: Where in the check shape the icon of the actual check should be placed.
`void`	`setLeafCheckMouseOverBackground(java.awt.Paint p)` Property: The background for when the mouse is hovering over the check.
`void`	`setLeafCheckMouseOverForeground(java.awt.Paint p)` Property: The foreground for when the mouse is hovering over the check.
`void`	`setLeafCheckPlaceRect(PlaceRect r)` Property: Where the check outline should be placed within the node.
`void`	`setLeafCheckSelectable(boolean b)` Property: If the check should be selectable.
`void`	`setLeafCheckSelectedIcon(XtdImage image)` Property: The icon/image for when the check is selected.
`void`	`setLeafCheckShape(java.awt.Shape s)` Property: The shape outline of the check box.
`void`	`setLeafCheckVisible(boolean b)` Property: If the check box is visible.
`void`	`setLeafCheckWidth(int w)` Property: The width in pixels for the check.
`void`	`setLeafFont(java.awt.Font f)` Property: The font of the label.
`void`	`setLeafForeground(java.awt.Color c)` Property: The foreground of the label.
`void`	`setLeafIconTextGap(int gap)` Property: The gap in pixels between the icon and text.
`void`	`setLeafLabelCursor(java.awt.Cursor cur)` Property: The cursor for when the mouse is hovering over the label.
`void`	`setLeafLabelSelectable(boolean b)` Property: If the label should be selectable.
`void`	`setLeafMouseOverBackground(java.awt.Paint p)` Property: The background for when the mouse is hovering over the label.
`void`	`setLeafMouseOverFont(java.awt.Font f)` Property: The font for when the mouse is hovering over the label.
`void`	`setLeafMouseOverForeground(java.awt.Color c)` Property: The foreground for when the mouse is hovering over the label.
`void`	`setLeafMouseOverUnderline(java.lang.Integer b)` Property: The underline in pixels for when the mouse is hovering over the label.
`void`	`setLeafRouteLabelClickToCheck(boolean b)` Property: If a click on the label should be transformed to a click on the check.
`void`	`setLeafRowHeight(int height)` Property: The height in pixels for every row in the tree.
`void`	`setLeafSelectedBackground(java.awt.Paint p)` Property: The background if the node label is selected.
`void`	`setLeafSelectedFont(java.awt.Font f)` Property: The font if the node label is selected.
`void`	`setLeafSelectedForeground(java.awt.Color c)` Property: The foreground if the node label is selected.
`void`	`setLeafSelectedUnderline(java.lang.Integer width)` Property: The underline in pixels if the node label is selected.
`void`	`setLeafUnderline(java.lang.Integer b)` Property: The underline width in pixels.
`void`	`setPreferredSize(java.awt.Dimension preferredSize)`
`void`	`setRootCategoryId(java.lang.Object catIDRoot)` Sets the category ID of the root node.
`void`	`setRootVisible(boolean b)` Property: If the root node should be visible.
`void`	`setShowsRootHandles(boolean b)` Property: If the root handles should be visible.
`void`	`sortDecorators()` Resort the decorators that this tree handles.
`static void`	`toggleCheckedState(PropertyKey key, Category cat)` Toggles the checked state on the category.

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

Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, 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.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.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

LABEL_SELECTED_KEY

public static final PropertyKey LABEL_SELECTED_KEY

This is the default key used to set in the Category a Boolean object denoting if the label is concidered selected or not. It can also be set on a tree by tree basis using setLabelSelectedKey(com.miginfocom.util.PropertyKey).

CHECK_SELECTED_KEY

public static final PropertyKey CHECK_SELECTED_KEY

This is the default key used to set in the Category a Boolean object denoting if the check box is concidered selected or not. It can also be set on a tree by tree basis using setCheckSelectedKey(com.miginfocom.util.PropertyKey).

LABEL_CLICKED

public static final java.lang.String LABEL_CLICKED

The Command Value in for the InteractionEvent that is fired when the label is clicked.

See Also:: Constant Field Values

CHECK_CLICKED

public static final java.lang.String CHECK_CLICKED

The Command Value in for the InteractionEvent that is fired when the label is clicked.

See Also:: Constant Field Values

ROOT_SHAPE_NAME

public static final java.lang.String ROOT_SHAPE_NAME

See Also:: Constant Field Values

FOLDER_CHECK_BACKGROUND_SHAPE_NAME

public static final java.lang.String FOLDER_CHECK_BACKGROUND_SHAPE_NAME

See Also:: Constant Field Values

FOLDER_CHECK_OUTLINE_SHAPE_NAME

public static final java.lang.String FOLDER_CHECK_OUTLINE_SHAPE_NAME

See Also:: Constant Field Values

FOLDER_CHECK_IMAGE_SHAPE_NAME

public static final java.lang.String FOLDER_CHECK_IMAGE_SHAPE_NAME

See Also:: Constant Field Values

FOLDER_LABEL_SHAPE_NAME

public static final java.lang.String FOLDER_LABEL_SHAPE_NAME

See Also:: Constant Field Values

FOLDER_CONTAINER_SHAPE_NAME

public static final java.lang.String FOLDER_CONTAINER_SHAPE_NAME

See Also:: Constant Field Values

LEAF_CHECK_BACKGROUND_SHAPE_NAME

public static final java.lang.String LEAF_CHECK_BACKGROUND_SHAPE_NAME

See Also:: Constant Field Values

LEAF_CHECK_OUTLINE_SHAPE_NAME

public static final java.lang.String LEAF_CHECK_OUTLINE_SHAPE_NAME

See Also:: Constant Field Values

LEAF_CHECK_IMAGE_SHAPE_NAME

public static final java.lang.String LEAF_CHECK_IMAGE_SHAPE_NAME

See Also:: Constant Field Values

LEAF_LABEL_SHAPE_NAME

public static final java.lang.String LEAF_LABEL_SHAPE_NAME

See Also:: Constant Field Values

LEAF_CONTAINER_SHAPE_NAME

public static final java.lang.String LEAF_CONTAINER_SHAPE_NAME

See Also:: Constant Field Values

Constructor Detail

CategoryTreeBean

public CategoryTreeBean()

Method Detail

paintComponent

protected void paintComponent(java.awt.Graphics g)

Overrides:: paintComponent in class javax.swing.JComponent

addNotify

public void addNotify()

Overrides:: addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()

Overrides:: removeNotify in class javax.swing.JComponent

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:: getPreferredSize in class javax.swing.JComponent

setPreferredSize

public void setPreferredSize(java.awt.Dimension preferredSize)

Overrides:: setPreferredSize in class javax.swing.JComponent

getTree

public javax.swing.JTree getTree()

Returns the JTree that is the backing component for this tree bean.

Returns:: The JTree that is the backing component for this tree bean.

getCategoryAtLocation

public Category getCategoryAtLocation(int x,
                                      int y)

A hit test that returns the Category for a point.

Parameters:: x - The x value that is relative to the contained tree.; y - The y value that is relative to the contained tree.
Returns:: The Category or null if no hit.

getScrollPane

public javax.swing.JScrollPane getScrollPane()

Returns the scroll panel that is used to show the category tree.

Returns:: The scroll panel that is used to show the category tree. Never null.

getCategoryViewFilter

public CategoryViewFilter getCategoryViewFilter()

Property: A filter that can be used to filter out which Categories should be visible in the tree.

Returns:: The current filter. null if no filter.

setCategoryViewFilter

public void setCategoryViewFilter(CategoryViewFilter filter)

Property: A filter that can be used to filter out which Categories should be visible in the tree.

Parameters:: filter - The new filter. null if no filter.

getBackgroundPaint

public java.awt.Paint getBackgroundPaint()

Sets the background paint. If != null this paint is drawn in the background (if opaque) rather than the normal background color. If this is null the normal color retrieved from Component.getBackground() is painted instead. If not opaque none of the colors will be painted.

Returns:: The background paint. May be null.

setBackgroundPaint

public void setBackgroundPaint(java.awt.Paint bgPaint)

Parameters:: bgPaint - The background paint. May be null.

getCategoryAutoRevalidate

public boolean getCategoryAutoRevalidate()

Property: If the categories in the CategoryDepository changes the tree will revalidate itself if there is a category root set.

Returns:: If the auto revalidation is on.

setCategoryAutoRevalidate

public void setCategoryAutoRevalidate(boolean b)

Property: If the categories in the CategoryDepository changes the tree will revalidate itself if there is a category root set.

Parameters:: b - If the auto revalidation is on.

getLabelSelectedKey

public PropertyKey getLabelSelectedKey()

Property: This is the key used to set in the Category a Boolean object denoting on if the label is concidered selected or not.

The key defaults to LABEL_SELECTED_KEY but using that means that all category trees will have the same model state for a category, which is sometime wanted and sometimes not.

Returns:: The current key. Never null.

setLabelSelectedKey

public void setLabelSelectedKey(PropertyKey key)

Property: This is the key used to set in the Category a Boolean object denoting on if the label is concidered selected or not.

The key defaults to LABEL_SELECTED_KEY but using that means that all category trees will have the same model state for a category, which is sometime wanted and sometimes not.

Parameters:: key - The new key. null will reset it to the default value.

getCheckSelectedKey

public PropertyKey getCheckSelectedKey()

Property: This is the key used to set in the Category a Boolean object denoting on if the check is concidered selected or not.

The key defaults to CHECK_SELECTED_KEY but using that means that all category trees will have the same model state for a category, which is sometime wanted and sometimes not.

Returns:: The current key. Never null.

setCheckSelectedKey

public void setCheckSelectedKey(PropertyKey key)

Property: This is the key used to set in the Category a Boolean object denoting on if the check is concidered selected or not.

The key defaults to CHECK_SELECTED_KEY but using that means that all category trees will have the same model state for a category, which is sometime wanted and sometimes not.

Parameters:: key - The new key. null will reset it to the default value.

getDemoDataBean

public DemoDataBean getDemoDataBean()

Property: A reference to a demo data bean that creates demo category data for this bean. This is normally only used for testing purposes and should not be used in any production environment.

Returns:: The current value of the property or null.

setDemoDataBean

public void setDemoDataBean(DemoDataBean b)

Property: A reference to a demo data bean that creates demo category data for this bean. This is normally only used for testing purposes and should not be used in any production environment.

Parameters:: b - The new value for the property. May be null.

isLeafRouteLabelClickToCheck

public boolean isLeafRouteLabelClickToCheck()

Property: If a click on the label should be transformed to a click on the check.

Returns:: The current value. Default is false.

setLeafRouteLabelClickToCheck

public void setLeafRouteLabelClickToCheck(boolean b)

Property: If a click on the label should be transformed to a click on the check.

Parameters:: b - The new value. Default is false.

isFolderRouteLabelClickToCheck

public boolean isFolderRouteLabelClickToCheck()

Property: If a click on the label should be transformed to a click on the check.

Returns:: The current value. Default is false.

setFolderRouteLabelClickToCheck

public void setFolderRouteLabelClickToCheck(boolean b)

Property: If a click on the label should be transformed to a click on the check.

Parameters:: b - The new value. Default is false.

isLeafCheckVisible

public boolean isLeafCheckVisible()

Property: If the check box is visible.

Returns:: The current value. Default is true.

setLeafCheckVisible

public void setLeafCheckVisible(boolean b)

Property: If the check box is visible.

Parameters:: b - The new value. Default is true.

isFolderCheckVisible

public boolean isFolderCheckVisible()

Property: If the check box is visible.

Returns:: The current value. Default is true.

setFolderCheckVisible

public void setFolderCheckVisible(boolean b)

Property: If the check box is visible.

Parameters:: b - The new value. Default is true.

getLeafRowHeight

public int getLeafRowHeight()

Property: The height in pixels for every row in the tree.

Returns:: The current value. Default is 17.

setLeafRowHeight

public void setLeafRowHeight(int height)

Property: The height in pixels for every row in the tree.

Parameters:: height - The new value. Default is 17.

getFolderRowHeight

public int getFolderRowHeight()

Property: The height in pixels for every row in the tree.

Returns:: The current value. Default is 17.

setFolderRowHeight

public void setFolderRowHeight(int height)

Property: The height in pixels for every row in the tree.

Parameters:: height - The new value. Default is 17.

getShowsRootHandles

public boolean getShowsRootHandles()

Property: If the root handles should be visible.

Returns:: The current value. Default is true.

setShowsRootHandles

public void setShowsRootHandles(boolean b)

Property: If the root handles should be visible.

Parameters:: b - The new value. Default is true.

getLeafCheckShape

public java.awt.Shape getLeafCheckShape()

Property: The shape outline of the check box.

Returns:: The current value. Default is new RoundRectangle(0, 0, 14, 14, 6, 6).

setLeafCheckShape

public void setLeafCheckShape(java.awt.Shape s)

Property: The shape outline of the check box.

Parameters:: s - The new value. Default is new RoundRectangle(0, 0, 14, 14, 6, 6).

getFolderCheckShape

public java.awt.Shape getFolderCheckShape()

Property: The shape outline of the check box.

Returns:: The current value. Default is new RoundRectangle(0, 0, 14, 14, 6, 6).

setFolderCheckShape

public void setFolderCheckShape(java.awt.Shape s)

Property: The shape outline of the check box.

Parameters:: s - The new value. Default is new RoundRectangle(0, 0, 14, 14, 6, 6).

getLeafCheckIconPlaceRect

public PlaceRect getLeafCheckIconPlaceRect()

Property: Where in the check shape the icon of the actual check should be placed.

Returns:: The current value. Default is new AlignRect(new AtFraction(0.5f), new AtFraction(0.5f)).

setLeafCheckIconPlaceRect

public void setLeafCheckIconPlaceRect(PlaceRect r)

Property: Where in the check shape the icon of the actual check should be placed.

Parameters:: r - The new value. Default is new AlignRect(new AtFraction(0.5f), new AtFraction(0.5f)).

getFolderCheckIconPlaceRect

public PlaceRect getFolderCheckIconPlaceRect()

Property: Where in the check shape the icon of the actual check should be placed.

Returns:: The current value. Default is new AlignRect(new AtFraction(0.5f), new AtFraction(0.5f)).

setFolderCheckIconPlaceRect

public void setFolderCheckIconPlaceRect(PlaceRect r)

Property: Where in the check shape the icon of the actual check should be placed.

Parameters:: r - The new value. Default is new AlignRect(new AtFraction(0.5f), new AtFraction(0.5f)).

getLeafCheckPlaceRect

public PlaceRect getLeafCheckPlaceRect()

Property: Where the check outline should be placed within the node.

Returns:: The current value. Default is new AbsRect(new Insets(1, 1, 1, 1)).

setLeafCheckPlaceRect

public void setLeafCheckPlaceRect(PlaceRect r)

Property: Where the check outline should be placed within the node.

Parameters:: r - The new value. Default is new AbsRect(new Insets(1, 1, 1, 1)).

com.miginfocom.beans Class CategoryTreeBean

LABEL_SELECTED_KEY

CHECK_SELECTED_KEY

LABEL_CLICKED

CHECK_CLICKED

ROOT_SHAPE_NAME

FOLDER_CHECK_BACKGROUND_SHAPE_NAME

FOLDER_CHECK_OUTLINE_SHAPE_NAME

FOLDER_CHECK_IMAGE_SHAPE_NAME

FOLDER_LABEL_SHAPE_NAME

FOLDER_CONTAINER_SHAPE_NAME

LEAF_CHECK_BACKGROUND_SHAPE_NAME

LEAF_CHECK_OUTLINE_SHAPE_NAME

LEAF_CHECK_IMAGE_SHAPE_NAME

LEAF_LABEL_SHAPE_NAME

LEAF_CONTAINER_SHAPE_NAME

CategoryTreeBean

paintComponent

addNotify

removeNotify

getPreferredSize

setPreferredSize

getTree

getCategoryAtLocation

getScrollPane

getCategoryViewFilter

setCategoryViewFilter

getBackgroundPaint

setBackgroundPaint

getCategoryAutoRevalidate

setCategoryAutoRevalidate

getLabelSelectedKey

setLabelSelectedKey

getCheckSelectedKey

setCheckSelectedKey

getDemoDataBean

setDemoDataBean

isLeafRouteLabelClickToCheck

setLeafRouteLabelClickToCheck

isFolderRouteLabelClickToCheck

setFolderRouteLabelClickToCheck

isLeafCheckVisible

setLeafCheckVisible

isFolderCheckVisible

setFolderCheckVisible

getLeafRowHeight

setLeafRowHeight

getFolderRowHeight

setFolderRowHeight

getShowsRootHandles

setShowsRootHandles

getLeafCheckShape

setLeafCheckShape

getFolderCheckShape

setFolderCheckShape

getLeafCheckIconPlaceRect

setLeafCheckIconPlaceRect

getFolderCheckIconPlaceRect

setFolderCheckIconPlaceRect

getLeafCheckPlaceRect

setLeafCheckPlaceRect

com.miginfocom.beans
Class CategoryTreeBean