Chapter 6. Commands written in the Java™ programming language

Table of Contents

1. alert
2. add
3. addAttribute
4. addBlockInFlow
5. addLink
6. autoSpellChecker
7. bookmark
8. beep
9. cancelSelection
10. center
11. checkValidity
12. confirm
13. convert
14. convertCase
15. copy
16. copyAsInclusion
17. copyChars
18. cut
19. declareNamespace
20. delete
21. deleteChar
22. deleteSelectionOrDeleteChar
23. deleteSelectionOrJoinOrDeleteChar
24. deleteWord
25. editAttributes
26. editMenu
27. editObject
28. editPITarget
29. ensureSelectionAt
30. execute
31. extractObject
32. fail
33. followLink
34. formatTextAs
34.1. Specifying an element template for use by command formatTextAs
35. include
36. insert
37. insertCharByName
38. insertCharSequence
39. insertControlChar
40. insertControlCharOrSplit
41. insertNode
42. insertOrOverwriteString
43. insertSpecialChars
44. insertString
45. insertTextOrMoveDot
46. join
47. joinOrDeleteChar
48. listBindings
49. moveDotTo
50. moveElement
51. overwriteMode
52. overwriteString
53. pass
54. paste
55. pasteAfterAs
56. pasteSystemSelection
57. pick
58. prompt
59. putAttribute
60. recordMacro
61. redo
62. refresh
63. reinclude
64. removeAttribute
65. repeat
66. replace
67. replaceText
68. run
69. search
70. searchReplace
71. selectAt
72. selectBlockAtY
73. selectById
74. selectFile
75. selectConvertedFile
76. selectPrinter
77. selectNode
77.1. List of element names or node types
77.2. OrNone, OrNode, OrElement modifiers
78. selectNodeAt
79. selectText
80. selectTo
81. setImageMode
82. setProperty
83. setReadOnly
84. setObject
85. showContentModel
86. showMatchingChar
87. spellCheck
88. split
89. start
90. status
91. toggleCollapsed
92. undo
93. uninclude
94. updateInclusions
95. viewObject
96. webSearch
96.1. Declaring search engines
97. wrap
98. xIncludeText
99. xpathSearch
100. XXE.close
101. XXE.edit
102. XXE.new
103. XXE.open
104. XXE.save
105. XXE.saveAll
106. XXE.saveAs
107. A generic, parametrizable, 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 15, “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 8, “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.