Package com.inductiveautomation.reporting.designer.workspace.nav

Class ReportNode

java.lang.Object

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

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

com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceNode

com.inductiveautomation.reporting.designer.workspace.nav.ReportNode

All Implemented Interfaces:

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

public class ReportNode
extends ResourceNode

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.tabbedworkspace.ResourceNode

workspace

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

context, editDocumentationAction, editDocumentationMenuItem, 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

Constructor	Description
ReportNode(DesignerContext context, TabbedResourceWorkspace workspace, ProjectResource resource)

Method Summary

Modifier and Type	Method	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	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.
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
boolean	isEditActionHandler()	Override to return true if you want this node to be an edit action handler for its children.
protected java.util.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	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 void	recreate(boolean keepSelection)
protected void	uninstall()	Called when the node is removed from the tree.
boolean	useThumbnailTooltip()

Methods inherited from class com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceNode

closeAndCommit, commitIfOpen, getProjectResource, install, isOpen, onEditorClosed, onEditorOpened, open, setIcon

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

addBadges, addConcurrentUsersBadges, addDocumentationMenuItem, addEditActions, addExportMenuItem, addNotesBadge, addOverrideEnabledMenuItem, addProtectMenuItem, addRevertMenuItem, alterName, editDocumentation, gatherChildrenIds, getIcon, getInvalidNameErrorMessage, getPopupActions, getResourceId, getResourcePath, isChanged, isEditable, isInherited, isLocal, isOverridden, isOverrideEnabled, isProtectedEnabled, isRestricted, isValid, onDoubleClick, onEdit, onResourceModified, revert, selectChild, setOverrideEnabled, setProtected, setRevertedResourcePath, setupEditActions

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

canDrag, canDrop, checkChildren, children, confirmDelete, createResourceCopy, debug, debug, dispatchSelectionEvent, expand, expandAndSelect, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getDeleteAction, getDepth, getExpandedIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, getWorkspaceName, initPopupMenu, isBold, isItalic, isLeaf, isSelected, isTopLevelNode, isValidName, iterator, newLogger, notifyChildNameChanged, onChildrenSelected, pathToRoot, recreate, refresh, reload, select, select, setBold, setChildren, setItalic, setName, setText, setThumbnail, setTooltip, showPopupMenu, toString, uninstallChildren, 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 Detail

ReportNode

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

Method Detail

loadChildren

protected java.util.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

onSelected

public void onSelected()

Description copied from class: AbstractNavTreeNode

Called when this node is selected in the tree

Overrides:

onSelected in class ResourceNode

recreate

protected void recreate(boolean keepSelection)

Overrides:

recreate in class AbstractNavTreeNode

useThumbnailTooltip

public boolean useThumbnailTooltip()

Overrides:

useThumbnailTooltip in class AbstractNavTreeNode

onEditorSelected

protected void onEditorSelected(ResourceEditor editor)

Description copied from class: ResourceNode

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

Overrides:

onEditorSelected in class ResourceNode

onEditorUnselected

protected void onEditorUnselected()

Overrides:

onEditorUnselected in class ResourceNode

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 ResourceNode

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

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

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.

doCopy

@Nullable
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.

canPaste

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

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 AbstractResourceNavTreeNode

doDelete

public void doDelete(@Nonnull
                     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