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. followLink
33. formatTextAs
33.1. Specifying an element template for use by command formatTextAs
34. include
35. insert
36. insertCharByName
37. insertCharSequence
38. insertControlChar
39. insertControlCharOrSplit
40. insertNode
41. insertOrOverwriteString
42. insertSpecialChars
43. insertString
44. insertTextOrMoveDot
45. join
46. joinOrDeleteChar
47. listBindings
48. moveDotTo
49. moveElement
50. overwriteMode
51. overwriteString
52. paste
53. pasteAfterAs
54. pasteSystemSelection
55. pick
56. prompt
57. putAttribute
58. recordMacro
59. redo
60. refresh
61. reinclude
62. removeAttribute
63. repeat
64. replace
65. replaceText
66. run
67. search
68. searchReplace
69. selectAt
70. selectBlockAtY
71. selectById
72. selectFile
73. selectConvertedFile
74. selectPrinter
75. selectNode
75.1. List of element names or node types
75.2. OrNone, OrNode, OrElement modifiers
76. selectNodeAt
77. selectText
78. selectTo
79. setImageMode
80. setProperty
81. setReadOnly
82. setObject
83. showContentModel
84. showMatchingChar
85. spellCheck
86. split
87. start
88. status
89. toggleCollapsed
90. undo
91. uninclude
92. updateInclusions
93. viewObject
94. webSearch
94.1. Declaring search engines
95. wrap
96. xIncludeText
97. xpathSearch
98. XXE.close
99. XXE.edit
100. XXE.new
101. XXE.open
102. XXE.save
103. XXE.saveAll
104. XXE.saveAs
105. 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.