com.inductiveautomation.ignition.client.sqltags.tree

Interface TagPathTreeNode

All Superinterfaces:

AsynchronousTreeNode, TagPathHolder, javax.swing.tree.TreeNode

All Known Implementing Classes:

AbstractTagPathTreeNode, AllProvidersNode, ArrayValueTreeNode, DatasetColumnTreeNode, ErrorNode, GatewayScopeRootTagManagerNode, LoadingNode, NoUDTAllProviderNode, RootTagManagerNode, TagBrowseTreeNode, TagPropNode, TagProviderNode, TagProviderNode.TypesFolder, TagTreeNode, TagValuePropNode

public interface TagPathTreeNode
extends TagPathHolder, AsynchronousTreeNode

A tree node that has a tag path.

Method Summary

Modifier and Type	Method and Description
void	blockLoad() Tells the node to load its children synchronously - blocking until they're loaded
TagPathTreeNode	findChildNodeByName(java.lang.String name) Returns a child tree node identified by the given name, or null if none was found by that name.
TagPathTreeNode	getChildAt(int idx) Narrowed return type from getChildAt in TreeNode
ClientTagManager	getManager() Returns the root ClientTagManager that loaded this node
java.lang.String	getName() Returns the name, as it would be represented in a TagPath, of this node
TagPathTreeNode	getParent() Narrowing return for getParent
TagPath	getTagPath() Returns the tag path for this tree node
java.lang.String	getTooltipText() Returns the tooltip text for the tree node
boolean	hasChild(java.lang.String name) Returns a boolean indicating if this node has a child of the given name
void	install(SQLTagTreeModel model, int index) Called then the node is created.
boolean	isMetaNode() Returns true if this node is a meta node.
boolean	isVisible()
void	reload()
void	setVisible(boolean visible) Notifies this node if it is currently displayed or not.
void	uninstall() Called when the node is destroyed.

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, isLeaf

Method Detail

getTagPath

TagPath getTagPath()

Returns the tag path for this tree node

Specified by:

getTagPath in interface TagPathHolder

Returns:

hasChild

boolean hasChild(java.lang.String name)

Returns a boolean indicating if this node has a child of the given name

findChildNodeByName

TagPathTreeNode findChildNodeByName(java.lang.String name)

Returns a child tree node identified by the given name, or null if none was found by that name.

Parameters:

name -

Returns:

blockLoad

void blockLoad()

Tells the node to load its children synchronously - blocking until they're loaded

Specified by:

blockLoad in interface AsynchronousTreeNode

getChildAt

TagPathTreeNode getChildAt(int idx)

Narrowed return type from getChildAt in TreeNode

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

getName

java.lang.String getName()

Returns the name, as it would be represented in a TagPath, of this node

getTooltipText

java.lang.String getTooltipText()

Returns the tooltip text for the tree node

Returns:

reload

void reload()

getParent

TagPathTreeNode getParent()

Narrowing return for getParent

Specified by:

getParent in interface javax.swing.tree.TreeNode

getManager

ClientTagManager getManager()

Returns the root ClientTagManager that loaded this node

install

void install(SQLTagTreeModel model,
             int index)

Called then the node is created.

Parameters:

model -

index - The index at which this node occurs in its parent

uninstall

void uninstall()

Called when the node is destroyed.

isMetaNode

boolean isMetaNode()

Returns true if this node is a meta node. (Like a loading node). Don't try to use the tag path of a Meta node

setVisible

void setVisible(boolean visible)

Notifies this node if it is currently displayed or not.

Parameters:

visible -

isVisible

boolean isVisible()