The editor to which this action belongs.
A simple string description of the action.
An abbreviated description, suitable to put into a button, for instance.
HTML code that represents an icon for this action. This can be a simple string or something more complex.
Indicates whether this action needs input from the
user. For instance, an action which brings up a modal dialog to ask
something of the user must have this parameter set to true. It is
important to record whether an action needs input because, to take one
example, the autoinsert logic will try to insert automatically any
element it can. However, doing this for elements that need user input will
just confuse the user (or could cause a crash). Therefore, it is important
that the insertion operations for such elements be marked with
needsInput set to true so that the autoinsert logic backs off
from trying to insert these elements.
An abbreviated description, suitable to put into a button, for instance.
A simple string description of the action.
The editor to which this action belongs.
HTML code that represents an icon for this action. This can be a simple string or something more complex.
Indicates whether this action needs input from the
user. For instance, an action which brings up a modal dialog to ask
something of the user must have this parameter set to true. It is
important to record whether an action needs input because, to take one
example, the autoinsert logic will try to insert automatically any
element it can. However, doing this for elements that need user input will
just confuse the user (or could cause a crash). Therefore, it is important
that the insertion operations for such elements be marked with
needsInput set to true so that the autoinsert logic backs off
from trying to insert these elements.
An event handler. By default just calls execute. You probably want to
use boundHandler rather than rebind this method. This handler always
returns undefined and calls preventDefault() on the event passed to
it.
The DOM event.
Arbitrary data. What data must be passed is determined by the action.
Gets the abbreviated description for this action.
The abbreviated description.
Gets a description for this action.
A description for the action.
Gets a description for this action, contextualized by the data passed.
The same data that would be passed to execute.
The description.
Gets the icon.
The icon. This is an HTML string.
This method returns the icon together with the description for the data passed as parameter.
The same data that would be passed to execute.
The icon and the description, combined for presentation.
An event handler. By default just calls eventHandler. You probably want
to use boundTerminalHandler rather than rebind this method. This
handler always returns false and calls preventDefault() and
stopPropagation on the event passed to it.
The DOM event.
False.
Converts this action to a string. By default calls getDescription.
Generated using TypeDoc
Actions model "things the user can do." These can be contextual menu items, menu items, buttons, keybindings, etc. The base class is always enabled but derived classes can set their own enabled state depending on whatever conditions they choose.