Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransformationOptions

Hierarchy

  • TransformationOptions

Index

Properties

Optional abbreviatedDesc

abbreviatedDesc: undefined | string

An abbreviated description of this transformation.

Optional iconHtml

iconHtml: undefined | string

An HTML representation of the icon associated with this transformation.

Optional needsInput

needsInput: undefined | true | false

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.

Defaults to false if not specified.

Optional treatAsTextInput

treatAsTextInput: undefined | true | false

Indicates whether this transformation needs to be treated as a kind of text input.

The distinction originates with how typing text is treated differently for undo/redo purposes than other changes to a document. We group sequences of keys together, with a default maximum length of 10 keys. So if I type abcdefghijklmn and then undo. The klmn will be removed and then if I do another undo the rest of the text will be undone. The first ten characters were grouped in an undo group, and the last four in another.

Some key presses can trigger transformations, and such transformations need to be treated as text input.

Generated using TypeDoc