Package com.inductiveautomation.ignition.client.tags.tree.node

Interface BrowseTreeNode

All Superinterfaces:

AsynchronousTreeNode, InfoNode, javax.swing.tree.TreeNode

All Known Implementing Classes:

AbstractBrowseNode, AllProvidersNode, ArrayValueTreeNode, DatasetColumnTreeNode, DataTypeFilteredProviderNode, DataTypesOnlyProviderNode, DesignerRootTagManagerNode, EditableProviderNode, ErrorNode, FolderNode, LoadingNode, PropertyNode, ProviderFilteredRootNode, RootTagManagerNode, TagBrowseFolderNode, TagBrowseProviderNode, TagBrowseRootNode, TagProviderNode, TagProviderNode.EmptyRootNode, TagTreeNode, TypesFolderNode, UdtDefBrowseNode, VisionProjectTagProviderNode

public interface BrowseTreeNode
extends AsynchronousTreeNode, InfoNode

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<TagTypeDescriptor>	NO_TYPES

Method Summary

Modifier and Type	Method	Description
BrowseTreeNode	findChildNodeByName(java.lang.String name)
java.util.Set<TagTypeDescriptor>	getAllowedNewObjectTypes()	Returns the type of objects that can be added at this level.
EditRights	getEditRights()
NodeBrowseInfo	getInfo()
java.lang.String	getName()	Returns the name, as it would be represented in a TagPath, of this node
BrowseTreeNode	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)
void	install(TagTreeModel model, int index)	Called then the node is created.
boolean	isMetaNode()	Returns true if this node is a meta node.
boolean	isVisible()
void	maybeBrowseAsync()	Will perform an async browse and load for the children of this node if they have not already been loaded.
void	reload()	Will perform a full browse a reload for the children of this node
void	setVisible(boolean visible)	Notifies this node if it is currently displayed or not.
void	uninstall()

Methods inherited from interface com.inductiveautomation.ignition.client.util.gui.tree.AsynchronousTreeNode

blockLoad

Methods inherited from interface com.inductiveautomation.ignition.client.tags.tree.node.InfoNode

getTagType

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, isLeaf

Field Detail

NO_TYPES

static final java.util.Set<TagTypeDescriptor> NO_TYPES

Method Detail

getTagPath

TagPath getTagPath()

Returns the tag path for this tree node

getName

java.lang.String getName()

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

getAllowedNewObjectTypes

@Nullable
java.util.Set<TagTypeDescriptor> getAllowedNewObjectTypes()

Returns the type of objects that can be added at this level.

getEditRights

EditRights getEditRights()

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

getInfo

NodeBrowseInfo getInfo()

Specified by:

getInfo in interface InfoNode

hasChild

boolean hasChild(java.lang.String name)

findChildNodeByName

BrowseTreeNode findChildNodeByName(java.lang.String name)

getParent

BrowseTreeNode getParent()

Narrowing return for getParent

Specified by:

getParent in interface javax.swing.tree.TreeNode

reload

void reload()

Will perform a full browse a reload for the children of this node

maybeBrowseAsync

void maybeBrowseAsync()

Will perform an async browse and load for the children of this node if they have not already been loaded.

install

void install(TagTreeModel model,
             int index)

Called then the node is created.

Parameters:

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

uninstall

void uninstall()

isVisible

boolean isVisible()

setVisible

void setVisible(boolean visible)

Notifies this node if it is currently displayed or not.

getTooltipText

java.lang.String getTooltipText()

Returns the tooltip text for the tree node