Package com.inductiveautomation.ignition.designer.navtree

Class EventScriptSingletonNode

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.navtree.EventScriptSingletonNode

All Implemented Interfaces:

Iterable<AbstractNavTreeNode>, TreeNode

Direct Known Subclasses:

ClientEventScriptNode, GatewayEventScriptNode, PerspectiveGatewayEventScriptNode, SessionEventScriptNode

public abstract class EventScriptSingletonNode
extends FolderNode

A base class for event script nodes in the navigation tree. Handles migration of legacy script configurations and common resource management.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	EventScriptSingletonNode.EventScriptState	Represents the various states of event scripts based on their configuration and migration needs.

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
static final Comparator<AbstractNavTreeNode>	EVENT_RESOURCE_COMPARATOR

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	EventScriptSingletonNode(DesignerContext context, ResourceType resourceType, int scope)

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)
protected AbstractNavTreeNode	createChildNode(Resource resource)
protected abstract ScriptConfig	deserializeConfig(Resource resource)
Icon	getExpandedIcon()	Returns an alternate icon for when this node is expanded, if applicable.
protected abstract Set<ResourceType>	getResourceTypes()
protected void	initPopupMenu(JPopupMenu menu, TreePath[] paths, List<AbstractNavTreeNode> selection, int modifiers)	Default implementation calls setupEditActions(), and then addEditActions()
boolean	isEditActionHandler()	Override to return true if you want this node to be an edit action handler for its children.
boolean	isInherited()	True if this node's resource is inherited from a parent project.
boolean	isOverridden()	True if this node's resource is present and overriding a resource from a parent project.
void	migrateLegacyConfig()
boolean	needsMigration()
protected void	open()	Implement this to open this resource up for editing
protected boolean	shouldHideNodes()

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

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

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

addActionsForInheritedNodes, addConcurrentUsersBadges, addDeleteOrDiscardOverridesMenuItem, addDocumentationMenuItem, addExportMenuItem, addInheritedBadge, addNotesBadge, addOverriddenBadge, addOverrideOrDiscardOverridesMenuItem, addProtectMenuItem, alterName, canCopy, canDelete, commitIfOpen, editDocumentation, gatherChildrenIds, getAdditionalExportIds, getDeleteAction, getInheritanceString, getInvalidNameErrorMessage, getPopupActions, getProjectResource, getResourceId, getResourcePath, inherited, isChanged, isEditable, isLocal, isOpen, isOverrideEnabled, isRestricted, isValid, notInherited, onDoubleClick, onEdit, onResourceModified, 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, 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

EVENT_RESOURCE_COMPARATOR

public static final Comparator<AbstractNavTreeNode> EVENT_RESOURCE_COMPARATOR

Constructor Details

EventScriptSingletonNode

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

Method Details

needsMigration

public boolean needsMigration()

shouldHideNodes

protected boolean shouldHideNodes()

migrateLegacyConfig

public void migrateLegacyConfig()

createChildNode

protected AbstractNavTreeNode createChildNode(Resource resource)

Specified by:

createChildNode in class FolderNode

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

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

open

protected void open()

Description copied from class: AbstractResourceNavTreeNode

Implement this to open this resource up for editing

Overrides:

open in class AbstractResourceNavTreeNode

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

addEditActions

protected void addEditActions(JPopupMenu menu)

Overrides:

addEditActions in class AbstractResourceNavTreeNode

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 FolderNode

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 FolderNode

isInherited

public boolean isInherited()

Description copied from class: AbstractResourceNavTreeNode

True if this node's resource is inherited from a parent project.

Overrides:

isInherited in class AbstractResourceNavTreeNode

deserializeConfig

protected abstract ScriptConfig deserializeConfig(Resource resource)

getResourceTypes

protected abstract Set<ResourceType> getResourceTypes()