Package com.inductiveautomation.ignition.designer.model

Class CommonEditActionHandler<T extends Component>

java.lang.Object

com.inductiveautomation.ignition.designer.model.AbstractEditActionHandler

com.inductiveautomation.ignition.designer.model.CommonEditActionHandler<T>

Type Parameters:

T - The Component extension whose edit actions will be handled

All Implemented Interfaces:

EditActionHandler

Direct Known Subclasses:

CodeEditorEditActionHandler, JTableEditActionHandler, JTextComponentEditActionHandler, PythonTextAreaEditActionHandler

public abstract class CommonEditActionHandler<T extends Component>
extends AbstractEditActionHandler

Abstract base class which takes care of some boilerplate for handling edit actions of Components. The canCopy(), canDelete(), and canPaste(Clipboard) methods return true when the injected component is the focus owner. The doCut() method essentially delegates to EditActionHandler.doCopy() and EditActionHandler.doDelete()

Field Summary

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

listenerList

Constructor Summary

Constructors

Constructor	Description
CommonEditActionHandler(T component)	Constructor for injecting the Component extension

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	doCut()	Called when the cut action is performed.
T	getComponent()	Getter for the Component extension which was injected during construction

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, doCopy, doDelete, doPaste, doRename

Constructor Details

CommonEditActionHandler

public CommonEditActionHandler(T component)
                        throws NullPointerException

Constructor for injecting the Component extension

Parameters:

component - The Component extension to inject

Throws:

NullPointerException - if the component is null

Method Details

getComponent

public T getComponent()

Getter for the Component extension which was injected during construction

Returns:

The Component extension which was injected during construction

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?

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.