Interface WSXMLTextEditorPage
-
- All Superinterfaces:
WSEditorPage
,WSTextBasedEditorPage
,WSTextEditorPage
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSXMLTextEditorPage extends WSTextEditorPage
Contains methods specific to XML editors.- Since:
- 14
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object[]
evaluateXPath(java.lang.String xpathExpression)
Evaluates an XPath expression.WSXMLTextNodeRange[]
findElementsByXPath(java.lang.String xpathExpression)
Finds the nodes selected by the given XPath expression.TextDocumentController
getDocumentController()
Get a controller which has utility methods to manipulate XML content in the Text editing mode.WSTextXMLSchemaManager
getXMLSchemaManager()
Get the schema manager used to ask useful information about allowed elements and the context of the current offset.-
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSEditorPage
getParentEditor, hasFocus, isEditable, requestFocus, setEditable, setReadOnly, setReadOnly
-
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage
createAnchor, deleteSelection, getCaretOffset, getLocationOnScreenAsPoint, getLocationRelativeToEditorFromScreen, getOffsetForAnchor, getSelectedText, getSelectionEnd, getSelectionStart, getStartEndOffsets, getWordAtCaret, hasSelection, modelToViewRectangle, scrollCaretToVisible, select, selectWord, setCaretPosition, viewToModelOffset
-
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.text.WSTextEditorPage
addExternalContentCompletionProvider, addPopUpMenuCustomizer, addQuickAssistProcessor, beginCompoundUndoableEdit, endCompoundUndoableEdit, getActionsProvider, getColumnOfOffset, getDocument, getLineOfOffset, getOffsetOfLineEnd, getOffsetOfLineStart, getTextComponent, removeExternalContentCompletionProvider, removePopUpMenuCustomizer, removeQuickAssistProcessor
-
-
-
-
Method Detail
-
findElementsByXPath
WSXMLTextNodeRange[] findElementsByXPath(java.lang.String xpathExpression) throws XPathException
Finds the nodes selected by the given XPath expression. The result of this function is an array ofWSXMLTextNodeRange
selected by the given XPath expression.
For example executing the expression://node()
But the result of calling the function with the expression:count(//node())
- Parameters:
xpathExpression
- The XPath expression. If the XPath expression is relative, it will be computed in the context of the current caret position.- Returns:
- The node ranges selected by the XPath expression.
It does not return a
null
array of nodes. If the evaluation of the XPath expression fails it will return an empty array. - Throws:
XPathException
- If the XPath expression failed to be evaluated.
-
evaluateXPath
java.lang.Object[] evaluateXPath(java.lang.String xpathExpression) throws XPathException
Evaluates an XPath expression. This function returns the result of the given XPath expression as an array ofObject
.
For example, executing the expression://node()
while evaluating the expression:count(//node())
Evaluating the expression://node(), count(//node())
- Parameters:
xpathExpression
- The XPath expression. If the XPath expression is relative, it will be computed in the context of the current caret position.- Returns:
- An array of objects representing the XPath result.
It does not return a
null
array. If the XPath evaluation fails it will return an empty array. - Throws:
XPathException
- If the XPath expression failed to be evaluated.
-
getXMLSchemaManager
WSTextXMLSchemaManager getXMLSchemaManager()
Get the schema manager used to ask useful information about allowed elements and the context of the current offset.- Specified by:
getXMLSchemaManager
in interfaceWSTextEditorPage
- Returns:
- the XML Schema Manager used to ask useful information about allowed elements and the context of the current offset.
-
getDocumentController
TextDocumentController getDocumentController()
Get a controller which has utility methods to manipulate XML content in the Text editing mode.- Returns:
- The text document controller.
- Since:
- 16.1
-
-