com.inductiveautomation.ignition.designer.navtree.model

Class AbstractResourceNavTreeNode

java.lang.Object

com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

com.inductiveautomation.ignition.designer.navtree.model.AbstractResourceNavTreeNode

All Implemented Interfaces:

java.lang.Iterable<AbstractNavTreeNode>, javax.swing.tree.TreeNode

Direct Known Subclasses:

AbstractTopLevelContainerNode, FolderNode, ModuleNode, PipelineNode, ResourceNode, SfcNode

public abstract class AbstractResourceNavTreeNode
extends AbstractNavTreeNode

Simple subclass of AbstractNavTreeNode that has some functions for dealing with project resources represented by the node

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

AbstractNavTreeNode.DeleteReason, AbstractNavTreeNode.PopupAction, AbstractNavTreeNode.ResourceChangeListener

Field Summary

Fields inherited from class com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

bold, children, childrenLoaded, copyAction, cutAction, deleteAction, depth, icon, italic, log, model, name, NAME_PATTERN, parent, pasteAction, protectedAction, protectedMenuItem, renameAction, selectionModel, text, thumbnail, tooltip

Constructor Summary

Constructors

Constructor and Description
AbstractResourceNavTreeNode()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.Long>	gatherChildrenIds(Project project) Returns the id of this resource, or if this is a folder, walks down and finds all resources ids under this folder (but not folders themselves)
abstract ProjectResource	getProjectResource() The ProjectResource that this node represents
void	install(AbstractNavTreeNode parent)
boolean	isProtected() Used to display protected Icon for project resources that are able to be protected.
boolean	isProtectedEnabled() This method is overridden by AbstractProtectableResourceNavTreeNode to check the if the user has the required role to protect resources.
protected abstract DesignerProjectContext	projectCtx() Returns the project context (local vs global) that this resource belongs to
void	selectChild(long... ids) In an invoke later, tries to find a child resource-backed node with the given id to select.
void	setProtected(boolean prot) If protection is enabled, this is the callback from the checkbox menu item when the user toggles the protection bit.
protected void	setupEditActions(javax.swing.tree.TreePath[] paths, java.util.List<AbstractNavTreeNode> selection) Searches for a common edit action handling parent, and if one exists, sets up the edit actions appropriately.
protected void	uninstall() Called when the node is removed from the tree.

Methods inherited from class com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

addBadges, addEditActions, canCopy, canDelete, canDrag, canDrop, canPaste, checkChildren, children, confirmDelete, createProjectCopy, debug, debug, dispatchSelectionEvent, doCopy, doCut, doDelete, doPaste, expand, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getCommonEditActionHandler, getDepth, getExpandedIcon, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, getWorkspaceName, initPopupMenu, isBold, isEditable, isEditActionHandler, isItalic, isLeaf, isSelected, isValidName, iterator, loadChildren, newLogger, notifyChildNameChanged, onChildrenSelected, onDoubleClick, onEdit, onSelected, pathToRoot, recreate, refresh, reload, select, select, setBold, setChildren, setIcon, setItalic, setName, setText, setThumbnail, setTooltip, showPopup, showPopupMenu, toString, uninstallChildren, useThumbnailTooltip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractResourceNavTreeNode

public AbstractResourceNavTreeNode()

Method Detail

getProjectResource

public abstract ProjectResource getProjectResource()

The ProjectResource that this node represents

projectCtx

protected abstract DesignerProjectContext projectCtx()

Returns the project context (local vs global) that this resource belongs to

setProtected

public void setProtected(boolean prot)

Description copied from class: AbstractNavTreeNode

If protection is enabled, this is the callback from the checkbox menu item when the user toggles the protection bit. Default implementation is a no-op, must be overridden to be effective.

Overrides:

setProtected in class AbstractNavTreeNode

install

public void install(AbstractNavTreeNode parent)

Overrides:

install in class AbstractNavTreeNode

uninstall

protected void uninstall()

Description copied from class: AbstractNavTreeNode

Called when the node is removed from the tree. Override to provide meaningful implementation.

Overrides:

uninstall in class AbstractNavTreeNode

isProtectedEnabled

public boolean isProtectedEnabled()

Description copied from class: AbstractNavTreeNode

This method is overridden by AbstractProtectableResourceNavTreeNode to check the if the user has the required role to protect resources.

Overrides:

isProtectedEnabled in class AbstractNavTreeNode

setupEditActions

protected void setupEditActions(javax.swing.tree.TreePath[] paths,
                                java.util.List<AbstractNavTreeNode> selection)

Description copied from class: AbstractNavTreeNode

Searches for a common edit action handling parent, and if one exists, sets up the edit actions appropriately. If not, disables them.

Overrides:

setupEditActions in class AbstractNavTreeNode

isProtected

public boolean isProtected()

Description copied from class: AbstractNavTreeNode

Used to display protected Icon for project resources that are able to be protected. This method is overridden in AbstractProtectableResource to return if the the project resource it contains is actually.

Overrides:

isProtected in class AbstractNavTreeNode

selectChild

public void selectChild(long... ids)

In an invoke later, tries to find a child resource-backed node with the given id to select.

gatherChildrenIds

public java.util.Collection<java.lang.Long> gatherChildrenIds(Project project)

Returns the id of this resource, or if this is a folder, walks down and finds all resources ids under this folder (but not folders themselves)