Package com.inductiveautomation.ignition.designer.scripteditor.workspace

Class EventScriptFolderNode

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.ignition.designer.scripteditor.workspace.EventScriptFolderNode

All Implemented Interfaces:

Iterable<AbstractNavTreeNode>, TreeNode

public class EventScriptFolderNode
extends FolderNode

Base class for folder nodes managing event scripts in a script workspace.

Provides common functionality for script creation, deletion, and actions. Subclasses must define specific icons, action strings, and resource builders.

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

Modifier and Type	Field	Description
protected Icon	newResourceIcon
protected final TabbedResourceWorkspace	workspace

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

Modifier	Constructor	Description
protected	EventScriptFolderNode(TabbedResourceWorkspace workspace, ResourceType resourceType, String titleKey, int scope, Supplier<Consumer<ResourceBuilder>> defaultResourceBuilder)

Method Summary

Modifier and Type	Method	Description
void	addNewScript(TabbedResourceWorkspace workspace, ResourcePath parentFolder, Consumer<ResourcePath> onAfter)
boolean	canPaste(List<AbstractNavTreeNode> selectedChildren, @Nullable Transferable data)	Can this action handler handle a paste given the data flavors currently available in the clipboard? data may be null.
protected AbstractNavTreeNode	createChildNode(Resource resource)
protected BaseAction	createNewScriptAction()
@Nullable Transferable	doCopy(List<? extends AbstractNavTreeNode> selectedChildren)	Called when the copy 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
protected void	initPopupMenu(JPopupMenu menu, TreePath[] paths, List<AbstractNavTreeNode> selection, int modifiers)	Default implementation calls setupEditActions(), and then addEditActions()
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, getExpandedIcon, 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, 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, checkChildren, children, confirmDelete, createResourceCopy, debug, debug, dispatchSelectionEvent, doCut, expand, expandAndSelect, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getDepth, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, getWorkspaceName, isBold, isItalic, isLeaf, isModuleNode, isSelected, isValidName, iterator, newLogger, 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

Field Details

workspace

protected final TabbedResourceWorkspace workspace

newResourceIcon

protected Icon newResourceIcon

Constructor Details

EventScriptFolderNode

protected EventScriptFolderNode(TabbedResourceWorkspace workspace,
 ResourceType resourceType,
 String titleKey,
 int scope,
 Supplier<Consumer<ResourceBuilder>> defaultResourceBuilder)

Method Details

createChildNode

protected AbstractNavTreeNode createChildNode(Resource resource)

Specified by:

createChildNode in class FolderNode

doCopy

@Nullable
public @Nullable 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.

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

canPaste

public boolean canPaste(List<AbstractNavTreeNode> selectedChildren,
 @Nullable
 @Nullable Transferable data)

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

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.

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

onSelected

public void onSelected()

Description copied from class: AbstractNavTreeNode

Called when this node is selected in the tree

Overrides:

onSelected in class AbstractNavTreeNode

createNewScriptAction

protected BaseAction createNewScriptAction()

addNewScript

public void addNewScript(TabbedResourceWorkspace workspace,
 ResourcePath parentFolder,
 Consumer<ResourcePath> onAfter)