Package com.inductiveautomation.factorypmi.designer.model.navtree

Class AbstractTopLevelContainerNode

java.lang.Object

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

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

com.inductiveautomation.factorypmi.designer.model.navtree.AbstractTopLevelContainerNode

All Implemented Interfaces:

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

Direct Known Subclasses:

TemplateNode, WindowNode

public abstract class AbstractTopLevelContainerNode
extends AbstractResourceNavTreeNode
implements DesignableWorkspaceListener

Nested Class Summary

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 TopLevelContainer	container
protected VisionDesignerImpl	vision
protected WindowWorkspace	workspace

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

context, 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, icon, italic, log, model, name, parent, pasteAction, renameAction, selectionModel, text, thumbnail, tooltip

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTopLevelContainerNode(VisionDesignerImpl vision, ProjectResource resource)

Method Summary

Modifier and Type	Method	Description
void	addBadges(BadgeTreeCellRenderer renderer, boolean selected)	Add 'badges' to indicate meta information about this node
protected abstract void	addListeners(TopLevelContainer container)
boolean	canCopy(java.util.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(java.util.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(java.util.List<AbstractNavTreeNode> selectedChildren, java.awt.datatransfer.Transferable data)	Can this action handler handle a paste given the data flavors currently available in the clipboard? data may be null.
void	commitIfOpen()	Implement this to commit the resource that is open for editing.
boolean	confirmDelete(java.util.List<? extends AbstractNavTreeNode> selectedChildren)	Used to confirm the delete.
void	containerClosed(DesignableContainer container)
void	containerOpened(DesignableContainer container)
void	containerSelected(DesignableContainer container)
java.awt.datatransfer.Transferable	doCopy(java.util.List<? extends AbstractNavTreeNode> selectedChildren)	Called when the copy action is performed.
java.awt.datatransfer.Transferable	doCut(java.util.List<? extends AbstractNavTreeNode> selectedChildren)	Called when the cut action is performed.
void	doDelete(java.util.List<? extends AbstractNavTreeNode> selectedChildren, AbstractNavTreeNode.DeleteReason reason)	Called when the delete action is performed, if confirmDelete returned true
boolean	doPaste(java.util.List<? extends AbstractNavTreeNode> selectedChildren, java.awt.datatransfer.Transferable clipboardContents, boolean isDrop)	Called when the paste action is performed
protected abstract AbstractNavTreeNode	findChild(java.awt.Component c)
boolean	getAllowsChildren()
VisionDesignerInterface	getVision()
void	install(AbstractNavTreeNode parent)
boolean	isContainerOpen()
boolean	isEditActionHandler()	Override to return true if you want this node to be an edit action handler for its children.
protected boolean	isOpen()	Override this to indicate whether or not this resource is open for editing
void	itemSelectionChanged(java.util.List<javax.swing.JComponent> newSelection)
protected boolean	matches(DesignableContainer container)
void	onChildrenSelected(java.util.List<javax.swing.tree.TreePath> paths)	Called when child nodes (deep) are selected under this node.
void	onSelected()	Called when this node is selected in the tree
protected abstract void	removeListeners(TopLevelContainer container)
protected void	setContainer(TopLevelContainer container, boolean notify)
void	uninstall()	Called when the node is removed from the tree.

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

addConcurrentUsersBadges, addEditActions, addExportMenuItem, addOverrideEnabledMenuItem, addProtectMenuItem, addRevertMenuItem, alterName, gatherChildrenIds, getIcon, getInvalidNameErrorMessage, getPopupActions, getProjectResource, getResourceId, getResourcePath, isChanged, isEditable, isInherited, isLocal, isOverrideEnabled, isProtectedEnabled, isRestricted, isValid, onDoubleClick, onEdit, onResourceModified, open, revert, selectChild, setOverrideEnabled, setProtected, setupEditActions

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

canDrag, canDrop, checkChildren, children, createResourceCopy, debug, debug, dispatchSelectionEvent, expand, expandAndSelect, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getChildAt, getChildCount, getClipboard, getDeleteAction, getDepth, getExpandedIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, getWorkspaceName, initPopupMenu, isBold, isItalic, isLeaf, isSelected, isTopLevelNode, isValidName, iterator, loadChildren, newLogger, notifyChildNameChanged, pathToRoot, 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 Detail

vision

protected VisionDesignerImpl vision

workspace

protected WindowWorkspace workspace

container

protected TopLevelContainer container

Constructor Detail

AbstractTopLevelContainerNode

protected AbstractTopLevelContainerNode(VisionDesignerImpl vision,
                                        ProjectResource resource)

Method Detail

getVision

public VisionDesignerInterface getVision()

install

public void install(AbstractNavTreeNode parent)

Overrides:

install in class AbstractResourceNavTreeNode

uninstall

public 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

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

removeListeners

protected abstract void removeListeners(TopLevelContainer container)

addListeners

protected abstract void addListeners(TopLevelContainer container)

matches

protected boolean matches(DesignableContainer container)

containerClosed

public void containerClosed(DesignableContainer container)

Specified by:

containerClosed in interface DesignableWorkspaceListener

containerOpened

public void containerOpened(DesignableContainer container)

Specified by:

containerOpened in interface DesignableWorkspaceListener

containerSelected

public void containerSelected(DesignableContainer container)

Specified by:

containerSelected in interface DesignableWorkspaceListener

itemSelectionChanged

public void itemSelectionChanged(java.util.List<javax.swing.JComponent> newSelection)

Specified by:

itemSelectionChanged in interface DesignableWorkspaceListener

onSelected

public void onSelected()

Description copied from class: AbstractNavTreeNode

Called when this node is selected in the tree

Overrides:

onSelected in class AbstractNavTreeNode

onChildrenSelected

public void onChildrenSelected(java.util.List<javax.swing.tree.TreePath> paths)

Description copied from class: AbstractNavTreeNode

Called when child nodes (deep) are selected under this node.

Overrides:

onChildrenSelected in class AbstractNavTreeNode

Parameters:

paths - the children selected when the parent node is selected

findChild

protected abstract AbstractNavTreeNode findChild(java.awt.Component c)

setContainer

protected void setContainer(TopLevelContainer container,
                            boolean notify)

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class AbstractNavTreeNode

isContainerOpen

public boolean isContainerOpen()

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

canCopy

public boolean canCopy(java.util.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

canDelete

public boolean canDelete(java.util.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

canPaste

public boolean canPaste(java.util.List<AbstractNavTreeNode> selectedChildren,
                        java.awt.datatransfer.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

doCopy

public java.awt.datatransfer.Transferable doCopy(java.util.List<? extends AbstractNavTreeNode> selectedChildren)

Description copied from class: AbstractNavTreeNode

Called when the copy action is performed.

Overrides:

doCopy in class AbstractNavTreeNode

Returns:

the current selection as a Transferable, or null if the copy failed. Will be added to the system clipboard.

doCut

public java.awt.datatransfer.Transferable doCut(java.util.List<? extends AbstractNavTreeNode> selectedChildren)

Description copied from class: AbstractNavTreeNode

Called when the cut action is performed.

Overrides:

doCut in class AbstractNavTreeNode

Returns:

the current selection as a Transferable, or null if the cut failed. Will be added to the system clipboard.

doDelete

public void doDelete(java.util.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

confirmDelete

public boolean confirmDelete(java.util.List<? extends AbstractNavTreeNode> selectedChildren)

Description copied from class: AbstractNavTreeNode

Used to confirm the delete. If true is returned, doDelete will be called.

Overrides:

confirmDelete in class AbstractNavTreeNode

doPaste

public boolean doPaste(java.util.List<? extends AbstractNavTreeNode> selectedChildren,
                       java.awt.datatransfer.Transferable clipboardContents,
                       boolean isDrop)

Description copied from class: AbstractNavTreeNode

Called when the paste action is performed

Overrides:

doPaste in class AbstractNavTreeNode

clipboardContents - The current contents of the clipboard to paste.

isDrop - Indicates whether this paste originated from a drop action. If false, originated from a keyboard or menu paste shortcut.

Returns:

whether or not the paste successfully completed.

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 AbstractNavTreeNode