com.inductiveautomation.ignition.alarming.designer.nav

Class PipelineFolderNode

java.lang.Object

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

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

com.inductiveautomation.ignition.designer.navtree.model.FolderNode

com.inductiveautomation.ignition.alarming.designer.nav.PipelineFolderNode

All Implemented Interfaces:

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

public class PipelineFolderNode
extends FolderNode

Nested Class Summary

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

FolderNode.NewFolderAction

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 javax.swing.Action	newPipelineAction

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

allowRenameOnAdd, context, folderId, moduleId, newFolderAction, resourceId, resourceScope

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
PipelineFolderNode(DesignerContext context, PipelineBlockWorkspace workspace) Create the root folder node
PipelineFolderNode(DesignerContext context, PipelineBlockWorkspace workspace, ProjectResource folder) Create a folder node for a sub-folder

Method Summary

Modifier and Type	Method and Description
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	canDrag(java.util.List<AbstractNavTreeNode> draggedChildren) Can the nodes controlled by this action handling node be dragged?
boolean	canDrop(AbstractNavTreeNode dropTarget, java.util.List<java.awt.datatransfer.DataFlavor> flavors)
boolean	canPaste(java.util.List<AbstractNavTreeNode> selectedChildren, java.awt.datatransfer.Transferable clipboard) Can this action handler handle a paste given the data flavors currently available in the clipboard? data may be null.
protected AbstractNavTreeNode	createChildNode(ProjectResource r)
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> children, 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
javax.swing.Icon	getExpandedIcon() Returns an alternate icon for when this node is expanded, if applicable.
int	getSortOrder() Returns the relative sort order for peers.
java.lang.String	getWorkspaceName() Returns the name of the desired workspace for this node.
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()
boolean	isEditActionHandler() Override to return true if you want this node to be an edit action handler for its children.
void	onSelected() Called when this node is selected in the tree
protected DesignerProjectContext	projectCtx() Returns the project context to use.

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

getFolderId, getProjectResource, isAllowRenameOnAdd, isEditable, isProtectedEnabled, loadChildren, onEdit, project, projectResourceModified, projectUpdated, setAllowRenameOnAdd, setName, setupEditActions, uninstall

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

gatherChildrenIds, isProtected, selectChild, setProtected

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

addBadges, addEditActions, checkChildren, children, confirmDelete, debug, debug, dispatchSelectionEvent, expand, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getCommonEditActionHandler, getDepth, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getText, getThumbnail, getTooltip, install, isBold, isItalic, isLeaf, isSelected, iterator, newLogger, notifyChildNameChanged, onChildrenSelected, onDoubleClick, pathToRoot, recreate, refresh, reload, select, select, setBold, setChildren, setIcon, setItalic, 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

newPipelineAction

protected javax.swing.Action newPipelineAction

Constructor Detail

PipelineFolderNode

public PipelineFolderNode(DesignerContext context,
                          PipelineBlockWorkspace workspace)

Create the root folder node

PipelineFolderNode

public PipelineFolderNode(DesignerContext context,
                          PipelineBlockWorkspace workspace,
                          ProjectResource folder)

Create a folder node for a sub-folder

Method Detail

getExpandedIcon

public javax.swing.Icon getExpandedIcon()

Description copied from class: AbstractNavTreeNode

Returns an alternate icon for when this node is expanded, if applicable. Default implementation simply returns getIcon()

Overrides:

getExpandedIcon in class FolderNode

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

projectCtx

protected DesignerProjectContext projectCtx()

Description copied from class: FolderNode

Returns the project context to use. By default returns the normal project. Override to use global project

Overrides:

projectCtx in class FolderNode

getWorkspaceName

public java.lang.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

getSortOrder

public int getSortOrder()

Description copied from class: AbstractNavTreeNode

Returns the relative sort order for peers. Not all nav tree node parents will use this sort order, but the root node does. Nodes with equal sort orders will then be sorted by their titles. The default return value here is 0. The config menu node returns Integer.MIN_VALUE.

Overrides:

getSortOrder in class AbstractNavTreeNode

Returns:

createChildNode

protected AbstractNavTreeNode createChildNode(ProjectResource r)

Specified by:

createChildNode in class FolderNode

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

doDelete

public void doDelete(java.util.List<? extends AbstractNavTreeNode> children,
                     AbstractNavTreeNode.DeleteReason reason)

Description copied from class: AbstractNavTreeNode

Called when the delete action is performed, if confirmDelete returned true

Overrides:

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

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.

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

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

canPaste

public boolean canPaste(java.util.List<AbstractNavTreeNode> selectedChildren,
                        java.awt.datatransfer.Transferable clipboard)

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

canDrag

public boolean canDrag(java.util.List<AbstractNavTreeNode> draggedChildren)

Description copied from class: AbstractNavTreeNode

Can the nodes controlled by this action handling node be dragged?

Overrides:

canDrag in class AbstractNavTreeNode

canDrop

public boolean canDrop(AbstractNavTreeNode dropTarget,
                       java.util.List<java.awt.datatransfer.DataFlavor> flavors)

Overrides:

canDrop in class AbstractNavTreeNode

onSelected

public void onSelected()

Description copied from class: AbstractNavTreeNode

Called when this node is selected in the tree

Overrides:

onSelected in class AbstractNavTreeNode