|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JTree
org.openbp.guiclient.model.item.itemtree.ItemTree
public class ItemTree
The item browser displays the models of the system and their items in a tree structure.
It supports dragging an item (e. g. onto the workspace).
The items can be filtered by the installed item filters (currently item type and
item text filter). The filter components (used to adjust the filters) are shown
in a panel above the tree and can be turned on and off using the item filter buttons
in the plugin's toolbar.
| Nested Class Summary | |
|---|---|
class |
ItemTree.GroupNode
Tree node representing an item group. |
class |
ItemTree.ItemNode
Tree node representing an item. |
class |
ItemTree.ItemTreeNode
Tree node representing a model. |
class |
ItemTree.ModelNode
Tree node representing a model. |
class |
ItemTree.ModelObjectNode
Tree node representing a model object (model, item, node etc\.). |
| Nested classes/interfaces inherited from class 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 |
| 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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
protected javax.swing.event.EventListenerList |
listenerList
List containing all item tree listeners. |
static int |
SELECTION_MULTI
Multiple selection |
static int |
SELECTION_NONE
No selection |
static int |
SELECTION_SINGLE
Single selection |
| Fields inherited from class 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 |
| Fields inherited from class javax.swing.JComponent |
|---|
accessibleContext, 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 | |
|---|---|
ItemTree()
Default constructor. |
|
| Method Summary | |
|---|---|
void |
addItemTreeListener(ItemTreeListener listener)
Adds an item tree listener. |
void |
applyFilter(ItemFilterMgr mgr,
ItemFilter filter)
Called if the current item filter settings have changed, i\.e\. the item filters should be (re-)applied. |
javax.swing.tree.TreePath |
determineAlternativeSelection()
Returns the tree path of the element that should be selected if the currently selected element is deleted. |
Model |
determineSelectedModel()
Gets the model that owns the currently selected object. |
void |
expand(int level)
Expands the tree up to the desired level. |
ItemTree.ItemTreeNode |
findNodeByObject(java.lang.Object object)
Finds a tree node by the object it refers to. |
ItemTree.ItemTreeNode |
findNodeByObject(java.lang.Object object,
ItemTree.ItemTreeNode node)
Finds a tree node by the object it refers to, starting at the given tree node. |
ItemTree.ItemTreeNode |
findNodeByQualifier(ModelQualifier qualifier)
Finds a tree node by the model qualifier of the object it refers to. |
ItemTree.ItemTreeNode |
findNodeByQualifier(ModelQualifier qualifier,
ItemTree.ItemTreeNode node)
Finds a tree node by the model qualifier of the object it refers to, starting at the given tree node. |
javax.swing.tree.TreePath |
findPathByObject(java.lang.Object o)
Gets the path to the node representing the given object. |
void |
fireItemTreeEvent(ItemTreeEvent e)
Notifies all registered item tree listeners of the given item tree event. |
ItemFilterMgr |
getFilterMgr()
Gets the item filter manager. |
ItemTypeFilter |
getItemTypeFilter()
Gets the item type filter. |
ModelObject |
getRootObject()
Gets the the root object of the item tree or null for the root of the model tree. |
java.lang.String[] |
getSelectableItemTypes()
Gets the item types selectable by the user (null if no item types selectable). |
java.lang.Class[] |
getSelectableObjectClasses()
Gets the model object classes selectable by the user (null if no model objects selectable). |
java.util.List |
getSelectedObjects()
Gets the currently selected objects. |
int |
getSelectionMode()
Gets the selection mode. |
java.lang.String[] |
getSupportedItemTypes()
Gets the item types supported by this browser (null for the standard item types). |
java.lang.Class[] |
getSupportedObjectClasses()
Gets the model object classes supported by this item browser (null if no model objects displayed). |
TreeExpander |
getTreeExpander()
Gets the auto-expander of the item tree. |
protected boolean |
isSelectable(ModelObject o)
Determines if the given object is selectable by the user. |
boolean |
isShowGroups()
Gets the group display flag. |
protected boolean |
isSupported(ModelObject o)
Determines if the given object is supported (i\.e\. should be displayed) by this item tree. |
void |
performAlternativeSelection()
Selects the element that should be selected if the currently selected element is deleted. |
void |
rebuildTree()
Rebuilds the model/item tree. |
void |
removeItemTreeListener(ItemTreeListener listener)
Removes an item tree listener. |
void |
restoreState(ItemTreeState state)
Restores the state of the item tree. |
ItemTreeState |
saveState()
Saves the state of the item tree. |
void |
setFilterMgr(ItemFilterMgr filterMgr)
Sets the item filter manager. |
void |
setItemTypeFilter(ItemTypeFilter itemTypeFilter)
Sets the item type filter. |
void |
setRootObject(ModelObject rootObject)
Sets the the root object of the item tree or null for the root of the model tree. |
void |
setSelectableItemTypes(java.lang.String[] selectableItemTypes)
Sets the item types selectable by the user (null if no item types selectable). |
void |
setSelectableObjectClasses(java.lang.Class[] selectableObjectClasses)
Sets the model object classes selectable by the user (null if no model objects selectable). |
void |
setSelectedObjects(java.util.List objects)
Selects the given objects. |
void |
setSelectionMode(int selectionMode)
Sets the selection mode. |
void |
setShowGroups(boolean showGroups)
Sets the group display flag. |
void |
setSupportedItemTypes(java.lang.String[] supportedItemTypes)
Sets the item types supported by this browser (null for the standard tem types). |
void |
setSupportedObjectClasses(java.lang.Class[] supportedObjectClasses)
Sets the model object classes supported by this item browser (null if no model objects displayed). |
| Methods inherited from class 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, getCellRenderer, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getNextMatch, 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, setModel, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, treeDidChange, 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, 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, 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, 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 |
|---|
public static final int SELECTION_NONE
public static final int SELECTION_SINGLE
public static final int SELECTION_MULTI
protected javax.swing.event.EventListenerList listenerList
| Constructor Detail |
|---|
public ItemTree()
| Method Detail |
|---|
public void rebuildTree()
public ItemTreeState saveState()
public void restoreState(ItemTreeState state)
state - State to restorepublic void expand(int level)
level - Maximum level to displaypublic TreeExpander getTreeExpander()
public Model determineSelectedModel()
public java.util.List getSelectedObjects()
ModelObject s.setSelectableItemTypes(java.lang.String[]) method or objects of
the model object classes set by the setSelectableObjectClasses(java.lang.Class[]) method.public void setSelectedObjects(java.util.List objects)
rebuildTree() method.
objects - A list of ModelObject s or nullpublic void performAlternativeSelection()
public javax.swing.tree.TreePath determineAlternativeSelection()
public ItemTree.ItemTreeNode findNodeByObject(java.lang.Object object)
object - Object to search (usually a ModelObject)
public ItemTree.ItemTreeNode findNodeByObject(java.lang.Object object,
ItemTree.ItemTreeNode node)
object - Object to search (usually a ModelObject)node - Node to start the search from
public ItemTree.ItemTreeNode findNodeByQualifier(ModelQualifier qualifier)
qualifier - Themodel qualifier
public ItemTree.ItemTreeNode findNodeByQualifier(ModelQualifier qualifier,
ItemTree.ItemTreeNode node)
qualifier - Themodel qualifiernode - Node to start the search from
public javax.swing.tree.TreePath findPathByObject(java.lang.Object o)
o - Object to search (usually a ModelObject)
public ModelObject getRootObject()
public void setRootObject(ModelObject rootObject)
public java.lang.String[] getSupportedItemTypes()
public void setSupportedItemTypes(java.lang.String[] supportedItemTypes)
public java.lang.String[] getSelectableItemTypes()
public void setSelectableItemTypes(java.lang.String[] selectableItemTypes)
public java.lang.Class[] getSupportedObjectClasses()
public void setSupportedObjectClasses(java.lang.Class[] supportedObjectClasses)
public java.lang.Class[] getSelectableObjectClasses()
public void setSelectableObjectClasses(java.lang.Class[] selectableObjectClasses)
public ItemFilterMgr getFilterMgr()
public void setFilterMgr(ItemFilterMgr filterMgr)
filterMgr - The filter manager or null if not item filters should be usedpublic ItemTypeFilter getItemTypeFilter()
public void setItemTypeFilter(ItemTypeFilter itemTypeFilter)
itemTypeFilter - The filter or null if no item type filter should be used.public boolean isShowGroups()
public void setShowGroups(boolean showGroups)
public int getSelectionMode()
SELECTION_NONE/SELECTION_SINGLE/SELECTION_MULTIpublic void setSelectionMode(int selectionMode)
selectionMode - SELECTION_NONE/SELECTION_SINGLE/SELECTION_MULTIpublic void addItemTreeListener(ItemTreeListener listener)
listener - Listener to addpublic void removeItemTreeListener(ItemTreeListener listener)
listener - Listener to removepublic void fireItemTreeEvent(ItemTreeEvent e)
e - Eventprotected boolean isSupported(ModelObject o)
o - Object to check
setSupportedItemTypes(java.lang.String[]) method or one of the model object classes set by the setSupportedObjectClasses(java.lang.Class[]) method.protected boolean isSelectable(ModelObject o)
o - Object to check
setSelectableItemTypes(java.lang.String[]) method or one of the model object classes set by the setSelectableObjectClasses(java.lang.Class[]) method.
public void applyFilter(ItemFilterMgr mgr,
ItemFilter filter)
applyFilter in interface ItemFilterListenermgr - Item filter manager that issues the eventfilter - Item filter that has changed or null
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||