uiconfig
Wrapper for the elements actions , menubar and contextmenu which in turn group the other elements of the user interface configuration file.
None.
actions, menubar, contextmenu
iconstyle (classic|modern) #IMPLIED
Determines the icon set that is used in the editor. There are two icon sets: classic and modern. The default is "classic".
<uiconfig iconstyle="modern"> ... </uiconfig>
actions
Wrapper for the elements action , actionurl and actionjs which allow the definition of custom actions or the overwriting of default actions.
uiconfig
action, actionurl, actionjs
defaultshortcuts (enabled|disabled) "enabled"
If defaultshortcuts is set to "disabled", the default keyboard shortcuts of all editor actions are disabled.
<actions> <action id="REDO" /> </actions>
action
Allows to define a custom action or to overwrite a default action.
actions
shortcut
id CDATA #REQUIRED
Determines the unique id of the action. This id will be used by a toolbar button, pull down menu item or context menu item to refer to this action.
icon CDATA #IMPLIED
Indicates the location of an icon which will be used to display this action in the pull down menu, the toolbar and the context menu. The path may be relative to the editor's codebase.
class CDATA #IMPLIED
Indicates a custom Java class to be called when this action is fired.
enabledinsourceview (true|false) "false"
Determines whether the action will be enabled in source view or not.
The default actions defined in edit-on Pro may have no effect in source view. The actions available per default were implemented with attention to the WYSIWYG mode only.
enabledinreadonlymode (true|false) "false"
Determines whether the action will be enabled when the editor is in read-only mode view or not.
enabled (true|false) "true"
Determines whether the action is enabled.
defaultshortcut (enabled|disabled) "enabled"
If defaultshortcut is set to "disabled", the default keyboard shortcuts of the corresponding editor action are disabled.
alwaysenabledinwysiwyg (true|false) "false"
Determines whether the action is always enabled in WYSIWYG mode. If set to true, the action is even active when the caret is placed within read-only elements, or if the editor is in read-only mode.
<action id="REDO" icon="icons/templatepicker.gif"
class="com.realobjects.customdialogs.templatepicker.TemplatePicker"
enabledinsourceview="false">
<shortcut id="control Z" default="true" />
</action>
actionjs
Allows to define a custom JavaScript action.
actions
shortcut, parameterjs
id CDATA #REQUIRED
Determines the unique id of the action. This id may be used by a tool bar button, pull down menu item or context menu item to refer to this action.
icon CDATA #IMPLIED
Indicates the location of an icon which will be used to display this action in the pull down menu, the toolbar or the context menu. The path may be relative to the editor's codebase.
jsfunction CDATA #REQUIRED
The name of a JavaScript function to be called when this action is fired. The function must be defined in the web page containing the editor. The specified function will receive a reference to the editor as first parameter to facilitate the communication with the editor.
enabledinsourceview (true|false) "false"please
Determines whether the action is enabled in source view or not.
enabled (true|false) "true"
Determines whether the action is enabled.
<actionjs id="INSERTDATE" jsfunction="insertDate">
<shortcut id="control ." default="true" />
</actionjs>parameterjs
Allows to define a parameter that will be receiced by the JavaScript function specified in its parent jsaction element.
actions
shortcut, parameterjs
parameter CDATA #REQUIRED
Specifies a parameter that will be received by the JavaScript function specified in its parent jsaction element. The first parameter received by the JavaScript function will always be a reference to the editor, this means additional parameters passed via parameterjs will passed as second, third, etc. parameters.
<actionjs id="INSERTDATE" jsfunction="insertDate">
<parameterjs parameter="2004-09-16" />
</actionjs>actionurl
Allows to define an action opening an URL when fired.
actions
shortcut
id CDATA #REQUIRED
Determines the unique id of the action. This id may be used by a toolbar button, pull down menu item or context menu item to refer to this action.
icon CDATA #IMPLIED
Indicates the location of an icon which will be used to display this action in the pull down menu, the toolbar or the context menu. The path may be relative to the editor's codebase.
target CDATA #IMPLIED
Determines the target frame in which the URL will be opened.
url CDATA #REQUIRED
Specifies the URL that will be opened when the action is fired.
enabledinsourceview (true|false) "false"
Determines whether the action is enabled in source view or not.
enabled (true|false) "true"
Determines whether the action is enabled at all.
<actionurl id="ROWEBSITE"
url="http://www.realobjects.com"
target="_new" />shortcut
Allows to define a shortcuts for an action. The shortcuts will fire the action when they are used.
action, actionjs, actionurl
None.
id CDATA #REQUIRED
Specifies a keystroke combination for the shortcut.
default (true|false) "false"
If multiple shortcuts are defined for an action, only the default shortcut will be displayed in the editor menus.
<shortcut id="control Z" default="true" />
menubar
Wrapper for the menu elements which define the individual menus available in the pulldown menu's menubar.
uiconfig
menu
None.
<menubar>
<menu localeid="&File">
<menuitem actionid="NEW" />
</menu>
<menu localeid="&Edit">
<menuitem actionid="COPY"/>
</menu>
</menubar>menu
Defines a menu in either the context menu or the pull down menu. A menu may contain other menus as well as separators and menu items.
menubar, menu, contextmenu
menu, menuitem, separator
localeid CDATA #IMPLIED
The editor will search for this localeid in the locale specified by the locale or localeurl property and display the corresponding locale string. If no corresponding localeid can be found, the localeid is displayed textually. If this attribute is not specified, the editor will display a default localized version of the menu depending on the locale is used.
"&" can be used within localeid to specify a mnemonic for the corresponding menu or menuitem.
<menu localeid="&File">
<menuitem actionid="NEW"/>
<menuitem actionid="LOAD"/>
<menuitem actionid="OPENFILE"/>
<separator/>
<menuitem actionid="DOCSTAT"/>
</menu>menuitem
Defines a menuitem inside a menu.
menu
None.
localeid CDATA #IMPLIED
The editor will search for this localeid in the locale specified by the locale or localeurl property and display the corresponding locale string. If no corresponding localeid can be found, the localeid is displayed textually. If this attribute is not specified, the editor will display a default localized version of the menu item depending on the locale that is used.
actionid CDATA #REQUIRED
Determines the id of the action that is fired when the menuitem is clicked.
<menuitem localeid="&New" actionid="NEW"/>
toolbar
Defines the editor's toolbar.
uiconfig
button, buttongroup, choice, separator, endrow
collapse (true|false) "false"
Specifies whether the toolbar is collapsed to one line after the editor is initialized. The toolbar may be expanded manually.
classicbuttonstyle (true|false)
Specifies whether toolbar buttons are painted by Swing or by edit-on Pro. If set to true, the buttons are painted by Swing.
<toolbar collapse="false"
classicbuttonstyle="false">
<button localeid="New" actionid="NEW" enabled="true"/>
<button localeid="Open" actionid="LOAD"/>
<separator/>
<button localeid="Cut" actionid="CUT"/>
</toolbar>button
Defines a toolbar button.
toolbar
None.
localeid CDATA #IMPLIED
The editor will search for this localeid in the locale specified by the locale or localeurl property and display the corresponding locale string. If no corresponding localeid can be found, the localeid is displayed textually. If this attribute is not specified, the editor will display a default localized version of the button name depending on the locale that is used.
actionid CDATA #REQUIRED, please
Determines the id of the action that is fired when the menuitem is clicked.
<button actionid="CUT" />
buttongroup
Specifies a special button type which functions like a normal button element . Additionally, the buttongroup has a small arrow selector allowing the user to select one out of multiple subbutton buttons.
toolbar
subbutton
localeid CDATA #IMPLIED
The editor will search for this localeid in the locale specified by the locale or localeurl property and display the corresponding locale string. If no corresponding localeid can be found, the localeid is displayed textually. If this attribute is not specified, the editor will display a default localized version of the button name depending on the locale that is used.
actionid CDATA #REQUIRED
Determines the id of the action that is fired when the menuitem is clicked.
<buttongroup localeid="Ordered List" actionid="ORDEREDLIST">
<subbutton localeid="Lower Alpha Orderedlist" actionid="LOWERALPHAORDEREDLIST"/>
<subbutton localeid="Upper Alpha Orderedlist" actionid="UPPERALPHAORDEREDLIST"/>
<subbutton localeid="Number Alpha Orderedlist" actionid="NUMBERALPHAORDEREDLIST"/>
</buttongroup>subbutton
Specifies a button being displayed after clicking on the arrow selector of the parent buttongroup .
buttongroup
None.
localeid CDATA #IMPLIED
The editor will search for this localeid in the locale specified by the locale or localeurl property and display the corresponding locale string. If no corresponding localeid can be found, the localeid is displayed textually. If this attribute is not specified, the editor will display a default localized version of the button name depending on the locale used.
actionid (DISCUNORDEREDLIST | CIRCLEUNORDEREDLIST | SQUAREUNORDEREDLIST | UPPERALPHAORDEREDLIST | LOWERALPHAORDEREDLIST | NUMERICORDEREDLIST | LOWERROMANORDEREDLIST | UPPERROMANORDEREDLIST) #REQUIRED
Determines the id of the action fired when the menuitem is clicked. Only ordered lists or unordered lists can be subbutton elements.
enabled (true|false) "true"
Determines whether the button is enabled.
<subbutton localeid="Number Alpha Orderedlist"
actionid="NUMERICORDEREDLIST" />choice
Defines a toolbar combo box.
toolbar
None.
localeid CDATA #IMPLIED
The editor will search for this localeid in the locale specified by the locale or localeurl property and display the corresponding locale string. If no corresponding localeid can be found, the localeid is displayed textually. If this attribute is not specified, the editor will display a default localized version of the combo box name depending on the locale that is used.
actionid (FONTSIZE|FONTTYPE|STYLESHEET|PARAGRAPHSTYLE) #REQUIRED
Determines the id of the action that is fired when the menuitem is clicked.
width CDATA #IMPLIED
Determines the width of the combo box.
fontsize CDATA #REQUIRED
Determines the font size that is used in the combo box.
<choice localeid="Paragraph Style"
actionid="PARAGRAPHSTYLE"/>customchoice
May be used to specify a custom drop down box within the editor's toolbar. The drop down box groups several default editor actions as well as custom actions.
config
customchoiceitem
localeid CDATA #REQUIRED | fontsize CDATA #IMPLIED
Determines a custom drop down box. The required attribute localeid defines the tooltip, fontsize sets the font size of the elements displayed within the drop down box.
<customchoice localeid="Custom choice tooltip"
fontsize="20">customchoiceitem
Adds the specified editor action or custom action to the customchoice toolbar drop down box
customchoice
None.
actionid CDATA #REQUIRED | localeid CDATA #IMPLIED
The attribute actionid determines the ACTIONID which should be listed in the drop down box. localeid changes the default label for respective ACTIONID within the drop down box.
<customchoiceitem actionid="BOLD" localeid="Format Bold"/>
ACCEPTALL
Accepts all changes in the document. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
ACCEPTDELETION
Accepts a deletion at the caret position. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
ACCEPTFORMAT
Accepts a formatting change at the caret position. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
ACCEPTINSERTION
Accepts an insertion at the caret position. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
ACCEPTALLSELECTEDCHANGES
Accepts all changes within the current selection. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
ADVANCEDSTYLESHEET
Provides a list of CSS styles to select from. The selected CSS style is applied to the current element or selection. Additionally, the list displays to which elements the individual styles can be applied to.
ADVANCEDUNORDEREDLIST
Allows the user to select one of the available unordered list types.
AUTOSPELLCHECKSUGGESTION
Provides a list of correction suggestions if the word at the cursor position was not recognized by the spell checker.
This action may only be used in the context menu.
BOOKMARKPROPERTIES
Opens the "Edit Bookmark Properties" dialog if the current element or selection is a bookmark.
CDATAPROPERTIES
Opens the "Edit CDATA" dialog if the current element or selection is a CDATA section.
CELLPROPERTIES
Opens the "Cell Properties" dialog if the current element or selection is a table cell.
COLUMNPROPERTIES
Opens the "Column Properties" dialog if the current element or selection is a table column.
COMMENT
Opens the "Insert Comment" dialog.
The inserted comment will only be visible in WYSIWYG mode if the "Show All" option (P-mode) is enabled.
COMMENTPROPERTIES
Opens the "Edit Comment" dialog if the current element or selection is a comment.
CONVERTTABLEWIDTHTORELATIVE
Converts the table at the caret position to a table with relative width.
DIFF
Opens the "Compare Documents" dialog which allows the user to select two documents for comparison. Once the documents are loaded, the editor runs in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
DIFFLIST
Opens the "Diff List" dialog which displays all modifications found in the document in a list.
This feature is only available if VersioTrack is enabled in your license.
ENDENCLOSINGBLOCK
Ends the enclosing block. That is, if the caret is within a blockquote, div, ol or ul element, a new p element is inserted after this element, and the caret is placed within the newly inserted p element.
HIGHLIGHTTEXT
Opens a dialog whicht lets the user select a highlight color for the current selection and enables typing of highlighted text.
FONTSIZE
Provides a list of font sizes to select from. The selected font size is applied to the current selection.
FONTTYPE
Provides a list of font styles to select from. The selected font style is applied to the current selection.
GOTONEXTBOOKMARK
Sets the caret at the end of the next bookmark found in the document starting from the caret position.
GOTOPREVIOUSBOOKMARK
Sets the caret at the end of the previous bookmark found in the document starting from the caret position.
HARDRULERPROPERTIES
Opens the "Horizontal Line Properties" dialog if the current element or selection is a hard ruler.
Integrators/developers of course can modify the help files according to the individual need of their installation. Upon request RealObjects will also provide the related DocBook files and style sheets.
IMAGEPROPERTIES
Opens the "Image Properties" dialog if the current element or selection is an image.
INSERTLANG
Opens the "Insert Language Attribute" dialog. This dialog inserts a span element with a "lang" attribute around the selected content. The value of the "lang" attribute is the value specified by the dialog
LANGPROPERTIES
Opens the "Edit Language Attribute" dialog if the caret is located in a span tag having a "lang" attribute.
LINKPROPERTIES
Opens the "Edit Hyperlink" dialog if the current element or selection is a hyperlink.
LOWERALPHAORDEREDLIST
Displays an ordered list with each member of the list marked with a lowercase type ('a').
LOWERROMANORDEREDLIST
Displays a list with each member of the list is marked with a lowercase Roman number ('iv'').
NEW
Clears the editor's content and populates the editor with a template or default document.
NEXTDIFF
Jumps to the next modification found in the document.
This feature is only available if VersioTrack is enabled in your license.
NUMERICORDEREDLIST
Displays an ordered list with each member of the list marked with an Arabic number ('1').
OBJECTPROPERTIES
Opens the "Image Properties" dialog if the current element or selection is an image.
ORDEREDLIST
Displays a list where each member of the list is marked with an Arabic number ('1'). Additionally allows the user to select one of the three available ordered list types.
PAGEPROPERTIES
Opens the "Page Properties" dialog, which allows to specify properties for the document currently being edited, such as the document title, the default color of hyperlinks and a background image for the document.
PARAGRAPHSTYLE
Provides a list of paragraph styles to select from. The selected paragraph style is applied to the current selection.
PASTE
Inserts the contents of the clipboard in HTML format with style information contained inline.
PASTESPECIAL
Opens the "Paste Special" dialog. This dialog lets the user select which type of paste to perform (e.g plain text only, or in HTML but without styles etc.) and will give a short overview over what each type of paste will result in.
PASTEWITHFILTER
Inserts the contents of the clipboard in HTML format, but without styles.
PASTEWITHSTYLEDEFS
Inserts the contents of the clipboard in HTML format with style information contained in an embedded style sheet, e.g.converts inline styles to style classes. Imported styles will be merged with existing styles respectively style classes.
PIPROPERTIES
Opens the "Edit Processing Instruction" dialog if the current element or selection is a processing instruction.
PREVDIFF
Jumps to the previous modification found in the document.
This feature is only available if VersioTrack is enabled in your license.
REJECTALL
Rejects all changes within the document. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
REJECTDELETION
Rejects a deletion at the caret position. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
REJECTFORMAT
Rejects a formatting change at the caret position. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
REJECTINSERTION
Rejects an insertion at the caret position. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
REJECTSELECTEDCHANGES
Rejects all changes within the current selection. This action is only enabled in comparison mode.
This feature is only available if VersioTrack is enabled in your license.
REMOVECUSTOMTAG
Removes a custom tag at the cursor position. Only the custom tag itself is removed, while its content is preserved.
REMOVECUSTOMTAG
Removes a custom tag at the cursor position. The custom tag is removed including all of its content.
RESETIMAGESIZE
If an image is selected or the caret is placed on an image when this action is called, the image size is reset to its orginal size if it was modified.
RESETUSERPREFS
Resets the user preferences. The user preferences consist of the values that were last specified by the user in some dialogs such as the table properties dialog, the color properties dialog or the cell properties dialog.
ROWPROPERTIES
Opens the "Row Properties" dialog if the current element or selection is a table row.
SAVEAS
Opens a "Save as" dialog which allows the user to save the document currently being editied locally on his computer.
SHOWNALLCHAR
Displays control characters, XML comments, CDATA sections, processing instructions and custom tags.
SHOWSOURCEVIEW
Switches to Source View when it is activated and to WYISIWYG View when it is deactivated.
SHOWTABLEGRID
Enables / disables the display of the table grid. If it is enabled, table borders with a width of "0" will be displayed as a dotted line. If it is disabled, borders with no width will not be displayed.
SHOWWYSIWYGAREAONLY
Enables / disables the display of the canvas, UI and tab pane. When enabled, only the WYSIWYG area is displayed.
When this action is enabled, most of the UI is hidden. The user won't be able to use the toolbar or pull down menu to disable this action. Thus, it is recommended to provide a context menu and a keyboard shortcut for this action.
SHOWWYSIWYGVIEW
Switches to WYSIWYG view when it is activated and to Source View when it is deactivated.
SOURCESYNTAXHIGHLIGHT
Enables / disables syntax highglighting in source view when it is called.
SPELLCHECK
Checks the spelling of the content inside the editor. If the spell checker finds one or more errors, the "Check Spelling" dialog is opened.
SPLITPARAGRAPH
Splits the paragraph at the caret position. This has the same effect when as pressing the "enter" key when the configuration option "alternateenterkeyaction" is not set.
STANDALONE
Enables / disables the "Stand Alone" mode. In "Stand Alone" mode the editor is displayed in a separate window outside of the browser and can be freely resized by the user.
STYLESHEET
Provides a list of CSS styles to select from. The selected CSS style is applied to the current element.
TABLEAUTOFORMAT
Opens the "Table Autoformat" dialog if the element at the cursor position is a table. This dialog allows you to select and apply a template to a table.
TABLEPROPERTIES
Opens the "Table Properties" dialog if the element at the cursor position is a table.
TAGPROPERTIES
Opens the "Edit Tag Properties" dialog if the current element or selection is a custom element.
TRACKCHANGES
Enables comparison mode in the editor. All changes made to the document currently edited are tracked from then on.
This feature is only available if VersioTrack is enabled in your license.
TREEVIEW
Opens the "Tree View" dialog. The tree view will display the position of the element at the cursor position inside the document tree.
UNORDEREDLIST
Displays a list with each member of the list is marked with a disc. Additionally allows the user to select one of the three available unordered list types.
UPLOADDOCUMENTIMAGES
Opens the "Upload Document Images" dialog. The dialog allows the user to upload images to the server if the filemanagement element is specified in the configuration file.
This action is deprecated as of edit-on Pro version 4.2. Please use UPLOADIMAGES instead.
UPLOADDOCUMENT
Opens the "Upload Document" dialog. The dialog allows the user to upload the document currently being edited to the server. To configure where the document should be uploaded to, please use the filemanagement setting in the configuration file.
UPLOADALL
Successively opens the "Upload Objects" dialog and the "Upload Document" dialog. The dialogs resp. allows the user to upload images and objects and the document currently being edited. To configure where the images should be uploaded to, please use the filemanagement setting in the configuration file.
UPLOADIMAGES
Opens the "Upload Images" dialog. The dialog allows the user to upload images to the server. To configure where the images should be uploaded to, please use the filemanagement setting in the configuration file.
UPLOADOBJECTS
Opens the "Upload Objects" dialog. The dialog allows the user to upload objects to the server. To configure where the objects should be uploaded to, please use the filemanagement setting in the configuration file.