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:

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

Direct Known Subclasses:

TemplateNode, WindowNode

public abstract class AbstractTopLevelContainerNode
extends AbstractResourceNavTreeNode
implements DesignableWorkspaceListener, ProjectChangeListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractTopLevelContainerNode.SendToAction
protected class	AbstractTopLevelContainerNode.SendToMenu

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

AbstractNavTreeNode.DeleteReason, AbstractNavTreeNode.PopupAction, AbstractNavTreeNode.ResourceChangeListener

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.project.ProjectChangeListener

ProjectChangeListener.ResourceModification

Field Summary

Fields

Modifier and Type	Field and Description
protected TopLevelContainer	container
protected DesignerContext	context
protected java.util.UUID	parentFolder
protected long	resourceId
protected ProjectScope	scope
protected com.google.common.base.Supplier<AbstractTopLevelContainerNode.SendToMenu>	sendToMenu
protected VisionDesignerImpl	vision
protected WindowWorkspace	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

Modifier	Constructor and Description
protected	AbstractTopLevelContainerNode(VisionDesignerImpl fpmi, ProjectResource resource, ProjectScope scope)

Method Summary

Modifier and Type	Method and Description
void	addBadges(BadgeTreeCellRenderer renderer)
protected abstract void	addListeners(TopLevelContainer container)
protected boolean	alterName(java.lang.String newTextValue)
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.
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()
ProjectResource	getProjectResource() The ProjectResource that this node represents
long	getResourceId()
protected abstract java.util.UUID	getRootFolderUUID()
java.lang.String	getText() The text that will be used to render the node
VisionDesignerInterface	getVision()
void	install(AbstractNavTreeNode parent)
boolean	isContainerOpen()
boolean	isEditable() Override this and return true if you want your node's text to be editable.
boolean	isEditActionHandler() Override to return true if you want this node to be an edit action handler for its children.
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	onEdit(java.lang.String newTextValue) Called after this node has been edited in the tree.
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
void	projectResourceModified(ProjectResource resource, ProjectChangeListener.ResourceModification changeType) Return the instance of PropertyChangeListener that will listen to the container.
void	projectUpdated(Project diff) Notifies the listener that the project has been updated externally, by the result of a File-Update or a Save.
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

gatherChildrenIds, isProtected, isProtectedEnabled, selectChild, setProtected, setupEditActions

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

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

vision

protected VisionDesignerImpl vision

workspace

protected WindowWorkspace workspace

context

protected DesignerContext context

resourceId

protected long resourceId

scope

protected ProjectScope scope

parentFolder

protected java.util.UUID parentFolder

container

protected TopLevelContainer container

sendToMenu

protected com.google.common.base.Supplier<AbstractTopLevelContainerNode.SendToMenu> sendToMenu

Constructor Detail

AbstractTopLevelContainerNode

protected AbstractTopLevelContainerNode(VisionDesignerImpl fpmi,
                                        ProjectResource resource,
                                        ProjectScope scope)

Method Detail

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

getVision

public VisionDesignerInterface getVision()

install

public void install(AbstractNavTreeNode parent)

Overrides:

install in class AbstractNavTreeNode

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 AbstractNavTreeNode

addBadges

public void addBadges(BadgeTreeCellRenderer renderer)

Overrides:

addBadges in class AbstractNavTreeNode

getText

public java.lang.String getText()

Description copied from class: AbstractNavTreeNode

The text that will be used to render the node

Overrides:

getText 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

alterName

protected boolean alterName(java.lang.String newTextValue)

removeListeners

protected abstract void removeListeners(TopLevelContainer container)

addListeners

protected abstract void addListeners(TopLevelContainer container)

projectResourceModified

public void projectResourceModified(ProjectResource resource,
                                    ProjectChangeListener.ResourceModification changeType)

Return the instance of PropertyChangeListener that will listen to the container.

Specified by:

projectResourceModified in interface ProjectChangeListener

projectUpdated

public void projectUpdated(Project diff)

Description copied from interface: ProjectChangeListener

Notifies the listener that the project has been updated externally, by the result of a File-Update or a Save. The given project diff will have all of the project's base properties, and will contain the dirty (changed) resources as well as the deleted ones.

Specified by:

projectUpdated in interface ProjectChangeListener

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

getRootFolderUUID

protected abstract java.util.UUID getRootFolderUUID()

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()

getProjectResource

public ProjectResource getProjectResource()

Description copied from class: AbstractResourceNavTreeNode

The ProjectResource that this node represents

Specified by:

getProjectResource in class AbstractResourceNavTreeNode

getResourceId

public long getResourceId()

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 AbstractNavTreeNode

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 AbstractNavTreeNode

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