Package com.inductiveautomation.ignition.client.util.gui.tree

Class PanelBasedTreeCellRenderer

    • 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
      protected java.awt.Color backgroundNonSelectionColor
      Color to use for the background when the node isn't selected.
      protected java.awt.Color backgroundSelectionColor
      Color to use for the background when a node is selected.
      protected java.awt.Color borderSelectionColor
      Color to use for the focus indicator when the node has focus.
      protected boolean hasFocus
      True if has focus.
      protected int iconCount  
      protected javax.swing.JLabel label  
      protected boolean selected
      Is the value currently selected.
      protected java.awt.Color textNonSelectionColor
      Color to use for the foreground for non-selected nodes.
      protected java.awt.Color textSelectionColor
      Color to use for the foreground for selected nodes.

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addIcon​(javax.swing.Icon icon)  
      protected void addIcon​(javax.swing.Icon icon, java.lang.String tooltip)  
      java.awt.Color getBackgroundNonSelectionColor()  
      java.awt.Color getBackgroundSelectionColor()  
      java.awt.Color getBorderSelectionColor()  
      javax.swing.Icon getIcon()  
      java.awt.Component getListCellRendererComponent​(javax.swing.JList list, java.lang.Object value, int index, boolean isSelected, boolean cellHasFocus)  
      java.lang.String getText()  
      java.awt.Color getTextNonSelectionColor()  
      java.awt.Color getTextSelectionColor()  
      java.lang.String getToolTipText​(java.awt.event.MouseEvent event)
      Overridden to provide the tooltip text for the sub component in this JPanel under the given mouse event
      java.awt.Component getTreeCellRendererComponent​(javax.swing.JTree tree, java.lang.Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean hasFocus)  
      boolean isDrawsFocusBorderAroundIcon()  
      void paint​(java.awt.Graphics g)
      Paints the value.
      protected boolean paintBackground()  
      protected void removeAllIcons()  
      void setBackgroundNonSelectionColor​(java.awt.Color backgroundNonSelectionColor)  
      void setBackgroundSelectionColor​(java.awt.Color backgroundSelectionColor)  
      void setBorderSelectionColor​(java.awt.Color borderSelectionColor)  
      void setDrawsFocusBorderAroundIcon​(boolean drawsFocusBorderAroundIcon)  
      void setFont​(java.awt.Font font)  
      void setIcon​(javax.swing.Icon icon)  
      void setText​(java.lang.String text)  
      void setTextNonSelectionColor​(java.awt.Color textNonSelectionColor)  
      void setTextSelectionColor​(java.awt.Color textSelectionColor)  
      void setToolTipText​(java.lang.String text)  
      protected java.lang.String valueToText​(java.lang.Object value)  

      • 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, 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

      • selected

        protected boolean selected
        Is the value currently selected.

      • hasFocus

        protected boolean hasFocus
        True if has focus.

      • textSelectionColor

        protected java.awt.Color textSelectionColor
        Color to use for the foreground for selected nodes.

      • textNonSelectionColor

        protected java.awt.Color textNonSelectionColor
        Color to use for the foreground for non-selected nodes.

      • backgroundSelectionColor

        protected java.awt.Color backgroundSelectionColor
        Color to use for the background when a node is selected.

      • backgroundNonSelectionColor

        protected java.awt.Color backgroundNonSelectionColor
        Color to use for the background when the node isn't selected.

      • borderSelectionColor

        protected java.awt.Color borderSelectionColor
        Color to use for the focus indicator when the node has focus.

      • label

        protected javax.swing.JLabel label

      • iconCount

        protected int iconCount

    • Constructor Detail

      • PanelBasedTreeCellRenderer

        public PanelBasedTreeCellRenderer()

    • Method Detail

      • paintBackground

        protected boolean paintBackground()

      • addIcon

        protected void addIcon​(javax.swing.Icon icon)

      • addIcon

        protected void addIcon​(javax.swing.Icon icon,
                       java.lang.String tooltip)

      • removeAllIcons

        protected void removeAllIcons()

      • getToolTipText

        public java.lang.String getToolTipText​(java.awt.event.MouseEvent event)
        Overridden to provide the tooltip text for the sub component in this JPanel under the given mouse event
        Overrides:
        getToolTipText in class javax.swing.JComponent

      • getTreeCellRendererComponent

        public java.awt.Component getTreeCellRendererComponent​(javax.swing.JTree tree,
                                                       java.lang.Object value,
                                                       boolean sel,
                                                       boolean expanded,
                                                       boolean leaf,
                                                       int row,
                                                       boolean hasFocus)
        Specified by:
        getTreeCellRendererComponent in interface javax.swing.tree.TreeCellRenderer

      • getListCellRendererComponent

        public java.awt.Component getListCellRendererComponent​(javax.swing.JList list,
                                                       java.lang.Object value,
                                                       int index,
                                                       boolean isSelected,
                                                       boolean cellHasFocus)
        Specified by:
        getListCellRendererComponent in interface javax.swing.ListCellRenderer

      • valueToText

        protected java.lang.String valueToText​(java.lang.Object value)

      • paint

        public void paint​(java.awt.Graphics g)
        Paints the value. The background is filled based on selected.
        Overrides:
        paint in class javax.swing.JComponent

      • getBackgroundNonSelectionColor

        public java.awt.Color getBackgroundNonSelectionColor()
        Returns:
        Returns the backgroundNonSelectionColor.

      • setBackgroundNonSelectionColor

        public void setBackgroundNonSelectionColor​(java.awt.Color backgroundNonSelectionColor)
        Parameters:
        backgroundNonSelectionColor - The backgroundNonSelectionColor to set.

      • getBackgroundSelectionColor

        public java.awt.Color getBackgroundSelectionColor()
        Returns:
        Returns the backgroundSelectionColor.

      • setBackgroundSelectionColor

        public void setBackgroundSelectionColor​(java.awt.Color backgroundSelectionColor)
        Parameters:
        backgroundSelectionColor - The backgroundSelectionColor to set.

      • getBorderSelectionColor

        public java.awt.Color getBorderSelectionColor()
        Returns:
        Returns the borderSelectionColor.

      • setBorderSelectionColor

        public void setBorderSelectionColor​(java.awt.Color borderSelectionColor)
        Parameters:
        borderSelectionColor - The borderSelectionColor to set.

      • isDrawsFocusBorderAroundIcon

        public boolean isDrawsFocusBorderAroundIcon()
        Returns:
        Returns the drawsFocusBorderAroundIcon.

      • setDrawsFocusBorderAroundIcon

        public void setDrawsFocusBorderAroundIcon​(boolean drawsFocusBorderAroundIcon)
        Parameters:
        drawsFocusBorderAroundIcon - The drawsFocusBorderAroundIcon to set.

      • getTextNonSelectionColor

        public java.awt.Color getTextNonSelectionColor()
        Returns:
        Returns the textNonSelectionColor.

      • setTextNonSelectionColor

        public void setTextNonSelectionColor​(java.awt.Color textNonSelectionColor)
        Parameters:
        textNonSelectionColor - The textNonSelectionColor to set.

      • getTextSelectionColor

        public java.awt.Color getTextSelectionColor()
        Returns:
        Returns the textSelectionColor.

      • setTextSelectionColor

        public void setTextSelectionColor​(java.awt.Color textSelectionColor)
        Parameters:
        textSelectionColor - The textSelectionColor to set.

      • getIcon

        public javax.swing.Icon getIcon()

      • getText

        public java.lang.String getText()

      • setIcon

        public void setIcon​(javax.swing.Icon icon)

      • setText

        public void setText​(java.lang.String text)

      • setFont

        public void setFont​(java.awt.Font font)
        Overrides:
        setFont in class javax.swing.JComponent

      • setToolTipText

        public void setToolTipText​(java.lang.String text)
        Overrides:
        setToolTipText in class javax.swing.JComponent