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

Class ModuleNode

java.lang.Object

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

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

com.inductiveautomation.ignition.designer.scripteditor.workspace.ModuleNode

All Implemented Interfaces:

Iterable<AbstractNavTreeNode>, TreeNode

public class ModuleNode
extends AbstractResourceNavTreeNode

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 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	ModuleNode(DesignerContext context, ScriptWorkspace workspace, ProjectResourceId resourceId)

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)
void	commitIfOpen()	Implement this to commit the resource that is open for editing.
protected String	getInvalidNameErrorMessage(String attemptedName)
String	getWorkspaceName()	Returns the name of the desired workspace for this node.
protected boolean	isOpen()	Override this to indicate whether or not this resource is open for editing
protected boolean	isValidName(String aName)
void	onSelected()	Called when this node is selected in the tree
protected void	open()	Implement this to open this resource up for editing
protected void	uninstall()	Called when the node is removed from the tree.

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

addActionsForInheritedNodes, addConcurrentUsersBadges, addDeleteOrDiscardOverridesMenuItem, addDocumentationMenuItem, addExportMenuItem, addInheritedBadge, addNotesBadge, addOverriddenBadge, addOverrideEnabledMenuItem, addOverrideOrDiscardOverridesMenuItem, addProtectMenuItem, addRevertMenuItem, alterName, canCopy, canDelete, editDocumentation, gatherChildrenIds, getAdditionalExportIds, getDeleteAction, getInheritanceString, getPopupActions, getProjectResource, getResourceId, getResourcePath, inherited, install, isChanged, isEditable, 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, canPaste, checkChildren, children, confirmDelete, createResourceCopy, debug, debug, dispatchSelectionEvent, doCopy, doCut, doDelete, doPaste, expand, expandAndSelect, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getDepth, getExpandedIcon, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, initPopupMenu, isBold, isItalic, isLeaf, isModuleNode, isSelected, isTopLevelNode, 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

Constructor Details

ModuleNode

protected ModuleNode(DesignerContext context,
 ScriptWorkspace workspace,
 ProjectResourceId resourceId)

Method Details

addEditActions

protected void addEditActions(JPopupMenu menu)

Overrides:

addEditActions in class AbstractResourceNavTreeNode

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

open

protected void open()

Description copied from class: AbstractResourceNavTreeNode

Implement this to open this resource up for editing

Overrides:

open in class AbstractResourceNavTreeNode

isOpen

protected boolean isOpen()

Description copied from class: AbstractResourceNavTreeNode

Override this to indicate whether or not this resource is open for editing

Overrides:

isOpen in class AbstractResourceNavTreeNode

commitIfOpen

public void commitIfOpen()

Description copied from class: AbstractResourceNavTreeNode

Implement this to commit the resource that is open for editing.

Overrides:

commitIfOpen 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

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

isValidName

protected boolean isValidName(@Nonnull
 String aName)

Overrides:

isValidName in class AbstractNavTreeNode

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

getInvalidNameErrorMessage

protected String getInvalidNameErrorMessage(String attemptedName)

Overrides:

getInvalidNameErrorMessage in class AbstractResourceNavTreeNode