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

Class EventScriptNode

java.lang.Object

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

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

com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceNode

com.inductiveautomation.ignition.designer.scripteditor.workspace.EventScriptNode

All Implemented Interfaces:

Iterable<AbstractNavTreeNode>, TreeNode

Direct Known Subclasses:

AccelerometerScriptTab.AccelerometerScriptNode, AuthChallengeScriptTab.AuthChallengeScriptNode, BarcodeScriptTab.BarcodeScriptNode, BluetoothScriptTab.BluetoothScriptNode, NfcScanScriptTab.NfcScanScriptNode, PageStartupScriptTab.PageStartupScriptNode, ShutdownScriptTab.ShutdownScriptNode, StartupScriptTab.StartupScriptNode, UpdateScriptTab.UpdateScriptNode

public abstract class EventScriptNode
extends ResourceNode

Abstract node for event script nodes, providing common actions like close and commit, and close and revert.

Nested Class Summary

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 final Action	closeAndCommit
protected final Action	closeAndRevert
static final Badge	DISABLED_BADGE

Fields inherited from class com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceNode

workspace

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	EventScriptNode(TabbedResourceWorkspace workspace, ResourcePath resourcePath, Icon icon, @Nullable String titleKey, Supplier<Consumer<ResourceBuilder>> defaultResourceBuilder)
protected	EventScriptNode(TabbedResourceWorkspace workspace, ResourcePath resourcePath, Icon icon, Supplier<Consumer<ResourceBuilder>> defaultResourceBuilder)

Method Summary

Modifier and Type	Method	Description
void	addBadges(BadgeTreeCellRenderer renderer, boolean selected)	Add 'badges' to indicate meta information about this node
protected void	addEditActions(JPopupMenu menu)
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.
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.
void	doDelete(List<? extends AbstractNavTreeNode> selectedChildren, AbstractNavTreeNode.DeleteReason reason)	Called when the delete action is performed, if confirmDelete returned true
protected Icon	getClosedIcon()
protected Icon	getOpenIcon()
boolean	isEditable()	Override this and return true if you want your node's text to be editable.
void	onSelected()	Called when this node is selected in the tree
protected void	open()	Opens the node, creating the resource with the default script if it does not exist.

Methods inherited from class com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceNode

closeAndCommit, commitIfOpen, getProjectResource, install, isOpen, onEditorClosed, onEditorOpened, onEditorSelected, onEditorUnselected, uninstall

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

addActionsForInheritedNodes, addConcurrentUsersBadges, addDeleteOrDiscardOverridesMenuItem, addDocumentationMenuItem, addExportMenuItem, addInheritedBadge, addNotesBadge, addOverriddenBadge, addOverrideEnabledMenuItem, addOverrideOrDiscardOverridesMenuItem, addProtectMenuItem, addRevertMenuItem, alterName, editDocumentation, gatherChildrenIds, getAdditionalExportIds, getDeleteAction, getInheritanceString, getInvalidNameErrorMessage, getPopupActions, getResourceId, getResourcePath, inherited, isChanged, isEditActionHandler, isInherited, isLocal, isOverridden, isOverrideEnabled, isProtectedEnabled, isRestricted, isValid, modifyOverrideAction, notInherited, onDoubleClick, onEdit, onResourceModified, overridden, override, revert, selectChild, setOverrideEnabled, setProtected, setRevertedResourcePath, setupEditActions

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

addEditActions, canDrag, canDrop, checkChildren, children, confirmDelete, createResourceCopy, debug, debug, dispatchSelectionEvent, doCopy, doCut, 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, 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

closeAndCommit

protected final Action closeAndCommit

closeAndRevert

protected final Action closeAndRevert

DISABLED_BADGE

public static final Badge DISABLED_BADGE

Constructor Details

EventScriptNode

protected EventScriptNode(TabbedResourceWorkspace workspace,
 ResourcePath resourcePath,
 Icon icon,
 Supplier<Consumer<ResourceBuilder>> defaultResourceBuilder)

EventScriptNode

protected EventScriptNode(TabbedResourceWorkspace workspace,
 ResourcePath resourcePath,
 Icon icon,
 @Nullable
 @Nullable String titleKey,
 Supplier<Consumer<ResourceBuilder>> defaultResourceBuilder)

Method Details

getOpenIcon

protected Icon getOpenIcon()

Overrides:

getOpenIcon in class ResourceNode

Returns:

The node icon to use when the resource is open for editing

getClosedIcon

protected Icon getClosedIcon()

Overrides:

getClosedIcon in class ResourceNode

Returns:

The node icon to use when the resource is not being edited

addEditActions

protected void addEditActions(JPopupMenu menu)

Overrides:

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

onSelected

public void onSelected()

Description copied from class: AbstractNavTreeNode

Called when this node is selected in the tree

Overrides:

onSelected in class ResourceNode

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 AbstractResourceNavTreeNode

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

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

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

open

protected void open()

Opens the node, creating the resource with the default script if it does not exist. If the resource at the specified path is empty, a new resource is created using the provided resource builder.

Overrides:

open in class ResourceNode

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 AbstractResourceNavTreeNode

Parameters:

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

selected - the state of this node