Chapter 6. Commands written in the Java™ programming language

Table of Contents

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