Package com.inductiveautomation.ignition.designer.model

Class DelegatingEditActionHandler

java.lang.Object

com.inductiveautomation.ignition.designer.model.AbstractEditActionHandler

com.inductiveautomation.ignition.designer.model.DelegatingEditActionHandler

All Implemented Interfaces:

EditActionHandler

public class DelegatingEditActionHandler
extends AbstractEditActionHandler

An EditActionHandler which delegates to an injected delegate EditActionHandler. If the delegate is set to null, this handler will report that it cannot copy / cut / paste / delete and if another object tries to invoke the do* methods on this handler, they will be no-ops. This class is useful for chaining focused components all the way up to the Designer itself for handling the main edit menu edit actions.

Field Summary

Fields inherited from class com.inductiveautomation.ignition.designer.model.AbstractEditActionHandler

listenerList

Constructor Summary

Constructors

Constructor	Description
DelegatingEditActionHandler(EditActionHandler delegate)	Constructor for injecting the EditActionHandler delegate (can be null)

Method Summary

Modifier and Type	Method	Description
boolean	canCopy()	Can this edit action handler handle the copy action, given its current selection? Note that if this and EditActionHandler.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 EditActionHandler.canCopy() both return true, the cut action will also be enabled.
boolean	canPaste(Clipboard clipboard)	Can this action handler handle a paste given the data flavors currently available in the clipboard?
Transferable	doCopy()	Called when the copy action is performed.
Transferable	doCut()	Called when the cut action is performed.
void	doDelete()	Called when the delete action is performed
void	doPaste(Transferable clipboardContents)	Called when the paste action is performed
EditActionHandler	getDelegate()	Getter for the current delegate to whom this handler is delegating all edit actions
void	setDelegate(EditActionHandler delegate)	Setter for the delegate of this handler.

Methods inherited from class com.inductiveautomation.ignition.designer.model.AbstractEditActionHandler

addChangeListener, fireChangeEvent, removeChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.designer.model.EditActionHandler

canRename, doRename

Constructor Details

DelegatingEditActionHandler

public DelegatingEditActionHandler(EditActionHandler delegate)

Constructor for injecting the EditActionHandler delegate (can be null)

Parameters:

delegate - The delegate to inject

See Also:

• DelegatingEditActionHandler

Method Details

getDelegate

public EditActionHandler getDelegate()

Getter for the current delegate to whom this handler is delegating all edit actions

Returns:

The current delegate

setDelegate

public void setDelegate(EditActionHandler delegate)

Setter for the delegate of this handler. Fires a change event to notify the listeners that the edit handling behavior is changed by way of delegation

Parameters:

delegate - The delegate to whom this handler will delegate all edit actions

See Also:

• AbstractEditActionHandler.fireChangeEvent()
• DelegatingEditActionHandler

canDelete

public boolean canDelete()

Description copied from interface: EditActionHandler

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

canCopy

public boolean canCopy()

Description copied from interface: EditActionHandler

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

canPaste

public boolean canPaste(Clipboard clipboard)

Description copied from interface: EditActionHandler

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

doDelete

public void doDelete()

Description copied from interface: EditActionHandler

Called when the delete action is performed

doCopy

public Transferable doCopy()

Description copied from interface: EditActionHandler

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

public Transferable doCut()

Description copied from interface: EditActionHandler

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

public void doPaste(Transferable clipboardContents)

Description copied from interface: EditActionHandler

Called when the paste action is performed

Parameters:

clipboardContents - The current contents of the clipboard to paste.