Chapter 6. Commands written in the Java™ programming language

Table of Contents

1. alert
2. add
3. addAttribute
4. addBlockInFlow
5. beep
6. cancelSelection
7. center
8. checkValidity
9. confirm
10. convert
11. convertCase
12. copy
13. copyAsInclusion
14. copyInclusionEnabled
15. copyChars
16. cut
17. cutInclusionEnabled
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. join
41. joinOrDeleteChar
42. listBindings
43. makeParagraphs
44. moveDotTo
45. moveElement
46. paste
47. pasteInclusionEnabled
48. pasteSystemSelection
49. pick
50. prompt
51. putAttribute
52. recordMacro
53. redo
54. refresh
55. removeAttribute
56. repeat
57. replace
58. run
59. search
60. searchReplace
61. selectAt
62. selectBlockAtY
63. selectById
64. selectFile
65. selectConvertedFile
66. selectPrinter
67. selectNode
67.1. List of element names or node types
67.2. OrNone, OrNode, OrElement modifiers
68. selectNodeAt
69. selectText
70. selectTo
71. setEditable
72. setObject
73. showContentModel
74. showMatchingChar
75. spellCheck
76. split
77. start
78. status
79. toggleCollapsed
80. undo
81. viewObject
82. wrap
83. xpathSearch
84. XXE.close
85. XXE.edit
86. XXE.new
87. XXE.open
88. XXE.openAsTemplate
89. XXE.openCopy
90. XXE.save
91. XXE.saveAll
92. XXE.saveAs
93. XXE.saveCopy
94. A generic, parametrizable, table editor command
95. A generic inclusion command
95.1. Declaring the generic inclusion command and its associated "GenericInclusion" inclusion processor
95.2. The syntax of the generic inclusion command
95.3. Command processors
95.4. The ShellExec command processor
95.5. The Verbatim command processor

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 9, “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.