Package com.inductiveautomation.ignition.designer.navtree.model

Class FolderNode

java.lang.Object

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

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

com.inductiveautomation.ignition.designer.navtree.model.FolderNode

All Implemented Interfaces:

Iterable<AbstractNavTreeNode>, TreeNode

Direct Known Subclasses:

ClientScriptFolderNode, EventScriptFolderNode, EventScriptSingletonNode, PipelineFolderNode, ResourceFolderNode, SfcFolderNode, StyleClassFolderNode, TemplateFolderNode, WindowFolderNode

public abstract class FolderNode
extends AbstractResourceNavTreeNode

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FolderNode.FindReplaceAction
static class	FolderNode.NewFolderAction

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

AbstractResourceNavTreeNode.OverrideResult, 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 Icon	expandedIcon
protected Action	newFolderAction	Action available for use in subclasses to add a new folder.
static final Comparator<Resource>	RESOURCE_COMPARATOR	Sorts resources by path, but with folders first
protected int	resourceScope

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

context, editDocumentationAction, editDocumentationMenuItem, exportAction, inheritedIcon, overrideAction, overrideEnabledAction, overrideEnabledMenuItem, protectedAction, protectedMenuItem, resourceId, resourcePath, restricted, revertAction, 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	FolderNode(DesignerContext context, ResourcePath path, int scope)
protected	FolderNode(DesignerContext context, ResourcePath path, int scope, boolean isModuleNode)
protected	FolderNode(DesignerContext context, Resource resource, int scope)
protected	FolderNode(DesignerContext context, Resource resource, int scope, boolean isModuleNode)
protected	FolderNode(DesignerContext context, ResourceType resourceType, int scope)	Root resource folder constructor.
protected	FolderNode(DesignerContext context, ResourceType resourceType, int scope, boolean isModuleNode)

Method Summary

Modifier and Type	Method	Description
protected void	addOverrideEnabledMenuItem(JPopupMenu menu)
protected void	addRevertMenuItem(JPopupMenu menu)
protected boolean	canPaste(List<TreePath> paths, TreePath droppedOn)	Protect against dropping on self, immediate parent, and descendant
protected abstract AbstractNavTreeNode	createChildNode(Resource resource)
Icon	getExpandedIcon()	Returns an alternate icon for when this node is expanded, if applicable.
protected ResourcePath	getPath()
ResourceType	getResourceType()
void	install(AbstractNavTreeNode parent)
boolean	isEditActionHandler()	Override to return true if you want this node to be an edit action handler for its children.
boolean	isOverridden()	True if this node's resource is present and overriding a resource from a parent project.
boolean	isProtectedEnabled()
protected boolean	isTopLevelNode()	Indicates whether this node is the "root" of a given tree; primarily used to offer different edit options
protected List<AbstractNavTreeNode>	loadChildren()	Called before this node responds from any of the children-related TreeNode functions, if a list of children wasn't already set.
protected void	modifyOverrideAction(BaseAction baseAction)	If subclasses need to modify the #overrideAction they can modify this method.
protected AbstractResourceNavTreeNode.OverrideResult	override()
protected boolean	pastingOnSelf(List<? extends AbstractNavTreeNode> selectedChildren, Transferable transferable)	Returns true (meaning paste should be aborted) if the given folder is being dropped on itself
protected DesignableProject	project()
protected boolean	requiresRecreate(ResourceId id)	Returns true if the project resource is a child of mine.
protected void	setName(String name)
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.AbstractResourceNavTreeNode

addActionsForInheritedNodes, addBadges, addConcurrentUsersBadges, addDeleteOrDiscardOverridesMenuItem, addDocumentationMenuItem, addEditActions, addExportMenuItem, addInheritedBadge, addNotesBadge, addOverriddenBadge, addOverrideOrDiscardOverridesMenuItem, addProtectMenuItem, alterName, canCopy, canDelete, commitIfOpen, editDocumentation, gatherChildrenIds, getAdditionalExportIds, getDeleteAction, getInheritanceString, getInvalidNameErrorMessage, getPopupActions, getProjectResource, getResourceId, getResourcePath, inherited, isChanged, isEditable, isInherited, isLocal, isOpen, isOverrideEnabled, isRestricted, isValid, notInherited, onDoubleClick, onEdit, onResourceModified, open, overridden, revert, selectChild, setOverrideEnabled, setProtected, setRevertedResourcePath

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, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, getWorkspaceName, initPopupMenu, isBold, isItalic, isLeaf, isModuleNode, isSelected, isValidName, iterator, newLogger, notifyChildNameChanged, onChildrenSelected, onSelected, pathToRoot, performOnAllChildren, recreate, recreate, refresh, reload, select, select, setBold, setChildren, setIcon, setItalic, 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

resourceScope

protected int resourceScope

expandedIcon

protected Icon expandedIcon

newFolderAction

protected Action newFolderAction

Action available for use in subclasses to add a new folder. Will use the installed module id to create.

RESOURCE_COMPARATOR

public static final Comparator<Resource> RESOURCE_COMPARATOR

Sorts resources by path, but with folders first

Constructor Details

FolderNode

protected FolderNode(DesignerContext context,
 Resource resource,
 int scope)

FolderNode

protected FolderNode(DesignerContext context,
 Resource resource,
 int scope,
 boolean isModuleNode)

FolderNode

protected FolderNode(DesignerContext context,
 ResourceType resourceType,
 int scope)

Root resource folder constructor.

FolderNode

protected FolderNode(DesignerContext context,
 ResourcePath path,
 int scope)

FolderNode

protected FolderNode(DesignerContext context,
 ResourceType resourceType,
 int scope,
 boolean isModuleNode)

FolderNode

protected FolderNode(DesignerContext context,
 ResourcePath path,
 int scope,
 boolean isModuleNode)

Method Details

isTopLevelNode

protected boolean isTopLevelNode()

Description copied from class: AbstractNavTreeNode

Indicates whether this node is the "root" of a given tree; primarily used to offer different edit options

Overrides:

isTopLevelNode in class AbstractNavTreeNode

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 AbstractResourceNavTreeNode

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 AbstractResourceNavTreeNode

isProtectedEnabled

public boolean isProtectedEnabled()

Overrides:

isProtectedEnabled in class AbstractResourceNavTreeNode

project

protected DesignableProject project()

install

public void install(AbstractNavTreeNode parent)

Overrides:

install in class AbstractResourceNavTreeNode

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 AbstractResourceNavTreeNode

getExpandedIcon

public Icon getExpandedIcon()

Description copied from class: AbstractNavTreeNode

Returns an alternate icon for when this node is expanded, if applicable. Default implementation simply returns getIcon()

Overrides:

getExpandedIcon in class AbstractNavTreeNode

addOverrideEnabledMenuItem

protected void addOverrideEnabledMenuItem(JPopupMenu menu)

Overrides:

addOverrideEnabledMenuItem in class AbstractResourceNavTreeNode

addRevertMenuItem

protected void addRevertMenuItem(JPopupMenu menu)

Overrides:

addRevertMenuItem in class AbstractResourceNavTreeNode

setName

protected void setName(String name)

Overrides:

setName in class AbstractNavTreeNode

requiresRecreate

protected boolean requiresRecreate(ResourceId id)

Returns true if the project resource is a child of mine.

loadChildren

protected List<AbstractNavTreeNode> loadChildren()

Description copied from class: AbstractNavTreeNode

Called before this node responds from any of the children-related TreeNode functions, if a list of children wasn't already set. Override to use lazy child loading.

Overrides:

loadChildren in class AbstractNavTreeNode

getPath

protected ResourcePath getPath()

canPaste

protected boolean canPaste(List<TreePath> paths,
 TreePath droppedOn)

Protect against dropping on self, immediate parent, and descendant

pastingOnSelf

protected boolean pastingOnSelf(List<? extends AbstractNavTreeNode> selectedChildren,
 Transferable transferable)

Returns true (meaning paste should be aborted) if the given folder is being dropped on itself

getResourceType

public ResourceType getResourceType()

createChildNode

protected abstract AbstractNavTreeNode createChildNode(Resource resource)

override

protected AbstractResourceNavTreeNode.OverrideResult override()

Overrides:

override in class AbstractResourceNavTreeNode

modifyOverrideAction

protected void modifyOverrideAction(BaseAction baseAction)

Description copied from class: AbstractResourceNavTreeNode

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.

Overrides:

modifyOverrideAction in class AbstractResourceNavTreeNode

isOverridden

public boolean isOverridden()

Description copied from class: AbstractResourceNavTreeNode

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

Overrides:

isOverridden in class AbstractResourceNavTreeNode