com.inductiveautomation.ignition.designer.tabbedworkspace

Class ResourceNode

java.lang.Object

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

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

com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceNode

All Implemented Interfaces:

java.lang.Iterable<AbstractNavTreeNode>, javax.swing.tree.TreeNode

Direct Known Subclasses:

NamedQueryNode, ReportNode

public class ResourceNode
extends AbstractResourceNavTreeNode

Created by carl.gould on 8/6/2014.

Nested Class Summary

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

AbstractNavTreeNode.DeleteReason, AbstractNavTreeNode.PopupAction, AbstractNavTreeNode.ResourceChangeListener

Field Summary

Fields

Modifier and Type	Field and Description
protected DesignerContext	context
protected long	resourceId
protected TabbedResourceWorkspace	workspace

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

bold, children, childrenLoaded, copyAction, cutAction, deleteAction, depth, icon, italic, log, model, name, NAME_PATTERN, parent, pasteAction, protectedAction, protectedMenuItem, renameAction, selectionModel, text, thumbnail, tooltip

Constructor Summary

Constructors

Constructor and Description
ResourceNode(DesignerContext context, TabbedResourceWorkspace workspace, ProjectResource resource)

Method Summary

Modifier and Type	Method and Description
protected void	addEditActions(javax.swing.JPopupMenu menu, java.util.List<AbstractNavTreeNode> selection) Overloaded AbstractNavTreeNode.addEditActions(JPopupMenu) to support adding menu items which may require the selection, such as the Copy Path action.
void	closeAndCommit()
void	commitIfOpen()
ProjectResource	getProjectResource() The ProjectResource that this node represents
long	getResourceId() Getter for the resourceId
protected void	init(ProjectResource resource)
protected void	initPopupMenu(javax.swing.JPopupMenu menu, javax.swing.tree.TreePath[] paths, java.util.List<AbstractNavTreeNode> selection, int modifiers) Default implementation calls setupEditActions(), and then addEditActions()
void	install(AbstractNavTreeNode parent)
boolean	isEditable() Override this and return true if you want your node's text to be editable.
void	onDoubleClick() Called when this node is double-clicked on.
void	onEdit(java.lang.String newTextValue) Called after this node has been edited in the tree.
protected void	onEditorClosed(ResourceEditor editor)
protected void	onEditorOpened(ResourceEditor editor)
protected void	onEditorSelected(ResourceEditor editor) Called whenever the ResourceEditor for this resource has been opened or selected in the tabbed workspace.
protected void	onEditorUnselected()
void	onSelected() Called when this node is selected in the tree
protected DesignerProjectContext	projectCtx() Returns the project context (local vs global) that this resource belongs to
protected void	uninstall() Called when the node is removed from the tree.

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

gatherChildrenIds, isProtected, isProtectedEnabled, selectChild, setProtected, setupEditActions

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

addBadges, addEditActions, canCopy, canDelete, canDrag, canDrop, canPaste, checkChildren, children, confirmDelete, createProjectCopy, debug, debug, dispatchSelectionEvent, doCopy, doCut, doDelete, doPaste, expand, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getCommonEditActionHandler, getDepth, getExpandedIcon, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, getWorkspaceName, isBold, isEditActionHandler, isItalic, isLeaf, isSelected, isValidName, iterator, loadChildren, newLogger, notifyChildNameChanged, onChildrenSelected, pathToRoot, recreate, refresh, reload, select, select, setBold, setChildren, setIcon, setItalic, setName, setText, setThumbnail, setTooltip, showPopup, showPopupMenu, toString, uninstallChildren, useThumbnailTooltip

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 Detail

context

protected final DesignerContext context

workspace

protected final TabbedResourceWorkspace workspace

resourceId

protected final long resourceId

Constructor Detail

ResourceNode

public ResourceNode(DesignerContext context,
                    TabbedResourceWorkspace workspace,
                    ProjectResource resource)

Method Detail

init

protected void init(ProjectResource resource)

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

install

public void install(AbstractNavTreeNode parent)

Overrides:

install in class AbstractResourceNavTreeNode

onEditorSelected

protected void onEditorSelected(ResourceEditor editor)

Called whenever the ResourceEditor for this resource has been opened or selected in the tabbed workspace.

onEditorUnselected

protected void onEditorUnselected()

onEditorOpened

protected void onEditorOpened(ResourceEditor editor)

onEditorClosed

protected void onEditorClosed(ResourceEditor editor)

getProjectResource

public ProjectResource getProjectResource()

Description copied from class: AbstractResourceNavTreeNode

The ProjectResource that this node represents

Specified by:

getProjectResource in class AbstractResourceNavTreeNode

projectCtx

protected DesignerProjectContext projectCtx()

Description copied from class: AbstractResourceNavTreeNode

Returns the project context (local vs global) that this resource belongs to

Specified by:

projectCtx 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

onDoubleClick

public void onDoubleClick()

Description copied from class: AbstractNavTreeNode

Called when this node is double-clicked on.

Overrides:

onDoubleClick in class AbstractNavTreeNode

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 AbstractNavTreeNode

onEdit

public void onEdit(java.lang.String newTextValue)

Description copied from class: AbstractNavTreeNode

Called after this node has been edited in the tree.

Overrides:

onEdit in class AbstractNavTreeNode

closeAndCommit

public void closeAndCommit()

commitIfOpen

public void commitIfOpen()

getResourceId

public long getResourceId()

Getter for the resourceId

Returns:

The resourceId

addEditActions

protected void addEditActions(javax.swing.JPopupMenu menu,
                              java.util.List<AbstractNavTreeNode> selection)

Overloaded AbstractNavTreeNode.addEditActions(JPopupMenu) to support adding menu items which may require the selection, such as the Copy Path action.

Parameters:

menu - The JPopupMenu to which edit actions will be added

selection - The selected nodes to which the menu applies

initPopupMenu

protected void initPopupMenu(javax.swing.JPopupMenu menu,
                             javax.swing.tree.TreePath[] paths,
                             java.util.List<AbstractNavTreeNode> selection,
                             int modifiers)

Description copied from class: AbstractNavTreeNode

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

Overrides:

initPopupMenu in class AbstractNavTreeNode