com.inductiveautomation.ignition.designer.navtree.model

Class ResourcePasteAction

java.lang.Object

com.inductiveautomation.ignition.designer.navtree.model.AbstractResourceUndoAction

com.inductiveautomation.ignition.designer.navtree.model.ResourcePasteAction

All Implemented Interfaces:

UndoManager.UndoAction

public class ResourcePasteAction
extends AbstractResourceUndoAction

Constructor Summary

Constructors

Constructor and Description
ResourcePasteAction(DesignerProjectContext context, AbstractNavTreeNode sourceNode, AbstractResourceNavTreeNode parentNode, Project toPaste, java.util.UUID toPasteInto, java.lang.String moduleId, java.lang.String objectKey) Creates a paste undo action.
ResourcePasteAction(DesignerProjectContext context, AbstractResourceNavTreeNode parentNode, Project toPaste, java.util.UUID toPasteInto, java.lang.String moduleId, java.lang.String objectKey) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	actionKey()
protected int	actionSize()
boolean	execute() This function executes (redoes) the action
boolean	isGroupSequenceIndependent() This function should return true if a group of these actions can be undone by ONLY calling undo() on the first action in the group, and redone by ONLY calling execute() on the last action in the group.
protected java.lang.String	objectKey()
static Project	prepForPaste(DesignerProjectContext context, Project fromClipboard, java.util.UUID pasteInto, java.lang.String moduleId) Preps a Project object that was just deserialized out of the clipboard for pasting underneath a given folder node.
boolean	undo() This function will reverse the action

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

extractProjectResources, getDescription, requestLocks, updateAndReleaseLocks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourcePasteAction

@Deprecated
public ResourcePasteAction(DesignerProjectContext context,
                                       AbstractResourceNavTreeNode parentNode,
                                       Project toPaste,
                                       java.util.UUID toPasteInto,
                                       java.lang.String moduleId,
                                       java.lang.String objectKey)

Deprecated.

Backwards compatible method for pre-7.8.3 Vision modules. Deprecated due to lack of a sourceNode object, which can cause issues with folder reload after an undo operation.

ResourcePasteAction

public ResourcePasteAction(DesignerProjectContext context,
                           AbstractNavTreeNode sourceNode,
                           AbstractResourceNavTreeNode parentNode,
                           Project toPaste,
                           java.util.UUID toPasteInto,
                           java.lang.String moduleId,
                           java.lang.String objectKey)

Creates a paste undo action. Will "prep" the project on the first execute.

Parameters:

parentNode - Used to select the child nodes after the paste. Optional.

Method Detail

prepForPaste

public static Project prepForPaste(DesignerProjectContext context,
                                   Project fromClipboard,
                                   java.util.UUID pasteInto,
                                   java.lang.String moduleId)
                            throws java.lang.Exception

Preps a Project object that was just deserialized out of the clipboard for pasting underneath a given folder node. All project resources will be given new resourceIds. All folders will be given new UUIDs, and dependent resources will be re-pointed. Resources that point to folders not defined in the project fromClipboard (including the null folder, will be re-assigned to belonging to the pasteInto argument (which may be null, in turn)

Throws:

java.lang.Exception

actionKey

protected java.lang.String actionKey()

Specified by:

actionKey in class AbstractResourceUndoAction

objectKey

protected java.lang.String objectKey()

Specified by:

objectKey in class AbstractResourceUndoAction

actionSize

protected int actionSize()

Specified by:

actionSize in class AbstractResourceUndoAction

execute

public boolean execute()

Description copied from interface: UndoManager.UndoAction

This function executes (redoes) the action

Returns:

false if the execution failed

undo

public boolean undo()

Description copied from interface: UndoManager.UndoAction

This function will reverse the action

Returns:

false if the undo failed

isGroupSequenceIndependent

public boolean isGroupSequenceIndependent()

Description copied from interface: UndoManager.UndoAction

This function should return true if a group of these actions can be undone by ONLY calling undo() on the first action in the group, and redone by ONLY calling execute() on the last action in the group.