Skip navigation links


com.essbase.eas.essbase.ui.outline
Class VTree

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JTree
                  extended by com.essbase.eas.ui.tree.RAFTree
                      extended by com.essbase.eas.essbase.ui.outline.VTree

All Implemented Interfaces:
ExpandCollapseMember, java.awt.event.FocusListener, java.awt.event.HierarchyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.Scrollable

public class VTree
extends RAFTree
implements java.awt.event.HierarchyListener, ExpandCollapseMember, java.awt.event.FocusListener

implements a tree control for the outline viewer.

Version:
1.00, 03/28/2001
Author:
Hank Cox
See Also:
Serialized Form

Nested Class Summary

 

Nested classes/interfaces inherited from class com.essbase.eas.ui.tree.RAFTree
RAFTree.FocusHandler

 

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

 

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, 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
VTree(VTreeModel model)
           

 

Method Summary
 boolean displayMember(Member m)
           
 void dispose()
           
 javax.swing.tree.MutableTreeNode findNodeForMember(Member member)
          Look through the tree for the node corresponding to this member
 javax.swing.tree.MutableTreeNode findNodeForMember(Member member, boolean populate)
           
 javax.swing.tree.MutableTreeNode findNodeForMember(javax.swing.tree.MutableTreeNode node, Member member)
           
 javax.swing.tree.MutableTreeNode findNodeForMember(javax.swing.tree.MutableTreeNode node, Member member, boolean populate)
           
 RAFTreeNode findNodeForMember(RAFTreeNode branch, Member m)
           
 void focusGained(java.awt.event.FocusEvent e)
           
 void focusLost(java.awt.event.FocusEvent e)
           
 VTreePane getExpectedPaneContainer()
           
 VTabbedPane getExpectedTabbedPaneContainer()
           
 Member getMemberForNode(VTreeNode node)
           
 Member getNodeAsMember(javax.swing.tree.MutableTreeNode node)
          Return the Member contained in the tree node
 javax.swing.tree.MutableTreeNode getNodeNextSibling(javax.swing.tree.MutableTreeNode node)
          Locate the next sibling of the specified node
 javax.swing.tree.TreePath getNodePath(javax.swing.tree.MutableTreeNode node)
           
 java.lang.Object getNodeUserObject(javax.swing.tree.MutableTreeNode node)
           
 boolean getPrimaryTree()
          retrieves the primary tree property.
 Representation getRepresentation()
           
 java.lang.String getSelectionAsString(java.lang.Object selection)
           
 javax.swing.tree.MutableTreeNode getStartingNode(boolean entireOutline)
          Locates the tree node that represents a specific member.
 javax.swing.JTree getTree()
           
 void handleRightClick(int x, int y)
           
 void hierarchyChanged(java.awt.event.HierarchyEvent e)
          implementation of the HierarchyListener.hierarchyChanged() method.
 boolean isCollapseAncestorAvailable()
           
 boolean isExpandChildrenAvailable()
           
 boolean isExpandDescendantsAvailable()
           
 boolean isExpandOutlineAvailable()
           
 boolean isPainting()
           
 void paint(java.awt.Graphics g)
           
 void performExpandDescendants()
           
 void performExpandOutline()
           
 void populateContextMenu(javax.swing.JPopupMenu menu)
          populates a context menu.
 void print(CPrintable print, boolean printAll)
           
 void setActive()
           
 void setData(Representation r, Member[] dimensions, ViewerOptions opts)
          sets that data for this list box.
 void setPrimaryTree(boolean value)
          sets the primary tree property.
 void updateChildMembers(VTreeNode tnode, int startIndex)
           
 void willExpand(VTreeNode node)
           

 

Methods inherited from class com.essbase.eas.ui.tree.RAFTree
collapseAncestor, expandBranch, expandChildren, getRAFModel, getRoot, init

 

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, 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

 

Constructor Detail

VTree

public VTree(VTreeModel model)

Method Detail

setData

public void setData(Representation r,
                    Member[] dimensions,
                    ViewerOptions opts)
sets that data for this list box.

willExpand

public void willExpand(VTreeNode node)

getMemberForNode

public Member getMemberForNode(VTreeNode node)

updateChildMembers

public void updateChildMembers(VTreeNode tnode,
                               int startIndex)

getPrimaryTree

public boolean getPrimaryTree()
retrieves the primary tree property.

setPrimaryTree

public void setPrimaryTree(boolean value)
sets the primary tree property.

getExpectedPaneContainer

public VTreePane getExpectedPaneContainer()

getExpectedTabbedPaneContainer

public VTabbedPane getExpectedTabbedPaneContainer()

populateContextMenu

public void populateContextMenu(javax.swing.JPopupMenu menu)
populates a context menu. Does so by calling the VTreePane and VTreeTabbedPane that this VTree resides in. Then adds some menu items itself and calls the code to localize the menu items.

hierarchyChanged

public void hierarchyChanged(java.awt.event.HierarchyEvent e)
implementation of the HierarchyListener.hierarchyChanged() method.
Specified by:
hierarchyChanged in interface java.awt.event.HierarchyListener

print

public void print(CPrintable print,
                  boolean printAll)

isExpandChildrenAvailable

public boolean isExpandChildrenAvailable()

isExpandDescendantsAvailable

public boolean isExpandDescendantsAvailable()

isExpandOutlineAvailable

public boolean isExpandOutlineAvailable()

isCollapseAncestorAvailable

public boolean isCollapseAncestorAvailable()

displayMember

public boolean displayMember(Member m)

getRepresentation

public Representation getRepresentation()

performExpandDescendants

public void performExpandDescendants()

performExpandOutline

public void performExpandOutline()

isPainting

public boolean isPainting()

paint

public void paint(java.awt.Graphics g)
Overrides:
paint in class RAFTree

dispose

public void dispose()
Overrides:
dispose in class RAFTree

getTree

public javax.swing.JTree getTree()
Returns:
reference to this tree

findNodeForMember

public javax.swing.tree.MutableTreeNode findNodeForMember(Member member)
Look through the tree for the node corresponding to this member
Parameters:
node - - the node to start searching from
member - - the member to find
Returns:
the node for the member

findNodeForMember

public javax.swing.tree.MutableTreeNode findNodeForMember(Member member,
                                                          boolean populate)

findNodeForMember

public javax.swing.tree.MutableTreeNode findNodeForMember(javax.swing.tree.MutableTreeNode node,
                                                          Member member)

findNodeForMember

public javax.swing.tree.MutableTreeNode findNodeForMember(javax.swing.tree.MutableTreeNode node,
                                                          Member member,
                                                          boolean populate)

findNodeForMember

public RAFTreeNode findNodeForMember(RAFTreeNode branch,
                                     Member m)

getStartingNode

public javax.swing.tree.MutableTreeNode getStartingNode(boolean entireOutline)
Description copied from interface: ExpandCollapseMember
Locates the tree node that represents a specific member. This find method begins at the root of the tree.
Specified by:
getStartingNode in interface ExpandCollapseMember
Returns:
the tree node representing that member. null if the requested member doesn't exist in the tree.

getNodeNextSibling

public javax.swing.tree.MutableTreeNode getNodeNextSibling(javax.swing.tree.MutableTreeNode node)
Description copied from interface: ExpandCollapseMember
Locate the next sibling of the specified node
Specified by:
getNodeNextSibling in interface ExpandCollapseMember
Parameters:
node - the node representing the branch in the tree to search.
Returns:
the the node that is the next sibling

getNodeAsMember

public Member getNodeAsMember(javax.swing.tree.MutableTreeNode node)
Description copied from interface: ExpandCollapseMember
Return the Member contained in the tree node
Specified by:
getNodeAsMember in interface ExpandCollapseMember
Parameters:
node - the node to return as a member
Returns:
themember of the node

getNodeUserObject

public java.lang.Object getNodeUserObject(javax.swing.tree.MutableTreeNode node)
Specified by:
getNodeUserObject in interface ExpandCollapseMember
Returns:

getNodePath

public javax.swing.tree.TreePath getNodePath(javax.swing.tree.MutableTreeNode node)
Specified by:
getNodePath in interface ExpandCollapseMember
Returns:

getSelectionAsString

public java.lang.String getSelectionAsString(java.lang.Object selection)
Specified by:
getSelectionAsString in interface ExpandCollapseMember
Returns:

focusGained

public void focusGained(java.awt.event.FocusEvent e)
Specified by:
focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent e)
Specified by:
focusLost in interface java.awt.event.FocusListener

setActive

public void setActive()

handleRightClick

public void handleRightClick(int x,
                             int y)

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.