Class PMITreeView
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JScrollPane
-
- com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
-
- com.inductiveautomation.factorypmi.application.components.PMITreeView
-
- All Implemented Interfaces:
DynamicPropertyProvider
,LocaleListener
,MutableDynamicPropertyProvider
,StyleProvider
,ComponentLifecycle
,DesignerInitializable
,EnabledEx
,QualityMonitor
,VisionComponent
,java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,java.util.EventListener
,javax.accessibility.Accessible
,javax.swing.event.TreeSelectionListener
,javax.swing.ScrollPaneConstants
public class PMITreeView extends AbstractVisionScrollPane implements javax.swing.event.TreeSelectionListener, DesignerInitializable, EnabledEx
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PMITreeView.TreeViewItemConfig
-
Nested classes/interfaces inherited from class javax.swing.JScrollPane
javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description static int
ANGLED
static java.lang.Class<?>[]
COLUMN_CLASSES
static java.lang.String[]
COLUMN_NAMES
static int
HORIZONTAL
static java.lang.String[]
LINE_STYLES
static int
NONE
static java.lang.Class<?>[]
REAL_COLUMN_CLASSES
-
Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
antialias, context, cursorCode
-
Fields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport
-
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 com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle
COMPONENT_RUNNING
-
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx
DISABLED_BY_PERMISSIONS
-
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider
RESERVED_SET_KEY
-
Fields inherited from interface javax.swing.ScrollPaneConstants
COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT
-
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent
COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS
-
-
Constructor Summary
Constructors Constructor Description PMITreeView()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearSelection()
void
collapseAll()
void
evaluateEnabled()
void
expandAll()
void
expandNode(javax.swing.tree.TreeNode node, boolean expand)
void
expandNodeForLevel(javax.swing.tree.TreeNode rootNode, int levelsToExpand)
int
getAutoExpansionLevel()
java.awt.Color
getBackground()
Dataset
getData()
java.awt.Color
getDefaultBackground()
javax.swing.border.Border
getDefaultBorder()
javax.swing.Icon
getDefaultClosedIcon()
java.lang.String
getDefaultClosedIconPath()
java.awt.Color
getDefaultForeground()
javax.swing.Icon
getDefaultLeafIcon()
java.lang.String
getDefaultLeafIconPath()
javax.swing.Icon
getDefaultOpenIcon()
java.lang.String
getDefaultOpenIconPath()
java.awt.Color
getDefaultSelectedBackground()
javax.swing.border.Border
getDefaultSelectedBorder()
java.awt.Color
getDefaultSelectedForeground()
java.lang.Object
getDefaultValue(java.lang.String col, int row)
int
getLineStyle()
javax.swing.tree.TreeModel
getModel()
int
getRowHeight()
int
getSelectedItem()
Returns the index of the most recently selected node, or -1 if no node is selectedint[]
getSelectedItems()
Finds the row indexes of the selected tree nodes.java.lang.String
getSelectedPath()
java.lang.String[]
getSelectedPaths()
int
getSelectionMode()
java.lang.String
getSeparationCharacter()
void
initialize()
boolean
isAutoExpand()
boolean
isAutoSort()
boolean
isComponentEnabled()
boolean
isShowRootHandles()
protected void
onStartup()
Subclasses should override this to provide startup logic.void
setAutoExpand(boolean autoExpand)
void
setAutoExpansionLevel(int startupExpansionLevel)
void
setAutoSort(boolean autoSort)
void
setBackground(java.awt.Color bg)
void
setComponentEnabled(boolean componentEnabled)
void
setData(Dataset ds)
void
setDefaultBackground(java.awt.Color defaultBackground)
void
setDefaultBorder(javax.swing.border.Border defaultBorder)
void
setDefaultClosedIconPath(java.lang.String path)
void
setDefaultForeground(java.awt.Color defaultForeground)
void
setDefaultLeafIconPath(java.lang.String path)
void
setDefaultOpenIconPath(java.lang.String path)
void
setDefaultSelectedBackground(java.awt.Color defaultSelectedBackground)
void
setDefaultSelectedBorder(javax.swing.border.Border defaultSelectedBorder)
void
setDefaultSelectedForeground(java.awt.Color defaultSelectedForeground)
void
setFont(java.awt.Font font)
void
setLineStyle(int lineStyle)
void
setRowHeight(int rowHeight)
void
setSelectedItem(int selectedItem)
void
setSelectedItemImpl(int selectedItem, boolean alterSelection)
void
setSelectedPath(java.lang.String selectedPath)
void
setSelectionMode(int mode)
void
setSeparationCharacter(java.lang.String separationCharacter)
void
setShowRootHandles(boolean showRootHandles)
void
valueChanged(javax.swing.event.TreeSelectionEvent e)
Listens to the tree selection change events in order to update the "selectedItem" property-
Methods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
getAppContext, getCursorCode, getDataQuality, getDynamicProps, getProperties, getPropertyValue, getQuality, getStyles, getToolTipText, initStyleListener, isAntialias, isComponentRunning, isPropertyDefined, localeChanged, onShutdown, paintChildren, paintComponent, setAntialias, setCursorCode, setDataQuality, setDynamicProps, setName, setPropertyValue, setQuality, setStyles, setToolTipText, setVisible, shutdownComponent, startupComponent, updateQuality
-
Methods inherited from class javax.swing.JScrollPane
createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, 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, paint, paintBorder, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
COLUMN_NAMES
public static final java.lang.String[] COLUMN_NAMES
-
REAL_COLUMN_CLASSES
public static final java.lang.Class<?>[] REAL_COLUMN_CLASSES
-
COLUMN_CLASSES
public static final java.lang.Class<?>[] COLUMN_CLASSES
-
LINE_STYLES
public static final java.lang.String[] LINE_STYLES
-
ANGLED
public static final int ANGLED
- See Also:
- Constant Field Values
-
HORIZONTAL
public static final int HORIZONTAL
- See Also:
- Constant Field Values
-
NONE
public static final int NONE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getModel
public javax.swing.tree.TreeModel getModel()
-
getDefaultValue
public java.lang.Object getDefaultValue(java.lang.String col, int row)
-
expandAll
public void expandAll()
-
collapseAll
public void collapseAll()
-
expandNode
public void expandNode(javax.swing.tree.TreeNode node, boolean expand)
-
expandNodeForLevel
public void expandNodeForLevel(javax.swing.tree.TreeNode rootNode, int levelsToExpand)
-
getData
public Dataset getData()
-
setData
public void setData(Dataset ds)
-
getSelectedItem
public int getSelectedItem()
Returns the index of the most recently selected node, or -1 if no node is selected
-
setSelectedItem
public void setSelectedItem(int selectedItem)
-
getSelectedPath
public java.lang.String getSelectedPath()
-
setSelectedPath
public void setSelectedPath(java.lang.String selectedPath)
-
setSelectedItemImpl
public void setSelectedItemImpl(int selectedItem, boolean alterSelection)
-
getSelectedItems
public int[] getSelectedItems()
Finds the row indexes of the selected tree nodes. Implicitly created folder nodes have no index.- Returns:
- An array of ints representing the indices of selected files. The array may be empty if only folders are selected. Not null.
-
getSelectedPaths
public java.lang.String[] getSelectedPaths()
- Returns:
- Returns the paths of the selected items, including implicitly created folders. Not null.
-
clearSelection
public void clearSelection()
-
getRowHeight
public int getRowHeight()
-
setRowHeight
public void setRowHeight(int rowHeight)
-
getLineStyle
public int getLineStyle()
-
setLineStyle
public void setLineStyle(int lineStyle)
-
getSelectionMode
public int getSelectionMode()
-
setSelectionMode
public void setSelectionMode(int mode)
-
isAutoSort
public boolean isAutoSort()
-
setAutoSort
public void setAutoSort(boolean autoSort)
-
isAutoExpand
public boolean isAutoExpand()
-
setAutoExpand
public void setAutoExpand(boolean autoExpand)
-
getAutoExpansionLevel
public int getAutoExpansionLevel()
-
setAutoExpansionLevel
public void setAutoExpansionLevel(int startupExpansionLevel)
-
isShowRootHandles
public boolean isShowRootHandles()
-
setShowRootHandles
public void setShowRootHandles(boolean showRootHandles)
-
getSeparationCharacter
public java.lang.String getSeparationCharacter()
-
setSeparationCharacter
public void setSeparationCharacter(java.lang.String separationCharacter)
-
getDefaultBackground
public java.awt.Color getDefaultBackground()
-
setDefaultBackground
public void setDefaultBackground(java.awt.Color defaultBackground)
-
getDefaultForeground
public java.awt.Color getDefaultForeground()
-
setDefaultForeground
public void setDefaultForeground(java.awt.Color defaultForeground)
-
getDefaultBorder
public javax.swing.border.Border getDefaultBorder()
-
setDefaultBorder
public void setDefaultBorder(javax.swing.border.Border defaultBorder)
-
getDefaultSelectedBackground
public java.awt.Color getDefaultSelectedBackground()
-
setDefaultSelectedBackground
public void setDefaultSelectedBackground(java.awt.Color defaultSelectedBackground)
-
getDefaultSelectedForeground
public java.awt.Color getDefaultSelectedForeground()
-
setDefaultSelectedForeground
public void setDefaultSelectedForeground(java.awt.Color defaultSelectedForeground)
-
getDefaultSelectedBorder
public javax.swing.border.Border getDefaultSelectedBorder()
-
setDefaultSelectedBorder
public void setDefaultSelectedBorder(javax.swing.border.Border defaultSelectedBorder)
-
getDefaultClosedIcon
public javax.swing.Icon getDefaultClosedIcon()
-
getDefaultLeafIcon
public javax.swing.Icon getDefaultLeafIcon()
-
getDefaultOpenIcon
public javax.swing.Icon getDefaultOpenIcon()
-
getDefaultLeafIconPath
public java.lang.String getDefaultLeafIconPath()
-
setDefaultLeafIconPath
public void setDefaultLeafIconPath(java.lang.String path)
-
getDefaultOpenIconPath
public java.lang.String getDefaultOpenIconPath()
-
setDefaultOpenIconPath
public void setDefaultOpenIconPath(java.lang.String path)
-
getDefaultClosedIconPath
public java.lang.String getDefaultClosedIconPath()
-
setDefaultClosedIconPath
public void setDefaultClosedIconPath(java.lang.String path)
-
valueChanged
public void valueChanged(javax.swing.event.TreeSelectionEvent e)
Listens to the tree selection change events in order to update the "selectedItem" property- Specified by:
valueChanged
in interfacejavax.swing.event.TreeSelectionListener
-
initialize
public void initialize()
- Specified by:
initialize
in interfaceDesignerInitializable
-
onStartup
protected void onStartup()
Description copied from class:AbstractVisionScrollPane
Subclasses should override this to provide startup logic.- Overrides:
onStartup
in classAbstractVisionScrollPane
-
setBackground
public void setBackground(java.awt.Color bg)
- Overrides:
setBackground
in classjavax.swing.JComponent
-
getBackground
public java.awt.Color getBackground()
- Overrides:
getBackground
in classjava.awt.Component
-
setFont
public void setFont(java.awt.Font font)
- Overrides:
setFont
in classjavax.swing.JComponent
-
isComponentEnabled
public boolean isComponentEnabled()
- Specified by:
isComponentEnabled
in interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled)
- Specified by:
setComponentEnabled
in interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()
- Specified by:
evaluateEnabled
in interfaceEnabledEx
-
-