Chapter 6. Commands written in the Java™ programming language

Table of Contents

1. alert
2. add
3. addAttribute
4. addBlockInFlow
5. autoSpellChecker
6. beep
7. cancelSelection
8. center
9. checkValidity
10. confirm
11. contextualMenu
12. convert
13. convertCase
14. copy
15. copyAsInclusion
16. copyChars
17. copyImage
18. cut
19. declareNamespace
20. delete
21. deleteChar
22. deleteSelectionOrDeleteChar
23. deleteSelectionOrJoinBlockOrDeleteChar
24. deleteWord
25. diffSupport
26. drag
27. drop
28. editAttributes
29. editObject
30. editPITarget
31. ensureSelectionAt
32. execute
33. extendSelectionAt
34. extractObject
35. fail
36. formatTextAs
36.1. Specifying an element template for use by command formatTextAs
36.2. Filtering the text pasted in the document
37. include
38. insert
39. insertCharByName
40. insertCharSequence
41. insertControlChar
42. insertNewlineOrSplitBlock
43. insertNode
44. insertOrOverwriteString
45. insertSpecialChars
46. insertSameBlock
46.1. Specifying splittable blocks
47. insertString
48. insertTextOrMoveDot
49. join
50. joinOrDeleteChar
51. listBindings
52. moveDotTo
53. moveElement
54. overwriteMode
55. overwriteString
56. pass
57. paste
58. pasteAfterAs
59. pasteImageAs
60. pasteSystemSelection
61. pick
62. preview
63. prompt
64. putAttribute
65. recordMacro
66. redo
67. refresh
68. reinclude
69. remark
70. removeAttribute
71. repeat
72. replace
73. replaceText
74. resizeImage
75. run
76. search
77. searchReplace
78. selectAt
79. selectFile
80. selectConvertedFile
81. selectLink
82. selectPrinter
83. selectNode
83.1. List of element names or node types
83.2. OrNone, OrNode, OrElement modifiers
84. selectNodeAt
85. selectText
86. selectTo
87. setImageMode
88. setProperty
89. setReadOnly
90. setObject
91. showContentModel
92. showMatchingChar
93. spellCheck
94. split
95. start
96. status
97. toggleCollapsed
98. toggleTextStyle
99. undo
100. uninclude
101. updateInclusions
102. viewObject
103. webSearch
103.1. Declaring search engines
104. wrap
105. xIncludeText
106. xpathSearch
107. XXE.close
108. XXE.compare
109. XXE.edit
110. XXE.editInclusion
111. XXE.new
112. XXE.open
113. XXE.save
114. XXE.saveAll
115. XXE.setReadOnly
116. XXE.saveAs
117. A generic, parameterizable, table editor command

In the following command reference:

selected node

means

  • the explicitly selected single node;

  • OR the node (text, comment, processing-instruction or element) containing the caret, if there is no explicit node selection and if the [implicitNode] option is used in the parameter of the command;

  • OR the element containing the textual node (text, comment, processing-instruction) containing the caret, if there is no explicit node selection and if the [implicitElement] option is used in the parameter of the command.

selected nodes

means

  • the explicitly selected single node or node range;

  • OR the node (text, comment, processing-instruction or element) containing the caret, if there is no explicit node selection and if the [implicitNode] option is used in the parameter of the command;

  • OR the element containing the textual node (text, comment, processing-instruction) containing the caret, if there is no explicit node selection and if the [implicitElement] option is used in the parameter of the command.

argument node

means

  • an empty text node, if the parameter of the command ends with #text;

  • OR an automatically generated empty element (see configuration element newElementContent in Section 17, “newElementContent” in XMLmind XML Editor - Configuration and Deployment), if the parameter of the command ends with an element name;

  • OR a copy of an element template (see configuration element elementTemplate in Section 10, “elementTemplate” in XMLmind XML Editor - Configuration and Deployment), if the parameter of the command ends with an element template name.

If the argument node is not explicitly specified in the parameter of a command, a dialog box is displayed and the user will have to interactively specify it.

Note that namespace prefixes cannot be used inside the parameter of a command. Notation {namespace_URI}local_name must be used instead.

Example 1: {http://www.w3.org/1999/xhtml}p means p in the http://www.w3.org/1999/xhtml namespace.

Example 2: p means p with no namespace.

These non-terminals are sometimes used in the synopsis of a parameter of a command:

implicit_selection -> '[implicitNode]' | '[implicitElement]'

argument_node -> '#text' | 
                 element_name | 
                 '#template(' element_name ',' template_name ')'

element_name -> Name | '{' namespace_URI '}' NCName

namespace_uri -> anyURI

In the synopsis of a parameter of a command, S means space.

Note that whitespace is not allowed inside the #template() construct. That is, "#template( figure, image )" will not work while "#template(figure,image)" will work.