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:

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

Direct Known Subclasses:

PackageNode, PipelineFolderNode, ResourceFolderNode, SfcFolderNode, TemplateFolderNode, WindowFolderNode

public abstract class FolderNode
extends AbstractResourceNavTreeNode
implements ProjectChangeListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderNode.NewFolderAction

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

AbstractNavTreeNode.DeleteReason, AbstractNavTreeNode.PopupAction, AbstractNavTreeNode.ResourceChangeListener

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.project.ProjectChangeListener

ProjectChangeListener.ResourceModification

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	allowRenameOnAdd
protected DesignerContext	context
protected java.util.UUID	folderId
protected java.lang.String	moduleId
protected javax.swing.Action	newFolderAction Action available for use in subclasses to add a new folder.
protected long	resourceId
protected int	resourceScope

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

Modifier	Constructor and Description
protected	FolderNode(DesignerContext context, ProjectResource folderResource)
protected	FolderNode(DesignerContext context, java.lang.String moduleId, int scope, java.util.UUID folderId) Constructor for root folders that aren't represented by any ProjectResource.

Method Summary

Modifier and Type	Method and Description
protected boolean	canPaste(java.util.List<javax.swing.tree.TreePath> paths, javax.swing.tree.TreePath droppedOn) Protect against dropping on self, immediate parent, and descendant
protected abstract AbstractNavTreeNode	createChildNode(ProjectResource resource)
javax.swing.Icon	getExpandedIcon() Returns an alternate icon for when this node is expanded, if applicable.
java.util.UUID	getFolderId()
ProjectResource	getProjectResource() The ProjectResource that this node represents
static boolean	isAllowRenameOnAdd()
boolean	isEditable() Override this and return true if you want your node's text to be editable.
boolean	isProtectedEnabled() This method is overridden by AbstractProtectableResourceNavTreeNode to check the if the user has the required role to protect resources.
protected java.util.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.
void	onEdit(java.lang.String newTextValue) Called after this node has been edited in the tree.
protected Project	project()
protected DesignerProjectContext	projectCtx() Returns the project context to use.
void	projectResourceModified(ProjectResource resource, ProjectChangeListener.ResourceModification changeType) Notifies listeners when modules from this designer session alter the current project.
void	projectUpdated(Project diff) Notifies the listener that the project has been updated externally, by the result of a File-Update or a Save.
static void	setAllowRenameOnAdd(boolean allowRenameOnAdd)
protected void	setName(java.lang.String name)
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.AbstractResourceNavTreeNode

gatherChildrenIds, install, isProtected, selectChild, setProtected

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

Field Detail

allowRenameOnAdd

protected static boolean allowRenameOnAdd

context

protected DesignerContext context

resourceId

protected long resourceId

folderId

protected java.util.UUID folderId

moduleId

protected java.lang.String moduleId

resourceScope

protected int resourceScope

newFolderAction

protected javax.swing.Action newFolderAction

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

Constructor Detail

FolderNode

protected FolderNode(DesignerContext context,
                     java.lang.String moduleId,
                     int scope,
                     java.util.UUID folderId)

Constructor for root folders that aren't represented by any ProjectResource. Must set the name and text manually

FolderNode

protected FolderNode(DesignerContext context,
                     ProjectResource folderResource)

Method Detail

projectCtx

protected DesignerProjectContext projectCtx()

Returns the project context to use. By default returns the normal project. Override to use global project

Specified by:

projectCtx in class AbstractResourceNavTreeNode

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 AbstractResourceNavTreeNode

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 AbstractResourceNavTreeNode

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

isAllowRenameOnAdd

public static boolean isAllowRenameOnAdd()

setAllowRenameOnAdd

public static void setAllowRenameOnAdd(boolean allowRenameOnAdd)

onEdit

public void onEdit(java.lang.String newTextValue)

Description copied from class: AbstractNavTreeNode

Called after this node has been edited in the tree.

Overrides:

onEdit 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 AbstractResourceNavTreeNode

project

protected Project project()

getFolderId

public java.util.UUID getFolderId()

getExpandedIcon

public javax.swing.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

getProjectResource

public ProjectResource getProjectResource()

Description copied from class: AbstractResourceNavTreeNode

The ProjectResource that this node represents

Specified by:

getProjectResource in class AbstractResourceNavTreeNode

setName

protected void setName(java.lang.String name)

Overrides:

setName in class AbstractNavTreeNode

projectResourceModified

public void projectResourceModified(ProjectResource resource,
                                    ProjectChangeListener.ResourceModification changeType)

Description copied from interface: ProjectChangeListener

Notifies listeners when modules from this designer session alter the current project.

Specified by:

projectResourceModified in interface ProjectChangeListener

projectUpdated

public void projectUpdated(Project diff)

Description copied from interface: ProjectChangeListener

Notifies the listener that the project has been updated externally, by the result of a File-Update or a Save. The given project diff will have all of the project's base properties, and will contain the dirty (changed) resources as well as the deleted ones.

Specified by:

projectUpdated in interface ProjectChangeListener

loadChildren

protected java.util.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

canPaste

protected boolean canPaste(java.util.List<javax.swing.tree.TreePath> paths,
                           javax.swing.tree.TreePath droppedOn)

Protect against dropping on self, immediate parent, and descendant

createChildNode

protected abstract AbstractNavTreeNode createChildNode(ProjectResource resource)