Package com.inductiveautomation.factorypmi.designer.model.navtree

Class TemplateFolderNode

java.lang.Object

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

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

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

com.inductiveautomation.factorypmi.designer.model.navtree.TemplateFolderNode

All Implemented Interfaces:

Iterable<AbstractNavTreeNode>, TreeNode

public class TemplateFolderNode
extends FolderNode

Nested Class Summary

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

FolderNode.FindReplaceAction, 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 inherited from class com.inductiveautomation.ignition.designer.navtree.model.FolderNode

expandedIcon, newFolderAction, RESOURCE_COMPARATOR, 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

Constructor	Description
TemplateFolderNode(VisionDesignerImpl fpmi, ProjectResource folder)

Method Summary

Modifier and Type	Method	Description
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	canDrag(List<AbstractNavTreeNode> draggedChildren)	Can the nodes controlled by this action handling node be dragged?
boolean	canDrop(AbstractNavTreeNode dropTarget, List<DataFlavor> flavors)
boolean	canPaste(List<AbstractNavTreeNode> selectedChildren, Transferable clipboard)	Can this action handler handle a paste given the data flavors currently available in the clipboard? data may be null.
protected AbstractNavTreeNode	createChildNode(ProjectResource r)
static TemplateFolderNode	createRootNode(VisionDesignerImpl vision)
Transferable	doCopy(List<? extends AbstractNavTreeNode> selectedChildren)	Called when the copy action is performed.
Transferable	doCut(List<? extends AbstractNavTreeNode> selectedChildren)	Called when the cut action is performed.
void	doDelete(List<? extends AbstractNavTreeNode> selectedChildren, AbstractNavTreeNode.DeleteReason reason)	Called when the delete action is performed, if confirmDelete returned true
boolean	doPaste(List<? extends AbstractNavTreeNode> selectedChildren, Transferable clipboardContents, boolean isDrop)	Called when the paste action is performed
Icon	getExpandedIcon()	Returns an alternate icon for when this node is expanded, if applicable.
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.
int	getSortOrder()	Returns the relative sort order for peers.
String	getWorkspaceName()	Returns the name of the desired workspace for this node.
protected void	initPopupMenu(JPopupMenu menu, TreePath[] paths, List<AbstractNavTreeNode> selection, int modifiers)	Default implementation calls setupEditActions(), and then addEditActions()
protected LoggerEx	newLogger()
void	onSelected()	Called when this node is selected in the tree

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

addOverrideEnabledMenuItem, addRevertMenuItem, canPaste, getPath, getResourceType, install, isEditActionHandler, isOverridden, isProtectedEnabled, isTopLevelNode, loadChildren, modifyOverrideAction, override, pastingOnSelf, project, requiresRecreate, setName, setupEditActions, uninstall

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

addActionsForInheritedNodes, addBadges, addConcurrentUsersBadges, addDeleteOrDiscardOverridesMenuItem, addDocumentationMenuItem, addEditActions, addExportMenuItem, addInheritedBadge, addNotesBadge, addOverriddenBadge, addOverrideOrDiscardOverridesMenuItem, addProtectMenuItem, alterName, canDelete, commitIfOpen, editDocumentation, gatherChildrenIds, getAdditionalExportIds, getDeleteAction, getInheritanceString, getInvalidNameErrorMessage, 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, checkChildren, children, confirmDelete, createResourceCopy, debug, debug, dispatchSelectionEvent, expand, expandAndSelect, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getDepth, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getText, getThumbnail, getTooltip, isBold, isItalic, isLeaf, isModuleNode, isSelected, isValidName, iterator, notifyChildNameChanged, onChildrenSelected, 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

Constructor Details

TemplateFolderNode

public TemplateFolderNode(VisionDesignerImpl fpmi,
 ProjectResource folder)

Method Details

newLogger

protected LoggerEx newLogger()

Overrides:

newLogger in class AbstractNavTreeNode

getWorkspaceName

public String getWorkspaceName()

Description copied from class: AbstractNavTreeNode

Returns the name of the desired workspace for this node. Default behavior is to delegate to the parent. null mean's don't affect workspace selection.

Overrides:

getWorkspaceName in class AbstractNavTreeNode

createRootNode

public static TemplateFolderNode createRootNode(VisionDesignerImpl vision)

doCopy

public Transferable doCopy(List<? extends AbstractNavTreeNode> selectedChildren)

Description copied from class: AbstractNavTreeNode

Called when the copy action is performed.

Overrides:

doCopy in class AbstractNavTreeNode

Returns:

the current selection as a Transferable, or null if the copy failed. Will be added to the system clipboard.

doCut

public Transferable doCut(List<? extends AbstractNavTreeNode> selectedChildren)

Description copied from class: AbstractNavTreeNode

Called when the cut action is performed.

Overrides:

doCut in class AbstractNavTreeNode

Returns:

the current selection as a Transferable, or null if the cut failed. Will be added to the system clipboard.

doPaste

public boolean doPaste(List<? extends AbstractNavTreeNode> selectedChildren,
 Transferable clipboardContents,
 boolean isDrop)

Description copied from class: AbstractNavTreeNode

Called when the paste action is performed

Overrides:

doPaste in class AbstractNavTreeNode

clipboardContents - The current contents of the clipboard to paste.

isDrop - Indicates whether this paste originated from a drop action. If false, originated from a keyboard or menu paste shortcut.

Returns:

whether or not the paste successfully completed.

doDelete

public void doDelete(List<? extends AbstractNavTreeNode> selectedChildren,
 AbstractNavTreeNode.DeleteReason reason)

Description copied from class: AbstractNavTreeNode

Called when the delete action is performed, if confirmDelete returned true

Overrides:

doDelete in class AbstractNavTreeNode

getSortOrder

public int getSortOrder()

Description copied from class: AbstractNavTreeNode

Returns the relative sort order for peers. Not all nav tree node parents will use this sort order, but the root node does. Nodes with equal sort orders will then be sorted by their titles. The default return value here is 0. The config menu node returns Integer.MIN_VALUE.

Overrides:

getSortOrder in class AbstractNavTreeNode

Returns:

relative sort order for peers

canPaste

public boolean canPaste(List<AbstractNavTreeNode> selectedChildren,
 Transferable clipboard)

Description copied from class: AbstractNavTreeNode

Can this action handler handle a paste given the data flavors currently available in the clipboard? data may be null.

Overrides:

canPaste in class AbstractNavTreeNode

canDrag

public boolean canDrag(List<AbstractNavTreeNode> draggedChildren)

Description copied from class: AbstractNavTreeNode

Can the nodes controlled by this action handling node be dragged?

Overrides:

canDrag in class AbstractNavTreeNode

canDrop

public boolean canDrop(AbstractNavTreeNode dropTarget,
 List<DataFlavor> flavors)

Overrides:

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

onSelected

public void onSelected()

Description copied from class: AbstractNavTreeNode

Called when this node is selected in the tree

Overrides:

onSelected in class AbstractNavTreeNode

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 FolderNode

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 AbstractResourceNavTreeNode

createChildNode

protected AbstractNavTreeNode createChildNode(ProjectResource r)

Specified by:

createChildNode in class FolderNode

initPopupMenu

protected void initPopupMenu(JPopupMenu menu,
 TreePath[] paths,
 List<AbstractNavTreeNode> selection,
 int modifiers)

Description copied from class: AbstractNavTreeNode

Default implementation calls setupEditActions(), and then addEditActions()

Overrides:

initPopupMenu in class AbstractNavTreeNode