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

Class RootTagManagerNode

java.lang.Object

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

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

All Implemented Interfaces:

BrowseTreeNode, FilterableRootNode, InfoNode, AsynchronousTreeNode, TreeNode

Direct Known Subclasses:

DesignerRootTagManagerNode, TagBrowseRootNode

public class RootTagManagerNode
extends AbstractBrowseNode
implements FilterableRootNode

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.client.tags.tree.node.AbstractBrowseNode

AbstractBrowseNode.BrowseTreeComparator, AbstractBrowseNode.InfoComparator, AbstractBrowseNode.Loader, AbstractBrowseNode.LoadingStatus, AbstractBrowseNode.NodeWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	blockedNames
protected ClientContext	context
protected static final String	DEFAULT_PROV
protected Comparator<BrowseTreeNode>	providerSort

Fields inherited from class com.inductiveautomation.ignition.client.tags.tree.node.AbstractBrowseNode

childStatus, errorNode, executor, folderTypes, info, loadingNode, loadRunner, log, nodeList, nodeMap, parentIndex, TAG_COMP, treeModel, visible

Fields inherited from interface com.inductiveautomation.ignition.client.tags.tree.node.BrowseTreeNode

NO_TYPES

Constructor Summary

Constructors

Constructor	Description
RootTagManagerNode(ClientContext context)

Method Summary

Modifier and Type	Method	Description
void	allow(String name)
void	block(String name)
TagProviderNode	createProviderNode(TagProviderProps props, BrowseTreeNode parent)
List<BrowseTreeNode>	executeChildrenBrowse()
protected boolean	filter(TagProviderProps prop)
Set<TagTypeDescriptor>	getAllowedNewObjectTypes()	Returns the type of objects that can be added at this level.
EditRights	getEditRights()
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
String	getTooltipText()	Returns the tooltip text for the tree node
void	install(TagTreeModel model, int index)	Called then the node is created.
String	toString()

Methods inherited from class com.inductiveautomation.ignition.client.tags.tree.node.AbstractBrowseNode

blockLoad, children, createLoader, createNodeMap, equals, findChildNodeByName, fireLightweightChange, fireNodeChanged, getAllowsChildren, getChildAt, getChildCount, getClientContext, getIndex, getInfo, getManager, getRank, hasChild, hashCode, isLeaf, isMetaNode, isVisible, loadCancelled, loadChildrenAsync, loadChildrenWithStatus, loadDone, loadError, logLoaded, maybeBrowseAsync, notifyVisibilityChange, reload, reloadSynchronous, setInfo, setVisible, uninstall

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getTagType

Field Details

DEFAULT_PROV

protected static final String DEFAULT_PROV

blockedNames

protected Set<String> blockedNames

context

protected ClientContext context

providerSort

protected Comparator<BrowseTreeNode> providerSort

Constructor Details

RootTagManagerNode

public RootTagManagerNode(ClientContext context)

Method Details

getName

public String getName()

Description copied from interface: BrowseTreeNode

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

Specified by:

getName in interface BrowseTreeNode

getEditRights

public EditRights getEditRights()

Specified by:

getEditRights in interface BrowseTreeNode

getAllowedNewObjectTypes

@Nullable
public Set<TagTypeDescriptor> getAllowedNewObjectTypes()

Description copied from interface: BrowseTreeNode

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

Specified by:

getAllowedNewObjectTypes in interface BrowseTreeNode

getTooltipText

public String getTooltipText()

Description copied from interface: BrowseTreeNode

Returns the tooltip text for the tree node

Specified by:

getTooltipText in interface BrowseTreeNode

getTagPath

public TagPath getTagPath()

Description copied from interface: BrowseTreeNode

Returns the tag path for this tree node

Specified by:

getTagPath in interface BrowseTreeNode

Overrides:

getTagPath in class AbstractBrowseNode

install

public void install(TagTreeModel model,
 int index)

Description copied from interface: BrowseTreeNode

Called then the node is created.

Specified by:

install in interface BrowseTreeNode

Overrides:

install in class AbstractBrowseNode

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

getParent

public BrowseTreeNode getParent()

Description copied from interface: BrowseTreeNode

Narrowing return for getParent

Specified by:

getParent in interface BrowseTreeNode

Specified by:

getParent in interface TreeNode

toString

public String toString()

Overrides:

toString in class AbstractBrowseNode

allow

public void allow(String name)

Specified by:

allow in interface FilterableRootNode

Parameters:

name - the name of the provider to unblock when browsing

block

public void block(String name)

Specified by:

block in interface FilterableRootNode

Parameters:

name - the name of a provider to block while browsing; no node will be created for the provider.

createProviderNode

public TagProviderNode createProviderNode(TagProviderProps props,
 BrowseTreeNode parent)

filter

protected boolean filter(TagProviderProps prop)

executeChildrenBrowse

public List<BrowseTreeNode> executeChildrenBrowse()
                                           throws Exception

Specified by:

executeChildrenBrowse in class AbstractBrowseNode

Throws:

Exception