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,ImageObserver,MenuContainer,Serializable,EventListener,Accessible,TreeSelectionListener,ScrollPaneConstants
public class PMITreeView
extends AbstractVisionScrollPane
implements TreeSelectionListener, DesignerInitializable, EnabledEx
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class javax.swing.JScrollPane
JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBarNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final Class<?>[]static final String[]static final intstatic final String[]static final intstatic final Class<?>[]Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
antialias, context, cursorCodeFields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewportFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle
COMPONENT_RUNNINGFields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx
DISABLED_BY_PERMISSIONSFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener
LOCAL_CHANGE_EVENTFields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider
RESERVED_SET_KEYFields 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, VIEWPORTFields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent
COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidvoidvoidvoidexpandNode(TreeNode node, boolean expand) voidexpandNodeForLevel(TreeNode rootNode, int levelsToExpand) intgetData()getDefaultValue(String col, int row) intgetModel()intintReturns the index of the most recently selected node, or -1 if no node is selectedint[]Finds the row indexes of the selected tree nodes.String[]intvoidbooleanbooleanbooleanbooleanbooleanprotected voidSubclasses should override this to provide startup logic.voidsetAutoExpand(boolean autoExpand) voidsetAutoExpansionLevel(int startupExpansionLevel) voidsetAutoSort(boolean autoSort) voidsetBackground(Color bg) voidsetComponentEnabled(boolean componentEnabled) voidvoidsetDefaultBackground(Color defaultBackground) voidsetDefaultBorder(Border defaultBorder) voidvoidsetDefaultForeground(Color defaultForeground) voidsetDefaultLeafIconPath(String path) voidsetDefaultOpenIconPath(String path) voidsetDefaultSelectedBackground(Color defaultSelectedBackground) voidsetDefaultSelectedBorder(Border defaultSelectedBorder) voidsetDefaultSelectedForeground(Color defaultSelectedForeground) voidvoidsetFullWidthSelection(boolean fullWidthSelection) voidsetLineStyle(int lineStyle) voidsetRowHeight(int rowHeight) voidsetSelectedItem(int selectedItem) voidsetSelectedItemImpl(int selectedItem, boolean alterSelection) voidsetSelectedPath(String selectedPath) voidsetSelectionFillColor(Color selectionFillColor) voidsetSelectionMode(int mode) voidsetSeparationCharacter(String separationCharacter) voidsetShowRootHandles(boolean showRootHandles) voidListens to the tree selection change events in order to update the "selectedItem" propertyMethods 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, updateQualityMethods 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, updateUIMethods 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, updateMethods 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, validateTreeMethods 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 Details
-
COLUMN_NAMES
-
REAL_COLUMN_CLASSES
-
COLUMN_CLASSES
-
LINE_STYLES
-
ANGLED
public static final int ANGLED- See Also:
-
HORIZONTAL
public static final int HORIZONTAL- See Also:
-
NONE
public static final int NONE- See Also:
-
-
Constructor Details
-
PMITreeView
public PMITreeView()
-
-
Method Details
-
getModel
-
getDefaultValue
-
expandAll
public void expandAll() -
collapseAll
public void collapseAll() -
expandNode
-
expandNodeForLevel
-
getData
-
setData
-
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
-
setSelectedPath
-
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
- 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
-
setSeparationCharacter
-
getDefaultBackground
-
setDefaultBackground
-
getDefaultForeground
-
setDefaultForeground
-
getDefaultBorder
-
setDefaultBorder
-
getDefaultSelectedBackground
-
setDefaultSelectedBackground
-
getDefaultSelectedForeground
-
setDefaultSelectedForeground
-
getDefaultSelectedBorder
-
setDefaultSelectedBorder
-
getSelectionFillColor
-
setSelectionFillColor
-
isFullWidthSelection
public boolean isFullWidthSelection() -
setFullWidthSelection
public void setFullWidthSelection(boolean fullWidthSelection) -
getDefaultClosedIcon
-
getDefaultLeafIcon
-
getDefaultOpenIcon
-
getDefaultLeafIconPath
-
setDefaultLeafIconPath
-
getDefaultOpenIconPath
-
setDefaultOpenIconPath
-
getDefaultClosedIconPath
-
setDefaultClosedIconPath
-
valueChanged
Listens to the tree selection change events in order to update the "selectedItem" property- Specified by:
valueChangedin interfaceTreeSelectionListener
-
initialize
public void initialize()- Specified by:
initializein interfaceDesignerInitializable
-
onStartup
protected void onStartup()Description copied from class:AbstractVisionScrollPaneSubclasses should override this to provide startup logic.- Overrides:
onStartupin classAbstractVisionScrollPane
-
setBackground
- Overrides:
setBackgroundin classJComponent
-
getBackground
- Overrides:
getBackgroundin classComponent
-
setFont
- Overrides:
setFontin classJComponent
-
isComponentEnabled
public boolean isComponentEnabled()- Specified by:
isComponentEnabledin interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled) - Specified by:
setComponentEnabledin interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()- Specified by:
evaluateEnabledin interfaceEnabledEx
-