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. copyChars
15. cut
16. decrSectionLevel
17. declareNamespace
18. delete
19. deleteChar
20. deleteSelectionOrDeleteChar
21. deleteSelectionOrJoinOrDeleteChar
22. editAttributes
23. editMenu
24. editPITarget
25. execute
26. extractImage
27. extractObject
28. include
29. incrSectionLevel
30. insert
31. insertCharByName
32. insertControlChar
33. insertControlCharOrSplit
34. insertNode
35. insertSpecialChars
36. insertString
37. join
38. joinOrDeleteChar
39. listBindings
40. makeParagraphs
41. moveDotTo
42. paste
43. pasteInclusionEnabled
44. pasteSystemSelection
45. pick
46. prompt
47. putAttribute
48. recordMacro
49. redo
50. refresh
51. removeAttribute
52. repeat
53. replace
54. resizeSVG
55. run
56. search
57. searchReplace
58. selectAt
59. selectBlockAtY
60. selectById
61. selectFile
62. selectConvertedFile
63. selectPrinter
64. selectNode
64.1. List of element names or node types
64.2. OrNone, OrNode, OrElement modifiers
65. selectNodeAt
66. selectText
67. selectTo
68. setEditable
69. setImage
70. setObject
71. showContentModel
72. showMatchingChar
73. spellCheck
74. split
75. start
76. status
77. toggleCollapsed
78. undo
79. viewHTML
80. wrap
81. xpathSearch
82. XXE.edit
83. XXE.open
84. XXE.openAsTemplate
85. XXE.openCopy
86. XXE.close
87. XXE.save
88. XXE.saveAs
89. XXE.saveCopy

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 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 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.