Oxygen XML Editor SDK Javadoc

https://www.oxygenxml.com/InstData/Editor/SDK/javadoc
Admin
This Javadoc provides API documentation for the Oxygen XML Editor SDK, enabling developers to extend...
Tokens:1,985,118
Snippets:14,720
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Initialize PluginWorkspaceTCBase with installation and options folders

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/PluginWorkspaceTCBase

This constructor allows specifying the Oxygen installation folder, framework and plugin folders, options folder, and a license key for comprehensive test environment setup.

```Java
public PluginWorkspaceTCBase(File installationFolder, File frameworksFolder, File pluginsFolder, File optionsFolder, String licenseKey) throws MalformedURLException
```

--------------------------------

### Initialize JRadioButton for Other Apache FOP

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/serialized-form

Initializes a `JRadioButton` to select the use of an external Apache FOP installation within `FOProcessorsOptionPane`. This allows users to specify their own FOP path.

```Java
JRadioButton useOtherApacheFOP
```

--------------------------------

### Oxygen XML SDK: INSTALLING_AND_UPDATING_ADD_ONS Constant

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Defines the constant INSTALLING_AND_UPDATING_ADD_ONS, used in dialogs related to managing add-ons. This constant likely references the help page for installing and updating SDK add-ons.

```Java
static final String INSTALLING_AND_UPDATING_ADD_ONS
```

--------------------------------

### Get AuthorPersistentHighlight Start Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/highlights/AuthorPersistentHighlight

Gets the start offset of the highlight. This offset is inclusive.

```Java
int getStartOffset()
```

--------------------------------

### Get Selection Start Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/WSTextBasedEditorPage

Retrieves the starting offset of the current selection in the editor. This offset is inclusive.

```Java
int getSelectionStart()
```

--------------------------------

### Set up test environment

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/PluginWorkspaceTCBase

The setUp method is used to prepare the test environment before a test case is executed. It overrides the setUp method from the superclass.

```Java
protected void setUp() throws Exception
```

--------------------------------

### Initialize PluginWorkspaceTCBase with basic parameters

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/PluginWorkspaceTCBase

This constructor initializes the PluginWorkspaceTCBase with essential parameters like framework and plugin folders, and a license key. It assumes the installation folder is the current JVM directory.

```Java
public PluginWorkspaceTCBase(File frameworksFolder, File pluginsFolder, String licenseKey) throws MalformedURLException
```

--------------------------------

### Get Balanced Selection Start Offset - Java

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/author/WSAuthorEditorPageBase

Returns the start offset of the balanced selection. It typically matches getSelectionStart(), but adjusts if the selection starts immediately after a start tag and includes the corresponding end tag.

```Java
int getBalancedSelectionStart()
```

--------------------------------

### Java: Get Selection Start

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/author/WSAuthorEditorPageBase

Returns the start offset of the current selection in the Author editor.

```Java
int getSelectionStart()
```

--------------------------------

### Load Project

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/standalone/project/ProjectController

Loads a specified project file. This method initiates the process of opening and setting up a project.

```Java
void loadProject(File project)
```

--------------------------------

### Get Selection Start Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/WSTextBasedEditorPage

Returns the offset of the start of the current selection in the editor. This method returns an integer.

```Java
int getSelectionStart()
Get selection start offset.
```

--------------------------------

### Start Process with WorkspaceUtilities

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/WorkspaceUtilities

Starts a process that executes a given command line. Requires a process name, working directory, command line string, and a flag to indicate whether to show the console.

```Java
void startProcess(String name, File workingDirectory, String cmdLine, boolean showConsole)
```

--------------------------------

### Get Interval Start Offset - Java

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/ContentInterval

Retrieves the inclusive start offset of the content interval.

```Java
public int getStartOffset()
```

--------------------------------

### SATableCustomizerDialog Constructor with Basic Options

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/operations/SATableCustomizerDialog

Initializes the SATableCustomizerDialog with options for footer, frame attribute, model chooser, author resource bundle, and predefined row/column counts.

```Java
public SATableCustomizerDialog(Frame parentFrame, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
```

--------------------------------

### Get Project Manager

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/standalone/StandalonePluginWorkspace

Obtains the ProjectController to get access to Project-related APIs. This functionality is available starting from version 19.1.

```java
ProjectController getProjectManager()
Get access to Project related API.
```

--------------------------------

### Initialize Component with Frameworks ZIP URLs

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/component/AuthorComponentFactory

Initializes the component, typically called as early as possible. This overload is used when frameworks are provided as ZIP archives. It requires parameters for framework ZIP URLs, options, applet context, and license server details.

```Java
authorComponentFactory.init(frameworksZIPURLs, optionsZipURL, appletCodeBase, appletID, servletURL, userName, password);
```

--------------------------------

### PluginWorkspaceTCBase Setup and Teardown

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/PluginWorkspaceTCBase

Methods for setting up and tearing down the test environment for PluginWorkspaceTCBase. These methods are typically overridden in subclasses to perform specific initialization and cleanup tasks before and after each test case.

```Java
protected void setUp()

```

```Java
protected void tearDown()

```

--------------------------------

### Get Cell Width

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/support/DITATableCellInfoProvider

Gets the width representation for a given cell element, including its starting column number and span.

```Java
List<WidthRepresentation> getCellWidth(AuthorElement cellElement, int colNumberStart, int colSpan)
```

--------------------------------

### Get Caret Offset (Author Access Deprecated)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/deprecated-list

Gets the caret offset, recommending `WSTextBasedEditorPage.getCaretOffset()` and providing an example.

```Java
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getCaretOffset()
Use ``WSTextBasedEditorPage.getCaretOffset()`` instead. For example if you have an AuthorAccess object then use authorAccess.getEditorAccess().getCaretOffset().
```

--------------------------------

### ECIDElementsCustomizerDialog Methods

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/id/ECIDElementsCustomizerDialog

Provides methods for configuring the dialog shell, creating the dialog area, retrieving help page IDs, and handling the OK button press. It also includes a static method to display the dialog with specific information.

```Java
protected void configureShell(org.eclipse.swt.widgets.Shell newShell)
```

```Java
protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
```

```Java
protected String getHelpPageID()
```

```Java
protected void okPressed()
```

```Java
public static void showDialog(GenerateIDElementsInfo info)
```

--------------------------------

### Create and Manage Java Process

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/WorkspaceUtilities

Prepares and starts a Java process with configurable arguments, classpath, main class, environment variables, and a listener for process events. It also configures the Oxygen HTTP proxy for the Java process.

```Java
ProcessController createJavaProcess(String additionalJavaArguments, String[] classpath, String mainClass, String additionalArguments, Map<String,String> environmentalVariables, File startDirectory, ProcessListener processListener)
```

--------------------------------

### Get Start Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/highlights/HighlightPainterInfo

Returns the starting offset of the highlight within the content. This indicates the beginning position of the highlighted segment.

```Java
public int getStartOffset()
```

--------------------------------

### ECSortCustomizerDialog Constructor with Help Page ID

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/sort/ECSortCustomizerDialog

This constructor initializes the ECSortCustomizerDialog with parameters for the parent shell, resource bundle, selected and all elements strings, and an optional help page ID.

```Java
public ECSortCustomizerDialog(org.eclipse.swt.widgets.Shell parentFrame, AuthorResourceBundle authorResourceBundle, String selectedElemensString, String allElementsString, String helpPageID)
```

--------------------------------

### Get Start Column of XML Node (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/text/xml/WSXMLTextNodeRange

Retrieves the starting column number (1-based) of an XML node. This method is part of the WSXMLTextNodeRange interface.

```Java
int getStartColumn()
Get the start column, 1 based.
```

--------------------------------

### Get Start Line of XML Node (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/text/xml/WSXMLTextNodeRange

Retrieves the starting line number (1-based) of an XML node. This method is part of the WSXMLTextNodeRange interface.

```Java
int getStartLine()
Get the start line, 1 based.
```

--------------------------------

### Java: computeQuickAssistProposals Method

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/editor/quickassist/IQuickAssistProcessor

Computes and returns a list of quick assist and quick fix proposals for the given invocation context. Returns null if no proposals are available.

```Java
IQuickAssistProposal[] computeQuickAssistProposals(IQuickAssistInvocationContext invocationContext)
Returns a list of quick assist and quick fix proposals for the given invocation context. 
Parameters:
    `invocationContext` - the invocation context 
Returns:
    an array of completion proposals or `null` if no proposals are available
```

--------------------------------

### Get Start Offset of Word

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/SpellSuggestionsInfo

Retrieves the start offset of the word for which spellchecking suggestions are provided. This method is part of the SpellSuggestionsInfo class.

```Java
public int getStartOffset()
```

--------------------------------

### Initialize Web Application

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/WebappAuthorDocumentFactory

Initializes the web application. This is a core method for setting up the Oxygen XML Editor SDK environment.

```Java
public static void init()
Initialize the web application.
```

--------------------------------

### Initialize JRadioButton for Built-in Apache FOP

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/serialized-form

Initializes a `JRadioButton` to select the use of the built-in Apache FOP processor within `FOProcessorsOptionPane`. This is an alternative to using an external FOP installation.

```Java
JRadioButton useBuilInApacheFOP
```

--------------------------------

### doGet Method - ServletPluginConfigExtension

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/plugin/ServletPluginConfigExtension

Handles GET requests by responding with the plugin's configuration page (HTML/CSS/JS).

```Java
public void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
This method responds with the plugin configuration page (html/css/js). 

Overrides:
    `doGet` in class `ServletPluginExtension` 

Parameters:
    `req` - The HTTP request     `resp` - The HTTP response 

Throws:
    `ServletException` - To respect the interface     `IOException` - Thrown by getWriter
```

--------------------------------

### Get Word Start Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/SpellCheckingProblemInfo

Returns the starting character position of the problematic word within the text. This is crucial for pinpointing the exact location of the spell-checking error.

```Java
public int getStartOffset()
```

--------------------------------

### Get Text (Java) - Deprecated

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/AuthorDocumentController

Retrieves a sequence of text from the document's content based on an offset and length. The offset is relative to the text content start. This method is deprecated and `getContentCharSequence()` should be used instead. Example: `getText(0, 18)` returns "PICOMMENTPARAGRAPH". Throws BadLocationException for invalid positions.

```Java
@Deprecated String getText(int offset, int length) throws BadLocationException
```

--------------------------------

### Get Description

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/tei/TEIP5ExtensionsBundle

Returns a string description of the extensions bundle.

```Java
String getDescription()
```

--------------------------------

### Java: Get Balanced Selection Start

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/author/WSAuthorEditorPageBase

Retrieves the start offset of the current balanced selection, usually mirroring the result of getSelectionStart().

```Java
int getBalancedSelectionStart()
```

--------------------------------

### PluginWorkspaceTCBase Constructors

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/PluginWorkspaceTCBase

Constructors for initializing the PluginWorkspaceTCBase. These constructors allow setting up the test environment by providing installation folders, framework folders, plugin folders, options folders, and license keys. Some constructors also accept a product ID to specify the Oxygen XML product being tested.

```Java
PluginWorkspaceTCBase(File installationFolder, File frameworksFolder, File pluginsFolder, File optionsFolder, String licenseKey)

```

```Java
PluginWorkspaceTCBase(File installationFolder, File frameworksFolder, File pluginsFolder, File optionsFolder, String licenseKey, int productID)

```

```Java
PluginWorkspaceTCBase(File frameworksFolder, File pluginsFolder, String licenseKey)

```

--------------------------------

### Quick Assist and Proposal Mechanisms

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/overview-tree

APIs for implementing quick assist features, including proposals, invocation contexts, and processors.

```Java
ro.sync.contentcompletion.editor.InlineProposal
```

```Java
ro.sync.exml.editor.quickassist.IQuickAssistProposal<I>
```

```Java
ro.sync.exml.editor.quickassist.sa.SAQuickAssistProposal
```

```Java
ro.sync.exml.editor.quickassist.IQuickAssistInvocationContext<P>
```

```Java
ro.sync.exml.editor.quickassist.IQuickAssistProcessor
```

--------------------------------

### Get Start and End Offsets from Document Position

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/WSTextBasedEditorPage

Finds the start and end offsets in the document corresponding to the provided DocumentPositionedInfo. Throws BadLocationException if the position is invalid.

```Java
int[] getStartEndOffsets(DocumentPositionedInfo dpInfo) throws BadLocationException
```

--------------------------------

### Get Selection Start Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/author/WSAuthorEditorPageBase

Retrieves the inclusive start offset of the current selection in the Author editor. If multiple selections exist, it returns the start of the last selected interval. If no selection is present, it returns the caret offset.

```Java
int getSelectionStart()
```

--------------------------------

### Initialize InputFilePanel for Apache FOP Input

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/serialized-form

Initializes an `InputFilePanel` for specifying the input file for the Apache FOP processor within `FOProcessorsOptionPane`. This allows users to select the FOP configuration file.

```Java
ro.sync.ui.InputFilePanel apacheFopInputPanel
```

--------------------------------

### init Method - ServletPluginConfigExtension

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/plugin/ServletPluginConfigExtension

Initializes the plugin. Derived classes must call this method.

```Java
public void init() throws ServletException
Derived classes should make sure to call this method. 

Overrides:
    `init` in class `ServletPluginExtension` 

Throws:
    `ServletException` - Thrown to respect the interface
```

--------------------------------

### Java TextContext: Getting Text Offsets

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/content/TextContext

Illustrates how to get the start and end offsets of the current text within the document using getTextStartOffset() and getTextEndOffset().

```Java
int startOffset = textContext.getTextStartOffset();
int endOffset = textContext.getTextEndOffset();
```

--------------------------------

### Get Start and End Offsets

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/WSTextBasedEditorPage

Finds the start and end offsets corresponding to document position information. This method takes a DocumentPositionedInfo object and returns an array of integers.

```Java
int[] getStartEndOffsets(DocumentPositionedInfo dpInfo)
Find the start and end offsets that correspond to a document position information `DocumentPositionedInfo`.
```

--------------------------------

### KeyDefinitionInfo Constructor Summary (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/ditamap/keys/KeyDefinitionInfo

Details the constructor available for the KeyDefinitionInfo class.

```Java
KeyDefinitionInfo()

```

--------------------------------

### Get Start and End Positions

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/document/DocumentPositionedInfo

Retrieves the temporary start and end positions for a given page ID. This can be used to define a range within a specific page.

```Java
Position[] getStartEndPositions(String pageId)
```

--------------------------------

### Initialize OptionPagePluginExtension GUI

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/plugin/option/OptionPagePluginExtension

Initializes the graphical user interface for the option page and loads the stored option values. This method may be called multiple times, so it's recommended to create GUI components only once and reload settings on subsequent calls.

```Java
public abstract JComponent init(PluginWorkspace pluginWorkspace)
```

--------------------------------

### Get AuthorPersistentHighlight End Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/highlights/AuthorPersistentHighlight

Gets the end offset of the highlight. For empty highlights, the start and end offsets are equal, and the isEmpty() method returns true.

```Java
int getEndOffset()
```

--------------------------------

### Process Method Implementation Example

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/plugin/document/DocumentPluginExtension

Illustrates the implementation of the 'process' method within a DocumentPluginExtension. This method is the core logic for plugins, handling the document context and returning the processed result.

```Java
/**
 * Main plugin method.
 *
 * @param context The context the plugin was invoked in.
 * @return The processed data or null if it cannot/does not want to process the data.
 */
public DocumentPluginResult process(DocumentPluginContext context) {
    // Plugin logic here
    return null; // Placeholder for actual processed data or null
}
```

--------------------------------

### doGet Method - Handle GET Requests

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/plugin/PluginConfigExtension

Handles HTTP GET requests to serve the plugin configuration page, including HTML, CSS, and JavaScript.

```Java
public void doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws javax.servlet.ServletException, IOException
Deprecated.
This method responds with the plugin configuration page (html/css/js).
Overrides:
`doGet` in class `WebappServletPluginExtension`
Parameters:
`req` - The HTTP request     `resp` - The HTTP response
Throws:
`javax.servlet.ServletException` - To respect the interface     `IOException` - Thrown by getWriter
```

--------------------------------

### Java: Get Fully Selected Node with Range

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/author/WSAuthorEditorPageBase

Gets the AuthorNode that is perfectly surrounded by the specified selection range (start and end offsets). Returns null if no such node exists.

```Java
AuthorNode getFullySelectedNode(int selectionStart, int selectionEnd)
```

--------------------------------

### Get Offset of Line Start - Java

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/text/WSTextEditorPage

Retrieves the starting offset of a specified line (1-based index). Returns a non-negative offset. Throws BadLocationException or IllegalArgumentException for invalid line numbers. Inherited from WSTextBasedEditorPage.

```Java
int getOffsetOfLineStart(int lineNumber) throws BadLocationException, IllegalArgumentException
```

--------------------------------

### SimpleTableShowPropertiesOperationBase Constructor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/dita/topic/table/simpletable/properties/SimpleTableShowPropertiesOperationBase

Initializes a new instance of the SimpleTableShowPropertiesOperationBase class with the provided TablePropertiesHelper.

```Java
public SimpleTableShowPropertiesOperationBase(TablePropertiesHelper helper)
```

--------------------------------

### Get Balanced Selection

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/author/WSAuthorEditorPageBase

Retrieves the balanced selection start and end offsets based on the provided selection. It adjusts the selection to include the start or end tag if the selection is immediately adjacent to it.

```Java
int[] getBalancedSelection(int selectionStart, int selectionEnd)
```

--------------------------------

### Create Process with Listener

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/WorkspaceUtilities

Creates and starts a process using a given command line, providing a listener to handle process events. It allows specifying the process name, working directory, and console visibility. Returns a controller for the process or null if it cannot be started.

```Java
ProcessController createProcess(ProcessListener processListener, String name, File workingDirectory, String cmdLine, boolean showConsole)
```

--------------------------------

### Create Generic Process with WorkspaceUtilities

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/WorkspaceUtilities

Creates a process that executes a given command line. Requires a process listener, process name, working directory, command line string, and a flag to show the console.

```Java
ProcessController createProcess(ProcessListener processListener, String name, File workingDirectory, String cmdLine, boolean showConsole)
```

--------------------------------

### Get Start and End Positions in Java

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/document/DocumentPositionedInfo

Retrieves the temporary start and end positions for a given page. It returns an array of two positions, where the end position is exclusive, or null if the page is closed or not synchronized.

```Java
public Position[] getStartEndPositions(String pageId)
```

--------------------------------

### Get Problematic Word

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/SpellCheckingProblemInfo

Returns the actual word that was flagged by the spell-checking engine. This is the word located between the start and end offsets.

```Java
public String getWord()
```

--------------------------------

### Get Ancestor Element by Type (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/operations/TableOperationsUtil

Searches for an ancestor AuthorNode with a specified type, starting from a given node. It returns the ancestor node or the node itself if the type matches. Requires the starting node, the desired ancestor type, and a table helper.

```Java
public static AuthorElement getElementAncestor(AuthorNode node, int type, TableHelper tableHelper)
```

--------------------------------

### Configure CHEMISTRY Scenario

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Constant for configuring a CHEMISTRY scenario.

```Java
static final String CHEMISTRY_TRANSFORMATION
```

--------------------------------

### Java: Get String from Content

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/Content

Fetches a string containing a specified number of characters from the content sequence, starting at a given offset. Requires the starting offset and the length of the desired string. Can throw BadLocationException for invalid ranges.

```Java
String getString(int where, int len) throws BadLocationException
```

--------------------------------

### Download Database Drivers

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Constant for downloading database drivers.

```Java
static final String DOWNLOAD_DATABASE_DRIVERS
```

--------------------------------

### Configure XQuery Scenario

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Constant for configuring an XQuery scenario.

```Java
static final String NEW_SCENARIO_XQUERY
```

--------------------------------

### Get Word Offsets at Caret

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/WSTextBasedEditorPage

Computes and returns the start and end offsets of the word containing the caret. The offsets are inclusive.

```Java
int[] getWordAtCaret()
```

--------------------------------

### Create New Project Constant

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Defines the constant string for the help page ID related to creating a new project. This ID is used to access documentation or UI elements guiding the project creation process.

```Java
static final String CREATE_NEW_PROJECT
Help page ID for topic about creating a new project.
```

--------------------------------

### ServletPluginConfigExtension Constructor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/plugin/ServletPluginConfigExtension

Initializes the ServletPluginConfigExtension. Derived classes should ensure default options are set.

```Java
public ServletPluginConfigExtension()
In the derived class make sure to set the default options.
```

--------------------------------

### Deprecated: WSAuthorEditorPageBase.getSelectionStart

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/AuthorAccessDeprecated

The `getSelectionStart()` method is deprecated. Use `WSAuthorEditorPageBase.getSelectionStart()` to get the inclusive offset of the selection start.

```Java
WSAuthorEditorPageBase.getSelectionStart()
```

--------------------------------

### Configure PostgreSQL Datasource

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Constant for configuring a PostgreSQL datasource.

```Java
static final String CONFIGURE_POSTGRESQL_DATASOURCE
```

--------------------------------

### Get Text Decoration (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/conditions/ProfilingAttributeStylePO

Gets the text decoration to be applied on the content profiled by using this condition value. Example values include "underline", "overline", "double_underline". This method is part of the PersistentObject interface.

```Java
public String getTextDecoration()
```

--------------------------------

### Get Word at Caret

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/WSTextBasedEditorPage

Computes the start and end offsets of the word that currently contains the caret. This method returns an array of integers.

```Java
int[] getWordAtCaret()
Compute the offsets of the word that contains the caret position.
```

--------------------------------

### QuickAssistProposalGroup Constructor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/editor/quickassist/QuickAssistProposalGroup

Initializes a new instance of the QuickAssistProposalGroup class. This constructor takes a display string, an icon path, and a boolean indicating if it's a quick fix group.

```Java
public QuickAssistProposalGroup(String displayString, String iconPath, boolean isQuickFix)
```

--------------------------------

### Initialize TaggedAction for Browse Configuration

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/serialized-form

Initializes a `TaggedAction` for browsing configuration files within the `FOProcessorsOptionPane`. This action likely opens a file chooser dialog.

```Java
ro.sync.ui.application.action.TaggedAction browseConfigurationAction
```

--------------------------------

### Get Relative X Position

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/highlights/HighlightPainterInfo

Returns the horizontal offset from the origin where the highlight should begin. This is a position relative to the start of the box.

```Java
public int getRelativeX()
```

--------------------------------

### Start Process using ProcessController

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/process/ProcessController

The start() method initiates a process and blocks until the process completes execution. It is a core function for managing external processes within the SDK.

```Java
void start()
Start the process. This method blocks until the process ends.
```

--------------------------------

### getIdentifierType Method

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/link/IDTypeIdentifier

Abstract method to get a short description of the identifier type. For example, it might return 'XML ID'.

```Java
public abstract String getIdentifierType()
// Gets a short description of the identifier type. By example for the default ID type recognition returns XML ID.
// Returns: A short description of the identifier type.
```

--------------------------------

### WebappServletPluginExtension - init() Method

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/plugin/WebappServletPluginExtension

The `init(javax.servlet.ServletConfig config)` method is used to initialize the servlet and store the provided `ServletConfig`. This method is deprecated.

```Java
void init(javax.servlet.ServletConfig config);
```

--------------------------------

### Get Column Span Interval

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/support/CALSTableCellInfoProvider

Computes the interval (start and end column) that a cell spans across by analyzing the 'spanspec' attribute.

```Java
int[] getColSpanInterval(AuthorElement cellElem)
```

--------------------------------

### Get ATTRIBUTE_NAME_NAMEST

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/operations/cals/CALSConstants

Retrieves the attribute name for the start column name in a column span specification. This is a constant field value.

```Java
static final String ATTRIBUTE_NAME_NAMEST
The name of the attribute that specifies the start column name in a column span specification element. The value is 'namest'.
```

--------------------------------

### ECPropertiesComposite Constructor (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/properties/ECPropertiesComposite

Initializes an ECPropertiesComposite with a parent TabFolder, a list of TableProperties, context information, an AuthorResourceBundle, and ColorThemeUtilities.

```Java
public ECPropertiesComposite(org.eclipse.swt.widgets.TabFolder parent, List<TableProperty> properties, String contextInfo, AuthorResourceBundle authorResourceBundle, ColorThemeUtilities colorThemeUtilities)
```

--------------------------------

### Oxygen XML SDK: SET_PARAMETER_IN_STARTUP_SCRIPT Constant

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

This constant, SET_PARAMETER_IN_STARTUP_SCRIPT, is a static final String that identifies the section in the user manual detailing how to set a parameter within a start-up script. It is used to link to this specific documentation.

```Java
static final String SET_PARAMETER_IN_STARTUP_SCRIPT
```

--------------------------------

### Get Column Cells Intervals

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/table/operations/AuthorTableDeleteColumnArguments

Retrieves the list of ContentInterval objects representing the cells of the column being deleted. Each interval specifies the start and end offsets of a cell.

```Java
public List<ContentInterval> getColumnCellsIntervals()
```

--------------------------------

### Instantiate KeyDefinitionManager

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/ditamap/keys/KeyDefinitionManager

Provides the default constructor for the KeyDefinitionManager class. This is the primary way to create an instance of the manager.

```Java
public KeyDefinitionManager()
```

--------------------------------

### Get Table Row Span Indices

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/access/AuthorTableAccess

Finds the start and end row indices (0-based) that define the row span interval for a given table cell element. Returns an array with start index and end index, or null if the element is not a valid table cell.

```Java
int[] getTableRowSpanIndices(AuthorElement cellElement)
```

--------------------------------

### Oxygen XML SDK: JRadioButton Example

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/serialized-form

A simple JRadioButton component used for custom color selection in the Oxygen XML SDK.

```Java
JRadioButton customColorForInsert
```

--------------------------------

### Get Table Column Span Indices

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/access/AuthorTableAccess

Finds the start and end column indices (0-based) that define the column span interval for a given table cell element. Returns an array with start index and end index, or null if the element is not a valid table cell.

```Java
int[] getTableColSpanIndices(AuthorElement cellElement)
```

--------------------------------

### Initialize Component with Frameworks Folder

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/component/AuthorComponentFactory

Initializes the component, typically called as early as possible. This overload is used when frameworks and plugins are located in a folder structure. It requires parameters for framework/plugin folders, options, applet context, and license server details.

```Java
authorComponentFactory.init(frameworksAndPluginsFolder, optionsZipURL, appletCodeBase, appletID, servletURL, userName, password);
```

--------------------------------

### Java: Get Balanced Selection

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/author/WSAuthorEditorPageBase

Returns the start and end offsets of the current selection, typically representing the balanced selection boundaries.

```Java
int[] getBalancedSelection(int selectionStart, int selectionEnd)
```

--------------------------------

### ECSortCustomizerDialog Constructor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/sort/ECSortCustomizerDialog

Constructs an ECSortCustomizerDialog with specified parameters for parent shell, resource bundle, selected elements, and all elements. An overloaded constructor also accepts a help page ID.

```Java
public ECSortCustomizerDialog(org.eclipse.swt.widgets.Shell parentFrame, AuthorResourceBundle authorResourceBundle, String selectedElemensString, String allElementsString)
public ECSortCustomizerDialog(org.eclipse.swt.widgets.Shell parentFrame, AuthorResourceBundle authorResourceBundle, String selectedElemensString, String allElementsString, String helpPageID)
```

--------------------------------

### Get Text Descriptors (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/WebappSpellchecker

Returns a list of descriptors for text chunks located between the specified start and end offsets.

```Java
List<TextChunkDescriptor> getTextDescriptors(int startOffset, int endOffset)
```

--------------------------------

### Java - computeQuickAssistProposals Method

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/editor/quickassist/SimpleQuickAssistProcessor

The computeQuickAssistProposals method returns a list of quick assist and quick fix proposals for the specified context. It requires the editor page and the offset where the assist was invoked.

```Java
IQuickAssistProposal[] computeQuickAssistProposals(WSEditorPage editorPage, int offset)
```

--------------------------------

### WebdavLockHelper Constructor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/net/protocol/http/WebdavLockHelper

Initializes a new instance of the `WebdavLockHelper` class. This is the default constructor.

```Java
public WebdavLockHelper()
```

--------------------------------

### Get Word End Offset

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/SpellCheckingProblemInfo

Returns the ending character position of the problematic word within the text. This, along with the start offset, defines the boundaries of the identified word.

```Java
public int getEndOffset()
```

--------------------------------

### getSelectionStart Method - Java

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/AuthorCaretEvent

Gets the starting offset of the current text selection, inclusive. If no text is selected, this value is the same as the caret's offset.

```Java
public int getSelectionStart()
```

--------------------------------

### SATablePropertiesCustomizerDialog Constructor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/properties/SATablePropertiesCustomizerDialog

Initializes a new instance of the SATablePropertiesCustomizerDialog class. This constructor takes a parent frame, an author resource bundle for translations, and color theme utilities as parameters.

```Java
public SATablePropertiesCustomizerDialog(Frame parentFrame, AuthorResourceBundle authorResourceBundle, ColorThemeUtilities colorThemeUtilities)
```

--------------------------------

### Get Node Start Offset - Java

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/node/AuthorNode

Returns the 0-based, inclusive offset in the content that marks the beginning of the node's range within the document.

```Java
int getStartOffset()
```

--------------------------------

### KeyDefinitionInfo Method Summary (Java)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/editor/page/ditamap/keys/KeyDefinitionInfo

Outlines the instance methods provided by the KeyDefinitionInfo class for interacting with key definition attributes and properties.

```Java
Map<String,String> getAttributes()
Get the set of attributes which are defined or cascade to on the key definition.
Object getProperty(String propertyName)
Get the value of a recognized property.
void setAttribute(String attributeName,  String attributeValue)
Set the value of an XML attribute which is defined on the key or cascades to it.
void setProperty(String propertyName,  Object propertyValue)
Get the value of a recognized property.
String toString()

```

--------------------------------

### Get Cell Width

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/AuthorTableColumnWidthProvider

Retrieves the width representation for a specific table cell. Requires the AuthorElement representing the cell, the starting column number, and the column span.

```Java
List<WidthRepresentation> getCellWidth(AuthorElement cellElement, int colNumberStart, int colSpan)
```

--------------------------------

### Initialize WebappFindOptions

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/webapp/findreplace/WebappFindOptions

Constructs a new `WebappFindOptions` object. This class is used to configure find and replace behavior in web applications.

```Java
public WebappFindOptions()
```

--------------------------------

### Create Java Process with WorkspaceUtilities

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/WorkspaceUtilities

Prepares and creates a Java process for execution. Requires arguments for the Java process, classpath, main class, additional arguments, environmental variables, starting directory, and a process listener.

```Java
ProcessController createJavaProcess(String additionalJavaArguments, String[] classpath, String mainClass, String additionalArguments, Map<String,String> environmentalVariables, File startDirectory, ProcessListener processListener)
```

--------------------------------

### Get Cell Width

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/table/support/CALSandHTMLTableCellInfoProvider

Calculates and returns the width representation for a given cell element. It takes the cell element, the starting column number, and the column span as input.

```Java
List<WidthRepresentation> getCellWidth(AuthorElement cellElement,  int colNumberStart,  int colSpan)
```

--------------------------------

### Oxygen XML SDK: Find XSLT References and Declarations Constant

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Defines the constant for finding XSLT references and declarations, used in start location dialogs.

```Java
static final String FIND_XSLT_REFERENCES_AND_DECLARATIONS
```

--------------------------------

### ECSortCustomizerDialog Constructor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/commons/sort/ECSortCustomizerDialog

This constructor initializes the ECSortCustomizerDialog with parameters for the parent shell, resource bundle, and strings representing selected and all elements.

```Java
public ECSortCustomizerDialog(org.eclipse.swt.widgets.Shell parentFrame, AuthorResourceBundle authorResourceBundle, String selectedElemensString, String allElementsString)
```

--------------------------------

### Get Nodes of Interest Criteria (DITA)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/dita/DITAEditImageMapCore

Retrieves the criteria for identifying nodes of interest and defines the start and end points for fragment surrounding in DITA documents. This method is inherited from EditImageMapWithSurroundCore.

```Java
protected String[] getNodesOfInterestCriteria(String namespace)
```

--------------------------------

### External Tools Preferences

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ui/application/HelpPageProvider

Defines the preference key for external tools configuration. This key is used by classes that manage the setup and execution of external tools from within the editor.

```Java
static final String PREFERENCES_EXTERNAL_TOOLS
```

--------------------------------

### Get Change Highlights for AuthorDocumentFragment

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/node/AuthorDocumentFragment

Returns a list of change tracking highlights for the fragment. Offsets are relative to the fragment's start. This method is available since version 12.

```Java
public List<AuthorPersistentHighlight> getChangeHighlights()
```

--------------------------------

### Java - SimpleQuickAssistProcessor Interface

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/editor/quickassist/SimpleQuickAssistProcessor

Defines the SimpleQuickAssistProcessor interface for creating quick fixes and assists in the Oxygen XML Editor. It includes methods to determine if an assist is available and to compute the list of available proposals.

```Java
public interface SimpleQuickAssistProcessor {
    boolean canAssist(WSEditorPage editorPage, int offset);
    IQuickAssistProposal[] computeQuickAssistProposals(WSEditorPage editorPage, int offset);
    default short getPriority();
}
```

--------------------------------

### Java Interface: IQuickAssistProcessor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/editor/quickassist/IQuickAssistProcessor

Defines the IQuickAssistProcessor interface for quick fixes and assists. It includes methods to determine if an assist is available, compute proposals, and manage processor priority.

```Java
@API(type=INTERNAL, src=PUBLIC) public interface IQuickAssistProcessor
Quick assist processor for quick fixes and quick assists. 
A processor can provide just quick fixes, just quick assists or both. 
This interface can be implemented by clients.
```

--------------------------------

### Get PluginToolbarCustomizers in Oxygen XML SDK

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/component/AuthorComponentFactory

Retrieves a list of toolbar customizers added by all installed plugins in the Oxygen XML SDK. This feature was introduced in version 14.2.

```Java
public List<ToolbarComponentsCustomizer> getPluginToolbarCustomizers()
Get the toolbar customizers which were added by all installed plugins.
```

--------------------------------

### Key Definition Manager

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/allclasses-index

Manages all key definitions as context for opened topics.

```Java
KeyDefinitionManager
```

--------------------------------

### TextChunkDescriptor Interface Definition

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/util/TextChunkDescriptor

Defines the TextChunkDescriptor interface for representing a text chunk within a document. It includes methods to get the character sequence, language code, and start offset.

```Java
public interface TextChunkDescriptor
Descriptor for a text chunk from a document.

Since:
    18.1
```

--------------------------------

### Get Characters in Segment

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/AuthorDocumentController

Retrieves a portion of the document's content into a provided Segment object. Requires valid start position and length, and throws BadLocationException for invalid parameters.

```Java
void getChars(int where, int len, Segment chars) throws BadLocationException
The content represents the entire text content of the Author page + additional markers/sentinels at offsets which are pointed to by the AuthorNodes. Each AuthorNode points to specific start and end character markers in the content. The start and end offsets pointed to by the AuthorNode can be retrieved using the AuthorNode.getStartOffset() and AuthorNode.getEndOffset()   
  
Retrieves a portion of the content into the specified `Segment`. 

Parameters:
    `where` - The starting position >= 0, where + len <= length()     `len` - The number of characters to be retrieved >= 0     `chars` - The `Segment` object to return the characters int.o 

Throws:
    `BadLocationException` - If the specified position or length are invalid.
```

--------------------------------

### Apply Completion Proposal

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/editor/quickassist/IQuickAssistProposal

The `apply()` method is responsible for inserting the proposed completion into the provided document. This is a core function for content assist features.

```Java
void apply()
Inserts the proposed completion into the given document.
```

--------------------------------

### Choose Directory (With Context)

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/WorkspaceUtilities

Displays a directory chooser dialog, allowing a starting directory to be specified. This method is available for both standalone oXygen and the Eclipse plugin. Available since version 21.1.

```Java
File chooseDirectory(File startingDir)
```

--------------------------------

### Get Caret Offset by Anchor

Source: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensions/api/AuthorAccess

Obtains the caret offset identified by a URL anchor. The anchor syntax is interpreted by the framework's ElementLocatorProvider, with a specific example format provided for context.

```Java
int getCaretOffsetByAnchor(String anchor)
Get the caret offset identified by the given URL anchor. The syntax of the anchor is interpreted by the `ElementLocatorProvider` provided by the framework or: "short;locationInfo\0pathItems\0isWhitespaceBefore\0tokenPosition\0chCount\0anchorsOnChangeTrackingPI" example: "short;chrysanthemum/section_anp_qrw_p1b /section[1]/p[3]/b[1] false 0 16 false"

Parameters:
`anchor` - The anchor.

Returns:
The caret offset identified by the anchor.

Since:
19.1
```
Tokens:
Raw