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. insertOrOverwriteString
39. insertSpecialChars
40. insertString
41. insertTextOrMoveDot
42. join
43. joinOrDeleteChar
44. listBindings
45. makeParagraphs
46. moveDotTo
47. moveElement
48. overwriteMode
49. overwriteString
50. paste
51. pasteSystemSelection
52. pick
53. prompt
54. putAttribute
55. recordMacro
56. redo
57. refresh
58. reinclude
59. removeAttribute
60. repeat
61. replace
62. replaceText
63. run
64. search
65. searchReplace
66. selectAt
67. selectBlockAtY
68. selectById
69. selectFile
70. selectConvertedFile
71. selectPrinter
72. selectNode
72.1. List of element names or node types
72.2. OrNone, OrNode, OrElement modifiers
73. selectNodeAt
74. selectText
75. selectTo
76. setProperty
77. setReadOnly
78. setObject
79. showContentModel
80. showMatchingChar
81. spellCheck
82. split
83. start
84. status
85. toggleCollapsed
86. undo
87. uninclude
88. updateInclusions
89. viewObject
90. wrap
91. xIncludeText
92. xpathSearch
93. XXE.close
94. XXE.edit
95. XXE.new
96. XXE.open
97. XXE.save
98. XXE.saveAll
99. XXE.saveAs
100. 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.