Package 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:

Iterable<AbstractNavTreeNode>, TreeNode

Direct Known Subclasses:

AbstractTopLevelContainerNode, ClientEventScriptNode, FolderNode, GatewayEventScriptNode, ModuleNode, PipelineNode, ResourceNode, ScriptModuleNode, SessionEventScriptNode, SfcNode, StyleClassNavTreeNode

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

Modifier and Type	Class	Description
protected class	AbstractResourceNavTreeNode.OverrideResult
protected static enum	AbstractResourceNavTreeNode.OverrideResultStatus

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

AbstractNavTreeNode.DeleteReason, AbstractNavTreeNode.PopupAction

Field Summary

Fields

Modifier and Type	Field	Description
protected final DesignerContext	context
protected static final AbstractNavTreeNode.PopupAction	editDocumentationAction
protected static final JMenuItem	editDocumentationMenuItem
protected final AbstractNavTreeNode.PopupAction	exportAction
protected Icon	inheritedIcon
protected BaseAction	overrideAction
protected static final AbstractNavTreeNode.PopupAction	overrideEnabledAction
protected static final JCheckBoxMenuItem	overrideEnabledMenuItem
protected static final AbstractNavTreeNode.PopupAction	protectedAction
protected static final JCheckBoxMenuItem	protectedMenuItem
protected final ProjectResourceId	resourceId
protected final ResourcePath	resourcePath
protected Boolean	restricted
protected static final AbstractNavTreeNode.PopupAction	revertAction
protected static final JMenuItem	revertMenuItem

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResourceNavTreeNode(DesignerContext context, ResourcePath path)
protected	AbstractResourceNavTreeNode(DesignerContext context, ResourcePath path, boolean isModuleNode)

Method Summary

Modifier and Type	Method	Description
protected final void	addActionsForInheritedNodes(JPopupMenu menu)
void	addBadges(BadgeTreeCellRenderer renderer, boolean selected)	Add 'badges' to indicate meta information about this node
protected void	addConcurrentUsersBadges(BadgeTreeCellRenderer renderer, boolean selected)
protected void	addDeleteOrDiscardOverridesMenuItem(JPopupMenu menu)	This method adds a "Discard Override" menu item when the resource is inherited, otherwise it adds a "Delete" menu item.
protected void	addDocumentationMenuItem(JPopupMenu menu)
protected void	addEditActions(JPopupMenu menu)
protected void	addExportMenuItem(JPopupMenu menu)
protected void	addInheritedBadge(BadgeTreeCellRenderer renderer, boolean selected)
protected void	addNotesBadge(BadgeTreeCellRenderer renderer, boolean selected)
protected void	addOverriddenBadge(BadgeTreeCellRenderer renderer, boolean selected)
protected void	addOverrideEnabledMenuItem(JPopupMenu menu)
protected final void	addOverrideOrDiscardOverridesMenuItem(JPopupMenu menu)
protected void	addProtectMenuItem(JPopupMenu menu)
protected void	addRevertMenuItem(JPopupMenu menu)
protected boolean	alterName(String newTextValue)
boolean	canCopy(List<AbstractNavTreeNode> selectedChildren)	Can this edit action handler handle the copy action, given its current selection? Note that if this and AbstractNavTreeNode.canDelete(java.util.List) both return true, the cut action will also be enabled.
boolean	canDelete(List<AbstractNavTreeNode> selectedChildren)	Can this edit action handler handle the delete action, given its current selection? Note that if this and AbstractNavTreeNode.canCopy(java.util.List) both return true, the cut action will also be enabled.
void	commitIfOpen()	Implement this to commit the resource that is open for editing.
void	editDocumentation()
Collection<ResourcePath>	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)
protected List<ResourcePath>	getAdditionalExportIds()
protected AbstractNavTreeNode.PopupAction	getDeleteAction()
protected String	getInheritanceString()
protected String	getInvalidNameErrorMessage(String attemptedName)
protected Iterable<AbstractNavTreeNode.PopupAction>	getPopupActions()	Provide a list of PopupActions that will be set up by AbstractNavTreeNode.setupEditActions(javax.swing.tree.TreePath[], java.util.List<com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode>); that is, will have their AbstractNavTreeNode.PopupAction.selection and AbstractNavTreeNode.PopupAction.actionHandler set.
Optional<ProjectResource>	getProjectResource()	The ProjectResource that this node represents
ProjectResourceId	getResourceId()
ResourcePath	getResourcePath()
protected static boolean	inherited(List<AbstractNavTreeNode> nodes)
void	install(AbstractNavTreeNode parent)
boolean	isChanged()
boolean	isEditable()	Override this and return true if you want your node's text to be editable.
boolean	isEditActionHandler()	Override to return true if you want this node to be an edit action handler for its children.
boolean	isInherited()	True if this node's resource is inherited from a parent project.
boolean	isLocal()
protected boolean	isOpen()	Override this to indicate whether or not this resource is open for editing
boolean	isOverridden()	True if this node's resource is present and overriding a resource from a parent project.
boolean	isOverrideEnabled()
protected boolean	isProtectedEnabled()
boolean	isRestricted()	Used to display protected Icon for project resources that are able to be protected.
protected boolean	isValid(String name)	Override this if you want special naming rules for your node.
protected void	modifyOverrideAction(BaseAction baseAction)	If subclasses need to modify the #overrideAction they can modify this method.
protected static boolean	notInherited(List<AbstractNavTreeNode> nodes)
void	onDoubleClick()	Called when this node is double-clicked on.
void	onEdit(String newTextValue)	Called after this node has been edited in the tree.
protected void	onResourceModified(ProjectResource resource)	AbstractResourceNavTreeNode adds a project listener to listen for changes to this node's resource.
protected void	open()	Implement this to open this resource up for editing
protected static boolean	overridden(List<AbstractNavTreeNode> nodes)
protected AbstractResourceNavTreeNode.OverrideResult	override()
void	revert()
void	selectChild(ResourcePath... ids)	In an invoke later, tries to find a child resource-backed node with the given id to select.
void	setOverrideEnabled(boolean enabled)
void	setProtected(boolean prot)
void	setRevertedResourcePath(ResourcePath resourcePath)
protected void	setupEditActions(TreePath[] paths, List<AbstractNavTreeNode> selection)	Searches for a common edit action handling parent, and initializes each popup action by calling AbstractNavTreeNode.PopupAction.setSelection(AbstractNavTreeNode, AbstractNavTreeNode, List)
protected void	uninstall()	Called when the node is removed from the tree.

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

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

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

Field Details

context

@Nonnull
protected final DesignerContext context

resourcePath

@Nonnull
protected final ResourcePath resourcePath

resourceId

@Nonnull
protected final ProjectResourceId resourceId

inheritedIcon

protected Icon inheritedIcon

restricted

protected Boolean restricted

protectedAction

protected static final AbstractNavTreeNode.PopupAction protectedAction

protectedMenuItem

protected static final JCheckBoxMenuItem protectedMenuItem

overrideEnabledAction

protected static final AbstractNavTreeNode.PopupAction overrideEnabledAction

overrideEnabledMenuItem

protected static final JCheckBoxMenuItem overrideEnabledMenuItem

revertAction

protected static final AbstractNavTreeNode.PopupAction revertAction

revertMenuItem

protected static final JMenuItem revertMenuItem

editDocumentationAction

protected static final AbstractNavTreeNode.PopupAction editDocumentationAction

editDocumentationMenuItem

protected static final JMenuItem editDocumentationMenuItem

overrideAction

protected BaseAction overrideAction

exportAction

protected final AbstractNavTreeNode.PopupAction exportAction

Constructor Details

AbstractResourceNavTreeNode

protected AbstractResourceNavTreeNode(@Nonnull
 DesignerContext context,
 @Nonnull
 ResourcePath path)

AbstractResourceNavTreeNode

protected AbstractResourceNavTreeNode(@Nonnull
 DesignerContext context,
 @Nonnull
 ResourcePath path,
 boolean isModuleNode)

Method Details

addBadges

public void addBadges(BadgeTreeCellRenderer renderer,
 boolean selected)

Description copied from class: AbstractNavTreeNode

Add 'badges' to indicate meta information about this node

Overrides:

addBadges in class AbstractNavTreeNode

Parameters:

renderer - the renderer; call BadgeTreeCellRenderer.addBadge(Badge) to add your badge(s)

selected - the state of this node

addConcurrentUsersBadges

protected void addConcurrentUsersBadges(BadgeTreeCellRenderer renderer,
 boolean selected)

addNotesBadge

protected void addNotesBadge(BadgeTreeCellRenderer renderer,
 boolean selected)

getProjectResource

public Optional<ProjectResource> getProjectResource()

The ProjectResource that this node represents

getResourceId

@Nonnull
public ProjectResourceId getResourceId()

getResourcePath

@Nonnull
public ResourcePath getResourcePath()

setRevertedResourcePath

public void setRevertedResourcePath(ResourcePath resourcePath)

setProtected

public void setProtected(boolean prot)

setOverrideEnabled

public void setOverrideEnabled(boolean enabled)

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

isOverrideEnabled

public boolean isOverrideEnabled()

isProtectedEnabled

protected boolean isProtectedEnabled()

isValid

protected boolean isValid(String name)

Override this if you want special naming rules for your node. Note that project imports assume RESOURCE_NAME_PATTERN is valid for all resource types. Write unit tests for overrides.

Parameters:

name - name to evaluate

Returns:

true if matches the pattern

isInherited

public boolean isInherited()

True if this node's resource is inherited from a parent project.

isOverridden

public boolean isOverridden()

True if this node's resource is present and overriding a resource from a parent project.

overridden

protected static boolean overridden(List<AbstractNavTreeNode> nodes)

notInherited

protected static boolean notInherited(List<AbstractNavTreeNode> nodes)

inherited

protected static boolean inherited(List<AbstractNavTreeNode> nodes)

isLocal

public boolean isLocal()

isChanged

public boolean isChanged()

isEditable

public boolean isEditable()

Description copied from class: AbstractNavTreeNode

Override this and return true if you want your node's text to be editable. See AbstractNavTreeNode.onEdit(String)

Overrides:

isEditable in class AbstractNavTreeNode

isOpen

protected boolean isOpen()

Override this to indicate whether or not this resource is open for editing

open

protected void open()

Implement this to open this resource up for editing

commitIfOpen

public void commitIfOpen()

Implement this to commit the resource that is open for editing.

revert

public void revert()

editDocumentation

public void editDocumentation()

onDoubleClick

public void onDoubleClick()

Description copied from class: AbstractNavTreeNode

Called when this node is double-clicked on.

Overrides:

onDoubleClick in class AbstractNavTreeNode

onEdit

public void onEdit(String newTextValue)

Description copied from class: AbstractNavTreeNode

Called after this node has been edited in the tree.

Overrides:

onEdit in class AbstractNavTreeNode

alterName

protected boolean alterName(String newTextValue)

getInvalidNameErrorMessage

protected String getInvalidNameErrorMessage(String attemptedName)

getAdditionalExportIds

protected List<ResourcePath> getAdditionalExportIds()

getPopupActions

protected Iterable<AbstractNavTreeNode.PopupAction> getPopupActions()

Description copied from class: AbstractNavTreeNode

Provide a list of PopupActions that will be set up by AbstractNavTreeNode.setupEditActions(javax.swing.tree.TreePath[], java.util.List<com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode>); that is, will have their AbstractNavTreeNode.PopupAction.selection and AbstractNavTreeNode.PopupAction.actionHandler set.

Overrides:

getPopupActions in class AbstractNavTreeNode

setupEditActions

protected void setupEditActions(TreePath[] paths,
 List<AbstractNavTreeNode> selection)

Description copied from class: AbstractNavTreeNode

Searches for a common edit action handling parent, and initializes each popup action by calling AbstractNavTreeNode.PopupAction.setSelection(AbstractNavTreeNode, AbstractNavTreeNode, List)

Overrides:

setupEditActions in class AbstractNavTreeNode

addEditActions

protected void addEditActions(JPopupMenu menu)

Overrides:

addEditActions in class AbstractNavTreeNode

addActionsForInheritedNodes

protected final void addActionsForInheritedNodes(JPopupMenu menu)

addOverrideOrDiscardOverridesMenuItem

protected final void addOverrideOrDiscardOverridesMenuItem(JPopupMenu menu)

modifyOverrideAction

protected void modifyOverrideAction(BaseAction baseAction)

If subclasses need to modify the #overrideAction they can modify this method. As an example the FolderNode class needs to modify the general text that's displayed to a more specific text related to use as it relates to the folder, such as turning a singular noun to a plural, since folders can contain more than one items to override.

addExportMenuItem

protected void addExportMenuItem(JPopupMenu menu)

addRevertMenuItem

protected void addRevertMenuItem(JPopupMenu menu)

addProtectMenuItem

protected void addProtectMenuItem(JPopupMenu menu)

addOverrideEnabledMenuItem

protected void addOverrideEnabledMenuItem(JPopupMenu menu)

addDocumentationMenuItem

protected void addDocumentationMenuItem(JPopupMenu menu)

addDeleteOrDiscardOverridesMenuItem

protected void addDeleteOrDiscardOverridesMenuItem(JPopupMenu menu)

This method adds a "Discard Override" menu item when the resource is inherited, otherwise it adds a "Delete" menu item.

Parameters:

menu - The menu to which the "Delete" or "Discard Override" action is added

isRestricted

public boolean isRestricted()

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:

isRestricted in class AbstractNavTreeNode

selectChild

public void selectChild(ResourcePath... ids)

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

gatherChildrenIds

public Collection<ResourcePath> 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)

isEditActionHandler

public boolean isEditActionHandler()

Description copied from class: AbstractNavTreeNode

Override to return true if you want this node to be an edit action handler for its children.

Overrides:

isEditActionHandler in class AbstractNavTreeNode

canDelete

public boolean canDelete(List<AbstractNavTreeNode> selectedChildren)

Description copied from class: AbstractNavTreeNode

Can this edit action handler handle the delete action, given its current selection? Note that if this and AbstractNavTreeNode.canCopy(java.util.List) both return true, the cut action will also be enabled.

Overrides:

canDelete in class AbstractNavTreeNode

canCopy

public boolean canCopy(List<AbstractNavTreeNode> selectedChildren)

Description copied from class: AbstractNavTreeNode

Can this edit action handler handle the copy action, given its current selection? Note that if this and AbstractNavTreeNode.canDelete(java.util.List) both return true, the cut action will also be enabled.

Overrides:

canCopy in class AbstractNavTreeNode

onResourceModified

protected void onResourceModified(ProjectResource resource)

AbstractResourceNavTreeNode adds a project listener to listen for changes to this node's resource. When it is modified, this will be invoked. If you override, you should invoke super() because it controls the node's italic state for modified resources

addOverriddenBadge

protected void addOverriddenBadge(BadgeTreeCellRenderer renderer,
 boolean selected)

getDeleteAction

@Nonnull
protected AbstractNavTreeNode.PopupAction getDeleteAction()

Overrides:

getDeleteAction in class AbstractNavTreeNode

addInheritedBadge

protected void addInheritedBadge(BadgeTreeCellRenderer renderer,
 boolean selected)

getInheritanceString

protected String getInheritanceString()

override

protected AbstractResourceNavTreeNode.OverrideResult override()