Package com.inductiveautomation.ignition.designer.model

Interface EditActionHandler

All Known Implementing Classes:

AbstractEditActionHandler, BlockActionHandler, CodeEditorEditActionHandler, CommonEditActionHandler, CopyPasteHandler, DelegatingEditActionHandler, JavaJsBridgeEditActionHandler, JTableEditActionHandler, JTextComponentEditActionHandler, PythonTextAreaEditActionHandler, ReportingResourceWorkspace.ReportDesignerEditActionHandler, SfcEditActionHandler

public interface EditActionHandler

An EditActionHandler is a class that handles common actions you'd find under an "edit" menu, like cut, copy, paste, and delete. This is used so that all workspaces and focused frames can share the same GUI elements for these actions, and simply 1) handle the actions and 2) tell the system whether or not they are currently enabled.

See Also:

ResourceWorkspace.getEditActionHandler()

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(javax.swing.event.ChangeListener listener)	Add a change listener that will be notified when this handler's responses to the "can-" functions will have changed.
boolean	canCopy()	Can this edit action handler handle the copy action, given its current selection? Note that if this and canDelete() both return true, the cut action will also be enabled.
boolean	canDelete()	Can this edit action handler handle the delete action, given its current selection? Note that if this and canCopy() both return true, the cut action will also be enabled.
boolean	canPaste(java.awt.datatransfer.Clipboard clipboard)	Can this action handler handle a paste given the data flavors currently available in the clipboard?
default boolean	canRename()	Can this action handler handle the rename action, given its current selection.
java.awt.datatransfer.Transferable	doCopy()	Called when the copy action is performed.
java.awt.datatransfer.Transferable	doCut()	Called when the cut action is performed.
void	doDelete()	Called when the delete action is performed
void	doPaste(java.awt.datatransfer.Transferable clipboardContents)	Called when the paste action is performed
default void	doRename()	Called when the rename action is performed
void	removeChangeListener(javax.swing.event.ChangeListener listener)

Method Detail

addChangeListener

void addChangeListener(javax.swing.event.ChangeListener listener)

Add a change listener that will be notified when this handler's responses to the "can-" functions will have changed.

removeChangeListener

void removeChangeListener(javax.swing.event.ChangeListener listener)

canDelete

boolean canDelete()

Can this edit action handler handle the delete action, given its current selection? Note that if this and canCopy() both return true, the cut action will also be enabled.

canCopy

boolean canCopy()

Can this edit action handler handle the copy action, given its current selection? Note that if this and canDelete() both return true, the cut action will also be enabled.

canPaste

boolean canPaste(java.awt.datatransfer.Clipboard clipboard)

Can this action handler handle a paste given the data flavors currently available in the clipboard?

canRename

default boolean canRename()

Can this action handler handle the rename action, given its current selection.

Returns:

true, if the node can be renamed

doRename

default void doRename()

Called when the rename action is performed

doDelete

void doDelete()

Called when the delete action is performed

doCopy

java.awt.datatransfer.Transferable doCopy()

Called when the copy action is performed.

Returns:

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

doCut

java.awt.datatransfer.Transferable doCut()

Called when the cut action is performed.

Returns:

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

doPaste

void doPaste(java.awt.datatransfer.Transferable clipboardContents)

Called when the paste action is performed

Parameters:

clipboardContents - The current contents of the clipboard to paste.