Package ro.sync.exml.options
Interface APIAccessibleOptionTags
-
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface APIAccessibleOptionTags
Global Oxygen options which can be read and set via the API.- Since:
- 18
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ADDITIONAL_FRAMEWORKS_DIRECTORIES
Array of strings indicating the additional frameworks directories.static java.lang.String
ADDONS_UPDATE_SITES
Array of strings indicating the update sites list.static java.lang.String
ARCHIVE_DESCRIPTORS
All the extensions recognized as archives.static java.lang.String
ASK_OPEN_DITA_MAP_IN_DITAMANAGER
Remember if Oxygen should ask the user if the dita map will be opened in the dita maps manager.
Possible integer values:
ro.sync.exml.options.APIOptionConstants.ALWAYS_ASK
ro.sync.exml.options.APIOptionConstants.ALWAYS_NO
ro.sync.exml.options.APIOptionConstants.ALWAYS_YESstatic java.lang.String
AUTHOR_EDITING_MODE
Option controlling the author schema aware editing from the "Editor / Edit Modes / Author / Schema-Aware" Preferences page.static java.lang.String
AUTHOR_FORMAT_COMPATIBILITY
Option for controlling the compatibility of the document serialization from Author editing mode with other tools.static java.lang.String
AUTO_APPLY_STYLES_DITAVAL_MAIN_FILES
Boolean value which controls applying styles defined in ditaval files placed in main files folderstatic java.lang.String
AUTO_SYNCHRONIZE_UNMODIFIED_EDITORS
Auto synch unmodified editors with file system.static java.lang.String
AUTOCHECKVERSION_ENABLE
Boolean property.static java.lang.String
AUTOMATICALLY_ACCEPT_CERTIFICATES
Option that controls if oXygen will accept all HTTPS certificates.static java.lang.String
AUTORECOVERY_LOCATION
A filepath string property defining the folder where the auto-recovery information for documents is stored.static java.lang.String
CAN_EDIT_READ_ONLY_FILES
Option for editing read-only files.static java.lang.String
CATALOGS
The catalogs key.static java.lang.String
CHANGE_TRACKING_AUTHOR
The author for change tracking.static java.lang.String
CHECK_FOR_NOTIFICATIONS_ENABLE
Boolean property.static java.lang.String
CODE_INSIGHT_SHOW_ANNOTATIONS
Show annotations (documentation) for each entry in the content completion window.static java.lang.String
CODE_INSIGHT_SHOW_ANNOTATIONS_TOOLTIP
Show annotations (documentation) when hovering the mouse over various elements.static java.lang.String
CODE_TEMPLATES
Code-templates.static java.lang.String
CREATE_KEYS_ATTRIBUTE_FOR_TOPICREF_BASED_ON_FILENAME
Option used to generate the "keys" attribute for topicrefs based on the filename (in DMM).static java.lang.String
DIFF_IGNORE_XPATH_EXPRESSION
Option used to store the XPath expression used to ignore nodes when files are compared.static java.lang.String
DIFF_INFO
The current diff info.static java.lang.String
DITA_FILL_LINK_FORMAT_ATTR
Option that controls if the format attribute value will be automatically filled when inserting a link reference.static java.lang.String
DITA_FILL_LINK_SCOPE_ATTR
Option that controls if the scope attribute value will be automatically filled when inserting a link reference.static java.lang.String
DITA_FILL_LINK_TYPE_ATTR
Option that controls if the type attribute value will be automatically filled when inserting a link reference.static java.lang.String
DITA_FILL_TOPICREF_FORMAT_ATTR
Option that controls if the format attribute value will be automatically filled when inserting a topic reference.static java.lang.String
DITA_FILL_TOPICREF_NAVTITLE_ATTR
Option that controls if the navigation title attribute value will be automatically filled when inserting a topic reference.static java.lang.String
DITA_FILL_TOPICREF_SCOPE_ATTR
Option that controls if the scope attribute value will be automatically filled when inserting a topic reference.static java.lang.String
DITA_FILL_TOPICREF_TYPE_ATTR
Option that controls if the type attribute value will be automatically filled when inserting a topic reference.static java.lang.String
DITA_OT_DIRECTORY
DITA OT Directory.static java.lang.String
DITA_SHOW_CONSOLE_OUTPUT
Option regarding when to show the DITA transformation console output.static java.lang.String
EDIT_RESOLVED_REFERRED_CONTENT_IN_AUTHOR
Boolean option to allow in-place editing for referred content in Author page.static java.lang.String
EDITOR_DETECT_INDENT_ON_OPEN
Boolean property.static java.lang.String
EDITOR_FONT
A property with a string value of the form "name,style,size".static java.lang.String
EDITOR_FORMAT_INDENT_INLINE_ELEMENTS
Indent inline elements.static java.lang.String
EDITOR_INDENT_SIZE
The number of space characters for one indentation level.static java.lang.String
EDITOR_LINE_WIDTH
The maximum length of any line when the Format and Indent (pretty-print) operation is applied.static java.lang.String
EDITOR_SHOW_SPACE
Boolean property for displaying the SPACE characters as special marks or not displaying them in oXygen editors.static java.lang.String
EDITOR_SHOW_TAB_EOL_EOF
Boolean property for displaying the characters TAB, END-OF-LINE and END-OF-FILE as special marks or not displaying them.static java.lang.String
EDITOR_USE_TABS
If enabled the indentation will be made with tab characters, if disabled the indentation will be made with space characters.static java.lang.String
ENABLE_DITA_2_X_SUPPORT
Enable the creation and editing of DITA 2.x documents.static java.lang.String
ENABLE_SYNCHRONIZE_UNMODIFIED_EDITORS
Enable update unmodified editors with file system.static java.lang.String
FILE_TYPES_ASSOCIATION
File type association.static java.lang.String
FONT_FOR_AUTHOR
The default font for the author editor.static java.lang.String
FONT_FOR_GUI
The font for the GUI controls.static java.lang.String
FONT_FOR_SCHEMA
The default font for the schema editor.static java.lang.String
FONT_FOR_TEXT
The font for the text controls.static java.lang.String
FRAMEWORKS_DIRECTORY_URL
The custom frameworks directory URL with editor variables, when a custom one is set.static java.lang.String
KEYS_CONTEXT_MAP
The keys context map.static java.lang.String
OPEN_MERGED_FILES
Open the modified files after the merge operation is performedstatic java.lang.String
PREFER_USING_KEYS_FOR_DITA_CROSS_REF
Boolean option.static java.lang.String
PREFER_USING_KEYS_FOR_DITA_FILE_REFERENCE
Boolean option.static java.lang.String
PREFER_USING_KEYS_FOR_DITA_INSERT_MEDIA
Boolean option.static java.lang.String
PREFER_USING_KEYS_FOR_DITA_PUSH_CONTENT
Boolean option.static java.lang.String
PREFER_USING_KEYS_FOR_DITA_REUSE_CONTENT
Boolean option.static java.lang.String
PREFER_USING_KEYS_FOR_DITA_WEB_LINK
Boolean option.static java.lang.String
PROFILING_CONDITIONS_LIST
Stores information about the profiling conditions.static java.lang.String
PROFILING_CONDITIONS_SET_LIST
Stores information about the profiling conditions sets.static java.lang.String
PROFILING_SHOW_ATTRIBUTES_COLORS
Key used to store information about the profiling conditions colors.static java.lang.String
PROFILING_STYLES
Option key for profiling styles associated with a profiling attribute value.static java.lang.String
RECENTLY_USED_CHARACTERS
Option for storing the recently used characters from CharacterMap.static java.lang.String
RECENTLY_USED_CHARACTERS_SIZE
The number of recently used characters that must be stored.static java.lang.String
REPORT_INVALID_ATTR_VALS_FOUND_IN_DOC
Boolean option from the Profiling and Conditional Text options page which when set to true will report warnings if the current validated file has profiling attributes with values which are not defined in the application preferences "Profiling and Conditional Text" page.static java.lang.String
RESTRICT_EDITING_REFERRED_CONTENT_TO_LOCAL_FILES_IN_AUTHOR
Boolean option to allow editing also referred remote filesfalse
to allow editing of referred remote files.static java.lang.String
SHOW_EXCLUDED_CONTENT
"Show Excluded Content" option.static java.lang.String
SHOW_PROFILING_ATTRIBUTES
"Show Profiling Attributes" option.static java.lang.String
SHOW_PROFILING_COLORS_AND_STYLES
"Show Profiling Colors and Styles" option.static java.lang.String
SHOW_SAVE_AS_IN_NEW_DIALOG
Show "Save As" capability in New wizard dialog.static java.lang.String
SPELL_CHECK_OPTIONS
Can be used to set and obtain a persistent object of type "ro.sync.azcheck.ui.SpellCheckOptions" which contains information about the current spell checker language, automatic spell check state and so on.static java.lang.String
SQF_QUICK_FIX_SUPPORT
Option that controls if the schematron quick fixes support is enabled or not.static java.lang.String
SYNTAX_HIGHLIGHT_PROXY_MAP_BG_COLORS
Background colors for the "Editor / Syntax Highlight / Elements/Attributes by Prefix" preferences page.static java.lang.String
SYNTAX_HIGHLIGHT_PROXY_MAP_COLORS
Foreground colors for the "Editor / Syntax Highlight / Elements/Attributes by Prefix" preferences page.static java.lang.String
SYNTAX_HIGHLIGHT_PROXY_MAP_PROXIES
List of XML prefixes for which the syntax highlight will have various foreground/background colors.static java.lang.String
TAGS_DISPLAY_MODE
Tags display mode in tagless editor.static java.lang.String
TRACK_CHANGES_INITIAL_DISPLAY_MODE
Option for track changes initial display mode (view changes/comments, view final, ...).static java.lang.String
TRACK_CHANGES_INITIAL_STATE
Option for track changes initial state.static java.lang.String
UI_BACKGROUND_COLOR
Background color for user interface.Return a string containing the color RGB with comma delimiters.static java.lang.String
UI_BORDER_COLOR
Border color.static java.lang.String
UI_DARK_THEME
true
if the current theme is a dark one.static java.lang.String
UI_DISABLED_FOREGROUND_COLOR
Disabled foreground color.static java.lang.String
UI_FOREGROUND_COLOR
Foreground color for user interface.static java.lang.String
UI_INACTIVE_SELECTION_BACKGROUND_COLOR
Inactive selection background color.static java.lang.String
UI_LINK_FOREGROUND_COLOR
Link foreground color.static java.lang.String
UI_MENUS_TOOLBARS_BACKGROUND_COLOR
Background color for toolbars and menus.static java.lang.String
UI_MENUS_TOOLBARS_SELECTION_BACKGROUND_COLOR
Selection background color for toolbars and menus.static java.lang.String
UI_SCROLLBARS_CHEVRONS_COLOR
Color for scroll bars, chevrons.static java.lang.String
UI_SELECTION_BACKGROUND_COLOR
Selection background color.static java.lang.String
UI_SELECTION_FOREGROUND_COLOR
Selection foreground color.static java.lang.String
UI_SEPARATOR_COLOR
Separator color.static java.lang.String
UI_STATUS_PANEL_BACKGROUND_COLOR
Background color for status panel.static java.lang.String
UI_STATUS_PANEL_FOREGROUND_COLOR
Foreground color for status panel.static java.lang.String
UI_TEXT_BACKGROUND_COLOR
Background color for text components, trees, tables.Returns a string containing the color RGB with comma delimiters.static java.lang.String
UI_TEXT_COMPONENTS_BORDER_COLOR
Border color for text components, trees, tables.static java.lang.String
UI_VIEW_TABS_BORDER_COLOR
Color for view tabs border.static java.lang.String
UI_VIEW_TITLES_BACKGROUND_COLOR
View titles background color.static java.lang.String
UI_VIEW_TITLES_FONT
Font for view titles.static java.lang.String
UI_VIEW_TITLES_FOREGROUND_COLOR
Foreground color for view titles.static java.lang.String
USE_CUSTOM_FRAMEWORKS_DIRECTORY_URL
Options that specifies if the custom frameworks directory is used or not.static java.lang.String
USER_DEFINED_EDITOR_VARIABLES
Option tag used to store user-defined editor variables in Oxygen's preferences.static java.lang.String
XML_DTD_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for the XML validated with DTD.static java.lang.String
XML_RNG_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for the XML validated with RNG.static java.lang.String
XML_XSD_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for the XML validated with XSD.static java.lang.String
XSL_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for XSLT.
-
-
-
Field Detail
-
USER_DEFINED_EDITOR_VARIABLES
static final java.lang.String USER_DEFINED_EDITOR_VARIABLES
Option tag used to store user-defined editor variables in Oxygen's preferences. The value stored for this tag is an array of UserEditorVariablePO.- See Also:
- Constant Field Values
-
OPEN_MERGED_FILES
static final java.lang.String OPEN_MERGED_FILES
Open the modified files after the merge operation is performed- See Also:
- Constant Field Values
-
SHOW_SAVE_AS_IN_NEW_DIALOG
static final java.lang.String SHOW_SAVE_AS_IN_NEW_DIALOG
Show "Save As" capability in New wizard dialog. Returns a Boolean value.- See Also:
- Constant Field Values
-
CREATE_KEYS_ATTRIBUTE_FOR_TOPICREF_BASED_ON_FILENAME
static final java.lang.String CREATE_KEYS_ATTRIBUTE_FOR_TOPICREF_BASED_ON_FILENAME
Option used to generate the "keys" attribute for topicrefs based on the filename (in DMM).- See Also:
- Constant Field Values
-
AUTO_SYNCHRONIZE_UNMODIFIED_EDITORS
static final java.lang.String AUTO_SYNCHRONIZE_UNMODIFIED_EDITORS
Auto synch unmodified editors with file system. Returns a Boolean value.- See Also:
- Constant Field Values
-
ENABLE_SYNCHRONIZE_UNMODIFIED_EDITORS
static final java.lang.String ENABLE_SYNCHRONIZE_UNMODIFIED_EDITORS
Enable update unmodified editors with file system. Returns a Boolean value.- See Also:
- Constant Field Values
-
FILE_TYPES_ASSOCIATION
static final java.lang.String FILE_TYPES_ASSOCIATION
File type association. Returned as an array of "ro.sync.exml.editor.FileTypeAssociation"- See Also:
- Constant Field Values
-
ADDONS_UPDATE_SITES
static final java.lang.String ADDONS_UPDATE_SITES
Array of strings indicating the update sites list. Returns an array of java.lang.String.- See Also:
- Constant Field Values
-
UI_VIEW_TABS_BORDER_COLOR
static final java.lang.String UI_VIEW_TABS_BORDER_COLOR
Color for view tabs border. Return a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_SCROLLBARS_CHEVRONS_COLOR
static final java.lang.String UI_SCROLLBARS_CHEVRONS_COLOR
Color for scroll bars, chevrons. Return a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_STATUS_PANEL_BACKGROUND_COLOR
static final java.lang.String UI_STATUS_PANEL_BACKGROUND_COLOR
Background color for status panel. Return a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_STATUS_PANEL_FOREGROUND_COLOR
static final java.lang.String UI_STATUS_PANEL_FOREGROUND_COLOR
Foreground color for status panel. Return a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_VIEW_TITLES_FOREGROUND_COLOR
static final java.lang.String UI_VIEW_TITLES_FOREGROUND_COLOR
Foreground color for view titles. Return a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_VIEW_TITLES_FONT
static final java.lang.String UI_VIEW_TITLES_FONT
Font for view titles. Return a string containing the font properties with comma delimiters.- See Also:
- Constant Field Values
-
UI_MENUS_TOOLBARS_BACKGROUND_COLOR
static final java.lang.String UI_MENUS_TOOLBARS_BACKGROUND_COLOR
Background color for toolbars and menus. Return a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_MENUS_TOOLBARS_SELECTION_BACKGROUND_COLOR
static final java.lang.String UI_MENUS_TOOLBARS_SELECTION_BACKGROUND_COLOR
Selection background color for toolbars and menus. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_BACKGROUND_COLOR
static final java.lang.String UI_BACKGROUND_COLOR
Background color for user interface.Return a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_TEXT_BACKGROUND_COLOR
static final java.lang.String UI_TEXT_BACKGROUND_COLOR
Background color for text components, trees, tables.Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_VIEW_TITLES_BACKGROUND_COLOR
static final java.lang.String UI_VIEW_TITLES_BACKGROUND_COLOR
View titles background color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_FOREGROUND_COLOR
static final java.lang.String UI_FOREGROUND_COLOR
Foreground color for user interface. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_DISABLED_FOREGROUND_COLOR
static final java.lang.String UI_DISABLED_FOREGROUND_COLOR
Disabled foreground color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_SELECTION_BACKGROUND_COLOR
static final java.lang.String UI_SELECTION_BACKGROUND_COLOR
Selection background color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_INACTIVE_SELECTION_BACKGROUND_COLOR
static final java.lang.String UI_INACTIVE_SELECTION_BACKGROUND_COLOR
Inactive selection background color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_SELECTION_FOREGROUND_COLOR
static final java.lang.String UI_SELECTION_FOREGROUND_COLOR
Selection foreground color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_LINK_FOREGROUND_COLOR
static final java.lang.String UI_LINK_FOREGROUND_COLOR
Link foreground color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_BORDER_COLOR
static final java.lang.String UI_BORDER_COLOR
Border color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_SEPARATOR_COLOR
static final java.lang.String UI_SEPARATOR_COLOR
Separator color. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
UI_DARK_THEME
static final java.lang.String UI_DARK_THEME
true
if the current theme is a dark one. Returns a boolean.- See Also:
- Constant Field Values
-
UI_TEXT_COMPONENTS_BORDER_COLOR
static final java.lang.String UI_TEXT_COMPONENTS_BORDER_COLOR
Border color for text components, trees, tables. Returns a string containing the color RGB with comma delimiters.- See Also:
- Constant Field Values
-
DITA_SHOW_CONSOLE_OUTPUT
static final java.lang.String DITA_SHOW_CONSOLE_OUTPUT
Option regarding when to show the DITA transformation console output. Returns an integer property, one of the constantsAPIOptionConstants.ALWAYS_SHOW_CONSOLE
.APIOptionConstants.SHOW_CONSOLE_WHEN_BUILD_FAILS
- See Also:
- Constant Field Values
-
DITA_OT_DIRECTORY
static final java.lang.String DITA_OT_DIRECTORY
DITA OT Directory. Returns a String representing the directory path to the default DITA OT directory.- See Also:
- Constant Field Values
-
TRACK_CHANGES_INITIAL_STATE
static final java.lang.String TRACK_CHANGES_INITIAL_STATE
Option for track changes initial state. Returns an integer value. One of the constants "APIOptionConstants.TRACK_CHANGES_*".- See Also:
- Constant Field Values
-
TRACK_CHANGES_INITIAL_DISPLAY_MODE
static final java.lang.String TRACK_CHANGES_INITIAL_DISPLAY_MODE
Option for track changes initial display mode (view changes/comments, view final, ...).- See Also:
- Constant Field Values
-
PROFILING_SHOW_ATTRIBUTES_COLORS
static final java.lang.String PROFILING_SHOW_ATTRIBUTES_COLORS
Key used to store information about the profiling conditions colors. Returns an ProfilingAttributesPresentingColorsPO object.- See Also:
- Constant Field Values
-
PROFILING_CONDITIONS_SET_LIST
static final java.lang.String PROFILING_CONDITIONS_SET_LIST
Stores information about the profiling conditions sets. Returns an array of ProfileConditionsSetInfoPO objects.- See Also:
- Constant Field Values
-
PROFILING_CONDITIONS_LIST
static final java.lang.String PROFILING_CONDITIONS_LIST
Stores information about the profiling conditions. Returns an array of ProfileConditionInfoPO objects. You can set these from a plugin like this:ProfileConditionInfoPO[] conditions = new ro.sync.ecss.conditions.ProfileConditionInfoPO[]{ new ProfileConditionInfoPO("dummy", "Dummy", true, new ro.sync.ecss.conditions.ProfileConditionValuePO[]{ new ProfileConditionValuePO("external", "External"), new ProfileConditionValuePO("guest", "Guest"), new ProfileConditionValuePO("internal", "Internal"), }, " ", "*DITA*") }; PluginWorkspaceProvider.getPluginWorkspace().setGlobalObjectProperty("profiling.conditions.list", conditions);
The constructor of the ProfileConditionInfoPO persistent object looks like:public static ProfileConditionInfoPO createDefaultProfileConditionInfoPO(String attributeName, String attributeRenderName, boolean allowsMultipleValues, String[] allowedValues, String valuesSeparator, String documentTypePattern) {
- See Also:
- Constant Field Values
-
PROFILING_STYLES
static final java.lang.String PROFILING_STYLES
Option key for profiling styles associated with a profiling attribute value. Returns an array of ProfilingAttributeStylePO objects. You can set these from a plugin like this:PluginWorkspaceProvider.getPluginWorkspace().setGlobalObjectProperty("author.profiling.styles", new ProfilingAttributeStylePO[]{ new ProfilingAttributeStylePO("#DITA*", "dummy", "External", Color.BLUE.getRGB(), ProfilingAttributeStylePO.NO_COLOR, ProfilingAttributeStylePO.UNDERLINE, false, false), new ProfilingAttributeStylePO("#DITA*", "dummy", "Guest", Color.RED.getRGB(), ProfilingAttributeStylePO.NO_COLOR, ProfilingAttributeStylePO.DOUBLE_UNDERLINE, false, false), });
The constructor of the ProfilingAttributeStylePO looks like this:public ProfilingAttributeStylePO(String framework, String attributeName, String attributeValue, int foreground, int background, String textDecoration, boolean bold, boolean italic)
- See Also:
- Constant Field Values
-
CAN_EDIT_READ_ONLY_FILES
static final java.lang.String CAN_EDIT_READ_ONLY_FILES
Option for editing read-only files. Returns a Boolean flag.- See Also:
- Constant Field Values
-
CATALOGS
static final java.lang.String CATALOGS
The catalogs key. Returns an array of Strings, each string being an URL-like path to a catalog file. PLEASE DO NOT CHANGE THE KEY NAME, LOTS OF CUSTOMIZERS (IXIASOFT FOR EXAMPLE) USE THIS KEY TO IMPOSE CATALOGS.- See Also:
- Constant Field Values
-
RECENTLY_USED_CHARACTERS
static final java.lang.String RECENTLY_USED_CHARACTERS
Option for storing the recently used characters from CharacterMap. It's a Java String in which each char is one of the characters.- See Also:
- Constant Field Values
-
RECENTLY_USED_CHARACTERS_SIZE
static final java.lang.String RECENTLY_USED_CHARACTERS_SIZE
The number of recently used characters that must be stored. It is an integer property.- See Also:
- Constant Field Values
-
TAGS_DISPLAY_MODE
static final java.lang.String TAGS_DISPLAY_MODE
Tags display mode in tagless editor. It is an integer property, one of the constants in the ro.sync.exml.workspace.api.editor.page.author.DisplayModeConstants interface.- See Also:
- Constant Field Values
-
AUTOMATICALLY_ACCEPT_CERTIFICATES
static final java.lang.String AUTOMATICALLY_ACCEPT_CERTIFICATES
Option that controls if oXygen will accept all HTTPS certificates.- See Also:
- Constant Field Values
-
ADDITIONAL_FRAMEWORKS_DIRECTORIES
static final java.lang.String ADDITIONAL_FRAMEWORKS_DIRECTORIES
Array of strings indicating the additional frameworks directories. Returns an array of java.lang.String objects representing paths to the additional frameworks folders, paths which may also contain editor variables.- See Also:
- Constant Field Values
-
FRAMEWORKS_DIRECTORY_URL
static final java.lang.String FRAMEWORKS_DIRECTORY_URL
The custom frameworks directory URL with editor variables, when a custom one is set. It has a string value.- See Also:
- Constant Field Values
-
USE_CUSTOM_FRAMEWORKS_DIRECTORY_URL
static final java.lang.String USE_CUSTOM_FRAMEWORKS_DIRECTORY_URL
Options that specifies if the custom frameworks directory is used or not. It has a boolean value.- See Also:
- Constant Field Values
-
SYNTAX_HIGHLIGHT_PROXY_MAP_COLORS
static final java.lang.String SYNTAX_HIGHLIGHT_PROXY_MAP_COLORS
Foreground colors for the "Editor / Syntax Highlight / Elements/Attributes by Prefix" preferences page. It takes a string containing color RGB values having the pattern: "R1,G1,B1;R2,G2,B2". Sample value for 3 colors: "10,10,20;20,20,30;30,31,32"- See Also:
- Constant Field Values
-
SYNTAX_HIGHLIGHT_PROXY_MAP_BG_COLORS
static final java.lang.String SYNTAX_HIGHLIGHT_PROXY_MAP_BG_COLORS
Background colors for the "Editor / Syntax Highlight / Elements/Attributes by Prefix" preferences page. It takes a string containing color RGB values having the pattern: "R1,G1,B1;R2,G2,B2". Sample value for 2 colors: "255,255,255;255,255,255"- See Also:
- Constant Field Values
-
SYNTAX_HIGHLIGHT_PROXY_MAP_PROXIES
static final java.lang.String SYNTAX_HIGHLIGHT_PROXY_MAP_PROXIES
List of XML prefixes for which the syntax highlight will have various foreground/background colors. Its value is a String array like for example: new String[]{"p1", "p2", "p3"}. Example of how such option tags can be set://Foreground colors pluginWorkspaceAccess.setGlobalObjectProperty("sh.proxy.map.colors.second", "10,10,20;20,20,30;30,31,32"); //Background colors, same syntax, all white pluginWorkspaceAccess.setGlobalObjectProperty("sh.proxy.map.bg.colors.second", "255,255,255;255,255,255;255,255,255"); //The set of prefixes... pluginWorkspaceAccess.setGlobalObjectProperty("sh.proxy.map.proxies", new String[]{"p1", "p2", "p3"});
- See Also:
- Constant Field Values
-
XML_DTD_AUTOMATIC_QUICK_FIX_SUPPORT
static final java.lang.String XML_DTD_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for the XML validated with DTD.- See Also:
- Constant Field Values
-
XML_RNG_AUTOMATIC_QUICK_FIX_SUPPORT
static final java.lang.String XML_RNG_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for the XML validated with RNG. It has a boolean value.- See Also:
- Constant Field Values
-
XML_XSD_AUTOMATIC_QUICK_FIX_SUPPORT
static final java.lang.String XML_XSD_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for the XML validated with XSD. It has a boolean value.- See Also:
- Constant Field Values
-
XSL_AUTOMATIC_QUICK_FIX_SUPPORT
static final java.lang.String XSL_AUTOMATIC_QUICK_FIX_SUPPORT
Option that controls if the automatic quick fixes support is enabled or not for XSLT. It has a boolean value.- See Also:
- Constant Field Values
-
SQF_QUICK_FIX_SUPPORT
static final java.lang.String SQF_QUICK_FIX_SUPPORT
Option that controls if the schematron quick fixes support is enabled or not. It has a boolean value.- See Also:
- Constant Field Values
-
AUTHOR_FORMAT_COMPATIBILITY
static final java.lang.String AUTHOR_FORMAT_COMPATIBILITY
Option for controlling the compatibility of the document serialization from Author editing mode with other tools. Returns an integer property, one of the constantsAuthorFormatCompatibilityModeConstants.FORMAT_COMPATIBILITY_BREAKS_LINES_ONLY_BLOCKS_DO_NO_INDENT
,AuthorFormatCompatibilityModeConstants.FORMAT_COMPATIBILITY_DO_NOT_BREAK_LINES_DO_NO_INDENT
,AuthorFormatCompatibilityModeConstants.FORMAT_COMPATIBILITY_NONE
,- See Also:
- Constant Field Values
-
CODE_INSIGHT_SHOW_ANNOTATIONS
static final java.lang.String CODE_INSIGHT_SHOW_ANNOTATIONS
Show annotations (documentation) for each entry in the content completion window. Boolean option.- See Also:
- Constant Field Values
-
CODE_INSIGHT_SHOW_ANNOTATIONS_TOOLTIP
static final java.lang.String CODE_INSIGHT_SHOW_ANNOTATIONS_TOOLTIP
Show annotations (documentation) when hovering the mouse over various elements. Boolean option.- See Also:
- Constant Field Values
-
ARCHIVE_DESCRIPTORS
static final java.lang.String ARCHIVE_DESCRIPTORS
All the extensions recognized as archives. Its value is an array of "ro.sync.exml.zip.ArchiveDescriptor" objects. You can set it to register your own custom archive extension like:PluginWorkspaceProvider.getPluginWorkspace().setGlobalObjectProperty(ro.sync.exml.options.APIAccessibleOptionTags.ARCHIVE_DESCRIPTORS, new ArchiveDescriptor[]{new ArchiveDescriptor("EPX files", new String[]{"epx"}, ArchiveDescriptor.ARCHIVE_TYPE_ZIP)});
- See Also:
- Constant Field Values
-
SPELL_CHECK_OPTIONS
static final java.lang.String SPELL_CHECK_OPTIONS
Can be used to set and obtain a persistent object of type "ro.sync.azcheck.ui.SpellCheckOptions" which contains information about the current spell checker language, automatic spell check state and so on.- See Also:
- Constant Field Values
-
PREFER_USING_KEYS_FOR_DITA_REUSE_CONTENT
static final java.lang.String PREFER_USING_KEYS_FOR_DITA_REUSE_CONTENT
Boolean option. Iftrue
the "Reuse content" dialog will have the "Key" radio button selected.- See Also:
- Constant Field Values
-
PREFER_USING_KEYS_FOR_DITA_CROSS_REF
static final java.lang.String PREFER_USING_KEYS_FOR_DITA_CROSS_REF
Boolean option. Iftrue
the "Cross reference" and "Related link to topic" dialogs will have the "Key" radio button selected.- See Also:
- Constant Field Values
-
PREFER_USING_KEYS_FOR_DITA_PUSH_CONTENT
static final java.lang.String PREFER_USING_KEYS_FOR_DITA_PUSH_CONTENT
Boolean option. Iftrue
the "Push content" dialog will have the "Key" radio button selected.- See Also:
- Constant Field Values
-
PREFER_USING_KEYS_FOR_DITA_INSERT_MEDIA
static final java.lang.String PREFER_USING_KEYS_FOR_DITA_INSERT_MEDIA
Boolean option. Iftrue
the "Insert media" dialog will have the "Key" radio button selected.- See Also:
- Constant Field Values
-
PREFER_USING_KEYS_FOR_DITA_FILE_REFERENCE
static final java.lang.String PREFER_USING_KEYS_FOR_DITA_FILE_REFERENCE
Boolean option. Iftrue
the "File reference" and "Related link to file" dialogs will have the "Key" radio button selected.- See Also:
- Constant Field Values
-
PREFER_USING_KEYS_FOR_DITA_WEB_LINK
static final java.lang.String PREFER_USING_KEYS_FOR_DITA_WEB_LINK
Boolean option. Iftrue
the "Web link" and "Related link to webpage" dialogs will have the "Key" radio button selected.- See Also:
- Constant Field Values
-
DITA_FILL_TOPICREF_FORMAT_ATTR
static final java.lang.String DITA_FILL_TOPICREF_FORMAT_ATTR
Option that controls if the format attribute value will be automatically filled when inserting a topic reference.- See Also:
- Constant Field Values
-
DITA_FILL_TOPICREF_SCOPE_ATTR
static final java.lang.String DITA_FILL_TOPICREF_SCOPE_ATTR
Option that controls if the scope attribute value will be automatically filled when inserting a topic reference.- See Also:
- Constant Field Values
-
DITA_FILL_TOPICREF_TYPE_ATTR
static final java.lang.String DITA_FILL_TOPICREF_TYPE_ATTR
Option that controls if the type attribute value will be automatically filled when inserting a topic reference.- See Also:
- Constant Field Values
-
DITA_FILL_TOPICREF_NAVTITLE_ATTR
static final java.lang.String DITA_FILL_TOPICREF_NAVTITLE_ATTR
Option that controls if the navigation title attribute value will be automatically filled when inserting a topic reference.- See Also:
- Constant Field Values
-
DITA_FILL_LINK_FORMAT_ATTR
static final java.lang.String DITA_FILL_LINK_FORMAT_ATTR
Option that controls if the format attribute value will be automatically filled when inserting a link reference.- See Also:
- Constant Field Values
-
DITA_FILL_LINK_SCOPE_ATTR
static final java.lang.String DITA_FILL_LINK_SCOPE_ATTR
Option that controls if the scope attribute value will be automatically filled when inserting a link reference.- See Also:
- Constant Field Values
-
DITA_FILL_LINK_TYPE_ATTR
static final java.lang.String DITA_FILL_LINK_TYPE_ATTR
Option that controls if the type attribute value will be automatically filled when inserting a link reference.- See Also:
- Constant Field Values
-
EDITOR_SHOW_TAB_EOL_EOF
static final java.lang.String EDITOR_SHOW_TAB_EOL_EOF
Boolean property for displaying the characters TAB, END-OF-LINE and END-OF-FILE as special marks or not displaying them.- See Also:
- Constant Field Values
-
EDITOR_SHOW_SPACE
static final java.lang.String EDITOR_SHOW_SPACE
Boolean property for displaying the SPACE characters as special marks or not displaying them in oXygen editors.- See Also:
- Constant Field Values
-
SHOW_PROFILING_COLORS_AND_STYLES
static final java.lang.String SHOW_PROFILING_COLORS_AND_STYLES
"Show Profiling Colors and Styles" option. Returns a Boolean value.- See Also:
- Constant Field Values
-
SHOW_PROFILING_ATTRIBUTES
static final java.lang.String SHOW_PROFILING_ATTRIBUTES
"Show Profiling Attributes" option. Returns a Boolean value.- See Also:
- Constant Field Values
-
SHOW_EXCLUDED_CONTENT
static final java.lang.String SHOW_EXCLUDED_CONTENT
"Show Excluded Content" option. Returns a Boolean value.- See Also:
- Constant Field Values
-
CODE_TEMPLATES
static final java.lang.String CODE_TEMPLATES
Code-templates. Can be used to set or retrieve an array of "ro.sync.contentcompletion.CTItem".- See Also:
- Constant Field Values
-
REPORT_INVALID_ATTR_VALS_FOUND_IN_DOC
static final java.lang.String REPORT_INVALID_ATTR_VALS_FOUND_IN_DOC
Boolean option from the Profiling and Conditional Text options page which when set to true will report warnings if the current validated file has profiling attributes with values which are not defined in the application preferences "Profiling and Conditional Text" page.- See Also:
- Constant Field Values
-
CHANGE_TRACKING_AUTHOR
static final java.lang.String CHANGE_TRACKING_AUTHOR
The author for change tracking. Returns a String value and defaults to the user name set in the system.- See Also:
- Constant Field Values
-
EDITOR_FONT
static final java.lang.String EDITOR_FONT
A property with a string value of the form "name,style,size". For example: "MS Gothic,0,15" where "0" style means plain font, "1" means bold font and "2" means italic font. Keep the font used for displaying the documents in the editor panels.- See Also:
- Constant Field Values
-
FONT_FOR_AUTHOR
static final java.lang.String FONT_FOR_AUTHOR
The default font for the author editor. A property with a string value of the form "name,style,size". For example: "MS Gothic,0,15" where "0" style means plain font, "1" means bold font and "2" means italic font.- See Also:
- Constant Field Values
-
FONT_FOR_TEXT
static final java.lang.String FONT_FOR_TEXT
The font for the text controls. A property with a string value of the form "name,style,size". For example: "MS Gothic,0,15" where "0" style means plain font, "1" means bold font and "2" means italic font.- See Also:
- Constant Field Values
-
FONT_FOR_GUI
static final java.lang.String FONT_FOR_GUI
The font for the GUI controls. A property with a string value of the form "name,style,size". For example: "MS Gothic,0,15" where "0" style means plain font, "1" means bold font and "2" means italic font.- See Also:
- Constant Field Values
-
FONT_FOR_SCHEMA
static final java.lang.String FONT_FOR_SCHEMA
The default font for the schema editor. A property with a string value of the form "name,style,size". For example: "MS Gothic,0,15" where "0" style means plain font, "1" means bold font and "2" means italic font.- See Also:
- Constant Field Values
-
KEYS_CONTEXT_MAP
static final java.lang.String KEYS_CONTEXT_MAP
The keys context map. It's value is a string containing an URL-like path.- See Also:
- Constant Field Values
-
EDITOR_LINE_WIDTH
static final java.lang.String EDITOR_LINE_WIDTH
The maximum length of any line when the Format and Indent (pretty-print) operation is applied. This value is superseded only if the property "Detect line width on open" is enabled. A property which accepts an integer value.- See Also:
- Constant Field Values
-
EDITOR_FORMAT_INDENT_INLINE_ELEMENTS
static final java.lang.String EDITOR_FORMAT_INDENT_INLINE_ELEMENTS
Indent inline elements. Returns a Boolean value.- See Also:
- Constant Field Values
-
EDITOR_DETECT_INDENT_ON_OPEN
static final java.lang.String EDITOR_DETECT_INDENT_ON_OPEN
Boolean property. If it is enabled the indenting of the document (use tabs or spaces, indent size) is discovered when the user opens the document for editing in an editor panel and it will be preserved when the user applies the Format and Indent (pretty-print) action.- See Also:
- Constant Field Values
-
EDITOR_USE_TABS
static final java.lang.String EDITOR_USE_TABS
If enabled the indentation will be made with tab characters, if disabled the indentation will be made with space characters.- See Also:
- Constant Field Values
-
EDITOR_INDENT_SIZE
static final java.lang.String EDITOR_INDENT_SIZE
The number of space characters for one indentation level. -- Changed in v9.2 because the indent size must be greater than 0.- See Also:
- Constant Field Values
-
AUTORECOVERY_LOCATION
static final java.lang.String AUTORECOVERY_LOCATION
A filepath string property defining the folder where the auto-recovery information for documents is stored. By default its value is:
- Windows Vista/7/8/10: [user_home_directory]\AppData\Roaming\com.oxygenxml\autorecover
- Mac OS X: [user_home_directory]/Library/Preferences/com.oxygenxml/autorecover
- Linux/Unix: [user_home_directory]/.com.oxygenxml/autorecover- See Also:
- Constant Field Values
-
AUTOCHECKVERSION_ENABLE
static final java.lang.String AUTOCHECKVERSION_ENABLE
Boolean property. If true the user wants to check automatically if a new version of oXygen was released.- See Also:
- Constant Field Values
-
CHECK_FOR_NOTIFICATIONS_ENABLE
static final java.lang.String CHECK_FOR_NOTIFICATIONS_ENABLE
Boolean property. If true the user wants to check for notifications.- See Also:
- Constant Field Values
-
ENABLE_DITA_2_X_SUPPORT
static final java.lang.String ENABLE_DITA_2_X_SUPPORT
Enable the creation and editing of DITA 2.x documents.- See Also:
- Constant Field Values
-
AUTHOR_EDITING_MODE
static final java.lang.String AUTHOR_EDITING_MODE
Option controlling the author schema aware editing from the "Editor / Edit Modes / Author / Schema-Aware" Preferences page. Its values are objects of class "ro.sync.ecss.component.AuthorSchemaAwareOptions"- See Also:
- Constant Field Values
-
EDIT_RESOLVED_REFERRED_CONTENT_IN_AUTHOR
static final java.lang.String EDIT_RESOLVED_REFERRED_CONTENT_IN_AUTHOR
Boolean option to allow in-place editing for referred content in Author page.- See Also:
- Constant Field Values
-
RESTRICT_EDITING_REFERRED_CONTENT_TO_LOCAL_FILES_IN_AUTHOR
static final java.lang.String RESTRICT_EDITING_REFERRED_CONTENT_TO_LOCAL_FILES_IN_AUTHOR
Boolean option to allow editing also referred remote filesfalse
to allow editing of referred remote files.- See Also:
- Constant Field Values
-
ASK_OPEN_DITA_MAP_IN_DITAMANAGER
static final java.lang.String ASK_OPEN_DITA_MAP_IN_DITAMANAGER
Remember if Oxygen should ask the user if the dita map will be opened in the dita maps manager.
Possible integer values:
ro.sync.exml.options.APIOptionConstants.ALWAYS_ASK
ro.sync.exml.options.APIOptionConstants.ALWAYS_NO
ro.sync.exml.options.APIOptionConstants.ALWAYS_YES- See Also:
- Constant Field Values
-
DIFF_IGNORE_XPATH_EXPRESSION
static final java.lang.String DIFF_IGNORE_XPATH_EXPRESSION
Option used to store the XPath expression used to ignore nodes when files are compared. Its value is a string.- See Also:
- Constant Field Values
-
DIFF_INFO
static final java.lang.String DIFF_INFO
The current diff info. Holds a ro.sync.diff.factory.DiffInfo object.- See Also:
- Constant Field Values
-
AUTO_APPLY_STYLES_DITAVAL_MAIN_FILES
static final java.lang.String AUTO_APPLY_STYLES_DITAVAL_MAIN_FILES
Boolean value which controls applying styles defined in ditaval files placed in main files folder- See Also:
- Constant Field Values
-
-