Package com.inductiveautomation.perspective.designer.workspace.nav

Class ComponentNode

java.lang.Object

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

com.inductiveautomation.perspective.designer.workspace.nav.ComponentNode

All Implemented Interfaces:

Iterable<AbstractNavTreeNode>, TreeNode

public class ComponentNode
extends AbstractNavTreeNode

Created by carlg on 6/13/2017.

Nested Class Summary

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.AbstractNavTreeNode

bold, children, childrenLoaded, copyAction, copyPathAction, cutAction, depth, discardOverridesAction, icon, italic, log, model, name, parent, pasteAction, renameAction, selectionModel, text, thumbnail, tooltip

Constructor Summary

Constructors

Constructor	Description
ComponentNode(ViewResourceEditor editor, ComponentStructure component)

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)
Optional<ComponentNode>	findChild(List<Integer> path)
protected AbstractNavTreeNode.PopupAction	getDeleteAction()
ViewResourceEditor	getEditor()
String	getPath()
PipesFolderNode	getPipesFolderNode()
protected Iterable<AbstractNavTreeNode.PopupAction>	getPopupActions()	Provide a list of PopupActions that will be set up by AbstractNavTreeNode.setupEditActions(javax.swing.tree.TreePath[], java.util.List<com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode>); that is, will have their AbstractNavTreeNode.PopupAction.selection and AbstractNavTreeNode.PopupAction.actionHandler set.
void	install(AbstractNavTreeNode parent)
boolean	isEditable()	Override this and return true if you want your node's text to be editable.
protected List<AbstractNavTreeNode>	loadChildren()	Called before this node responds from any of the children-related TreeNode functions, if a list of children wasn't already set.
protected void	notifyChildNameChanged(AbstractNavTreeNode child)	Called back by {AbstractNavTreeNode.setName(String) so the parent can re-sort its children if necessary.
void	onDeepSelectionChanged(DeepSelectionChangeEvent event)
void	onEdit(String newTextValue)	Called after this node has been edited in the tree.
protected void	uninstall()	Called when the node is removed from the tree.

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

addEditActions, canCopy, canDelete, 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, getWorkspaceName, initPopupMenu, isBold, isEditActionHandler, isItalic, isLeaf, isModuleNode, isRestricted, isSelected, isTopLevelNode, isValidName, iterator, newLogger, onChildrenSelected, onDoubleClick, onSelected, pathToRoot, performOnAllChildren, recreate, recreate, refresh, reload, select, select, setBold, setChildren, setIcon, setItalic, setName, setText, setThumbnail, setTooltip, setupEditActions, 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

ComponentNode

public ComponentNode(@Nullable
 ViewResourceEditor editor,
 ComponentStructure component)

Method Details

getPipesFolderNode

public PipesFolderNode getPipesFolderNode()

getEditor

@Nullable
public ViewResourceEditor getEditor()

install

public void install(AbstractNavTreeNode parent)

Overrides:

install 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 AbstractNavTreeNode

addEditActions

protected void addEditActions(JPopupMenu menu)

Overrides:

addEditActions in class AbstractNavTreeNode

getPopupActions

protected Iterable<AbstractNavTreeNode.PopupAction> getPopupActions()

Description copied from class: AbstractNavTreeNode

Provide a list of PopupActions that will be set up by AbstractNavTreeNode.setupEditActions(javax.swing.tree.TreePath[], java.util.List<com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode>); that is, will have their AbstractNavTreeNode.PopupAction.selection and AbstractNavTreeNode.PopupAction.actionHandler set.

Overrides:

getPopupActions in class AbstractNavTreeNode

getDeleteAction

@Nonnull
protected AbstractNavTreeNode.PopupAction getDeleteAction()

Overrides:

getDeleteAction 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(String newTextValue)

Description copied from class: AbstractNavTreeNode

Called after this node has been edited in the tree.

Overrides:

onEdit in class AbstractNavTreeNode

onDeepSelectionChanged

public void onDeepSelectionChanged(DeepSelectionChangeEvent event)

getPath

public String getPath()

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 AbstractNavTreeNode

Parameters:

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

selected - the state of this node

notifyChildNameChanged

protected void notifyChildNameChanged(AbstractNavTreeNode child)

Description copied from class: AbstractNavTreeNode

Called back by {AbstractNavTreeNode.setName(String) so the parent can re-sort its children if necessary. Simply calls recreate() by default assuming the AbstractNavTreeNode.loadChildren() call sorts alphabetically.

Overrides:

notifyChildNameChanged in class AbstractNavTreeNode

findChild

public Optional<ComponentNode> findChild(List<Integer> path)

loadChildren

protected List<AbstractNavTreeNode> loadChildren()

Description copied from class: AbstractNavTreeNode

Called before this node responds from any of the children-related TreeNode functions, if a list of children wasn't already set. Override to use lazy child loading.

Overrides:

loadChildren in class AbstractNavTreeNode