Package com.inductiveautomation.ignition.designer.tags.tree.selection

Class TagSelectionTreePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.designer.tags.tree.selection.TagSelectionTreePanel

All Implemented Interfaces:

TagSelectionComponent, ImageObserver, MenuContainer, Serializable, Accessible

public class TagSelectionTreePanel
extends JPanel
implements TagSelectionComponent

Displays a simple tree of BrowseTreeNodes used for selecting tag paths.

Since:

8.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TagSelectionTreePanel.RecentPathsList
static class	TagSelectionTreePanel.TSTabbedPanel	Copied over from the TagSelectionComponentBuilder class used in 7.9

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected TagSelectionTreePanel.RecentPathsList	comboModel
protected JComboBox	recentPathsBox
protected TagBrowserTree	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
TagSelectionTreePanel(DesignerContext context)
TagSelectionTreePanel(DesignerContext context, TagBrowserTree tree)

Method Summary

Modifier and Type	Method	Description
protected TreePath	findPathFor(TagPath path)
static TagSelectionComponent	fullBrowseTree(DesignerContext context)
static TagSelectionTreePanel	gatewayTagsTree(DesignerContext context)
TagPath	getComboBoxSelection()
TagPath	getSelectedTagPath()
List<TagPath>	getSelectedTagPaths()
NodeBrowseInfo	getTagInfo(TagPath path)
boolean	hasPath(TagPath path)	Returns whether this selection component has the given path, indicating that it could be passed to setSelectedTagPath()
void	reset()
void	resetRootModel()
void	setModel(TreeModel model)
void	setModel(TreeModel model, boolean showRoot)
void	setSelectedTagPath(TagPath path)
void	setSelectedTagPaths(List<TagPath> paths)
static TagSelectionComponent	simpleSingleProvider(DesignerContext context, String provider)
static TagSelectionComponent	tabbedPanel(DesignerContext context)	Returns a panel with a tab for standard tags, and potentially another panel for tags under a udt definition.

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 Details

tree

protected TagBrowserTree tree

recentPathsBox

protected JComboBox recentPathsBox

comboModel

protected TagSelectionTreePanel.RecentPathsList comboModel

Constructor Details

TagSelectionTreePanel

public TagSelectionTreePanel(DesignerContext context)

TagSelectionTreePanel

public TagSelectionTreePanel(DesignerContext context,
 TagBrowserTree tree)

Method Details

fullBrowseTree

public static TagSelectionComponent fullBrowseTree(DesignerContext context)

simpleSingleProvider

public static TagSelectionComponent simpleSingleProvider(DesignerContext context,
 String provider)

gatewayTagsTree

public static TagSelectionTreePanel gatewayTagsTree(DesignerContext context)

tabbedPanel

public static TagSelectionComponent tabbedPanel(DesignerContext context)

Returns a panel with a tab for standard tags, and potentially another panel for tags under a udt definition. Call CustomPropertyEditor#updateTagsPanelRoot on this panel to add a udt definition and its child tags under the udt tab.

reset

public void reset()

Specified by:

reset in interface TagSelectionComponent

resetRootModel

public void resetRootModel()

getSelectedTagPath

@Nullable
public TagPath getSelectedTagPath()

Specified by:

getSelectedTagPath in interface TagSelectionComponent

getSelectedTagPaths

public List<TagPath> getSelectedTagPaths()

Specified by:

getSelectedTagPaths in interface TagSelectionComponent

setSelectedTagPath

public void setSelectedTagPath(TagPath path)

Specified by:

setSelectedTagPath in interface TagSelectionComponent

setSelectedTagPaths

public void setSelectedTagPaths(List<TagPath> paths)

Specified by:

setSelectedTagPaths in interface TagSelectionComponent

getComboBoxSelection

public TagPath getComboBoxSelection()

findPathFor

protected TreePath findPathFor(TagPath path)

hasPath

public boolean hasPath(TagPath path)

Description copied from interface: TagSelectionComponent

Returns whether this selection component has the given path, indicating that it could be passed to setSelectedTagPath()

Specified by:

hasPath in interface TagSelectionComponent

getTagInfo

public NodeBrowseInfo getTagInfo(TagPath path)

Returns:

the NodeBrowseInfo object that was used when building the tag for the tree. Returns null if the tag could not be located in the tree.

setModel

public void setModel(TreeModel model)

setModel

public void setModel(TreeModel model,
 boolean showRoot)