Package com.nomagic.magicdraw.ui.browser

Class AbstractTree

  • All Implemented Interfaces:
    java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible
    Direct Known Subclasses:
    Tree
    @OpenApi
public abstract class AbstractTree
extends ExtendedPanel
    The abstract tree used in MagicDraw browser. This class is used as wrapper for Swing JTree. To access actual Swing tree, use method getTree().
    See Also:
    getTree(), 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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean autoExpandMode  
      private CookieSet cookies  
      static int MAX_AUTO_EXPAND_DEPTH
      Max depth for auto expand in case we have very deep or recursive model structure
      private javax.swing.JScrollPane scrollPane  
      private javax.swing.JTree tree  

      • Fields inherited from class javax.swing.JComponent

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

      • Fields inherited from class java.awt.Component

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

      Constructors 
      Constructor Description
      AbstractTree​(javax.swing.JTree tree)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void addMouseListener()  
      void close()
      Closed this tree in the UI.
      private javax.swing.JScrollPane createScrollPane()  
      void dispose()  
      protected void doubleClick​(javax.swing.tree.DefaultMutableTreeNode node, java.awt.event.MouseEvent mouseEvent)
      called on mouse double click on nod.
      private void expandAutoExpandable​(Node child)  
      CookieSet getCookies()  
      javax.swing.tree.DefaultMutableTreeNode getRootNode()
      Returns root node of the tree.
      javax.swing.JScrollPane getScrollPane()  
      javax.swing.JTree getTree()
      Returns wrapped Swing JTree.
      javax.swing.tree.DefaultTreeModel getTreeModel()  
      boolean isAutoExpandMode()  
      void open()
      Activates or opens (if was closed) this tree in the UI.
      void openPath​(javax.swing.tree.TreePath path)
      Open node.
      void openPath​(javax.swing.tree.TreePath path, boolean select, boolean appendSelection, boolean requestFocus)
      Open node.
      void openPath​(javax.swing.tree.TreePath path, boolean select, boolean appendSelection, boolean requestFocus, boolean scrollToVisible)
      Open node.
      void setAutoExpandMode​(boolean autoExpandMode)
      Sets auto expand mode.
      protected void setTree​(javax.swing.JTree tree)  

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • MAX_AUTO_EXPAND_DEPTH

        public static final int MAX_AUTO_EXPAND_DEPTH
        Max depth for auto expand in case we have very deep or recursive model structure
        See Also:
        Constant Field Values

      • autoExpandMode

        private boolean autoExpandMode

      • tree

        private javax.swing.JTree tree

      • scrollPane

        private final javax.swing.JScrollPane scrollPane

    • Constructor Detail

      • AbstractTree

        public AbstractTree​(javax.swing.JTree tree)

    • Method Detail

      • expandAutoExpandable

        private void expandAutoExpandable​(Node child)

      • getTree

        @OpenApi
public final javax.swing.JTree getTree()
        Returns wrapped Swing JTree.
        Returns:
        wrapped tree.

      • setTree

        protected final void setTree​(javax.swing.JTree tree)

      • getTreeModel

        @CheckForNull
public javax.swing.tree.DefaultTreeModel getTreeModel()

      • getRootNode

        @OpenApi
public javax.swing.tree.DefaultMutableTreeNode getRootNode()
        Returns root node of the tree.
        Returns:
        root node.

      • openPath

        public void openPath​(javax.swing.tree.TreePath path)
        Open node.
        Parameters:
        path - TreePath

      • openPath

        public void openPath​(javax.swing.tree.TreePath path,
                     boolean select,
                     boolean appendSelection,
                     boolean requestFocus)
        Open node.
        Parameters:
        path - TreePath
        select - do we need to select?
        appendSelection - append to old selection or clear old selection
        requestFocus - do we need to request focus?

      • openPath

        public void openPath​(javax.swing.tree.TreePath path,
                     boolean select,
                     boolean appendSelection,
                     boolean requestFocus,
                     boolean scrollToVisible)
        Open node.
        Parameters:
        path - TreePath
        select - do we need to select?
        appendSelection - append to old selection or clear old selection
        requestFocus - do we need to request focus?
        scrollToVisible - do we need to scroll to visible?

      • open

        @OpenApi
public void open()
        Activates or opens (if was closed) this tree in the UI.

      • close

        public void close()
        Closed this tree in the UI.

      • getScrollPane

        public javax.swing.JScrollPane getScrollPane()
        Returns:
        scroll pane of the tree

      • createScrollPane

        private javax.swing.JScrollPane createScrollPane()

      • dispose

        public void dispose()

      • addMouseListener

        private void addMouseListener()

      • doubleClick

        protected void doubleClick​(javax.swing.tree.DefaultMutableTreeNode node,
                           java.awt.event.MouseEvent mouseEvent)
        called on mouse double click on nod.
        Parameters:
        node - node on which double click was called.
        mouseEvent - double click event

      • isAutoExpandMode

        public boolean isAutoExpandMode()
        Returns:
        auto expand mode. If true, nodes with single child are expanded recursively.

      • setAutoExpandMode

        public void setAutoExpandMode​(boolean autoExpandMode)
        Sets auto expand mode. If auto expand, nodes with single child are expanded recursively
        Parameters:
        autoExpandMode - new mode value