|
Oxygen XML Editor 11.2 Author API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface AuthorAccessDeprecated
Contains methods that are deprecated in the AuthorAccess
and should no longer be used.
| Method Detail |
|---|
@Deprecated int getSelectionStart()
WSTextBasedEditorPage.getSelectionStart() instead.
@Deprecated int getSelectionEnd()
WSTextBasedEditorPage.getSelectionEnd() instead.
@Deprecated String getSelectedText()
WSTextBasedEditorPage.getSelectedText() instead.
@Deprecated int getCaretOffset()
WSTextBasedEditorPage.getCaretOffset() instead.
@Deprecated
void insertText(String text,
int offset)
AuthorDocumentController.insertText(int, String) instead.
text - The text to insert.offset - The offset of the insertion point, 0 based.
@Deprecated
void insertXMLFragment(String xmlFragment,
int offset)
throws AuthorOperationException
AuthorDocumentController.insertXMLFragment(String, int) instead.
xmlFragment - The XML fragment.offset - The offset of the insertion point, 0 based.
AuthorOperationException - If it could not be inserted.
@Deprecated
void insertXMLFragment(String xmlFragment,
String xpathLocation,
String relativePosition)
throws AuthorOperationException
AuthorDocumentController.insertXMLFragment(String, String, String) instead.
xpathLocation is not specified then the XML fragment
will be inserted at the caret position(relativePosition is ignored).
After the operation is performed the caret will be positioned at the end of the inserted XML fragment.
- Parameters:
xmlFragment - The XML fragment.xpathLocation - The xpath location.relativePosition - The position relative to the node identified by the xpath location.
Can be one of the constants: AuthorConstants.POSITION_BEFORE, AuthorConstants.POSITION_AFTER,
AuthorConstants.POSITION_INSIDE.
- Throws:
AuthorOperationException - If it could not be inserted.
@Deprecated void deleteSelection()
WSTextBasedEditorPage.deleteSelection() instead.
@Deprecated boolean hasSelection()
WSTextBasedEditorPage.hasSelection() instead.
true If there is a selection, false otherwise.@Deprecated void selectWord()
WSTextBasedEditorPage.selectWord() instead.
@Deprecated
void surroundInFragment(String xmlFragment,
int startOffset,
int endOffset)
throws AuthorOperationException
AuthorDocumentController.surroundInFragment(String, int, int) instead.
xmlFragment.
If endOffset < startOffset the xmlFragment will be inserted at startOffset.
xmlFragment - The XML fragment which will surround the given offsets.
The first XML fragment leaf(deepest on the first branch) will be the surround point.startOffset - The start offset of the fragment to be surrounded, 0 based and inclusive.endOffset - The end offset of the fragment to be surrounded, 0 based and inclusive.
AuthorOperationException - If the fragment between the offsets could not be surrounded.
@Deprecated
void surroundInText(String header,
String footer,
int startOffset,
int endOffset)
AuthorDocumentController.surroundInText(String, String, int, int) instead.
header - The header to be inserted before the surrounded text.footer - The footer to be inserted after the surrounded text.startOffset - The start offset of the text to be surrounded, 0 based.endOffset - The end offset of the text to be surrounded, zero based.@Deprecated void setCaretPosition(int offset)
WSTextBasedEditorPage.setCaretPosition(int) instead.
offset - The offset where the caret should be positioned, 0 based.
@Deprecated
void select(int startOffset,
int endOffset)
WSTextBasedEditorPage.select(int, int) instead.
startOffset - Inclusive start offsetendOffset - Exclusive end offset@Deprecated int[] getWordAtCaret()
WSTextBasedEditorPage.getWordAtCaret() instead.
null if the offsets couldn't be obtained.@Deprecated Object getParentFrame()
Workspace.getParentFrame() instead.
@Deprecated
String makeRelative(URL baseURL,
URL childURL)
UtilAccess.makeRelative(URL, URL) instead.
The child path is relatively expressed to the base file. If is not possible, the child URL is returned.
Ex: Base: "file://c:/projects/exml/base.prx", Child "file://c:/projects/exml/test/someTest.xml"
Result: "test/someTest.xml"
baseURL - The base URL.childURL - The child URL.
childURL if a relative path
cannot be computed.@Deprecated String escapeAttributeValue(String attributeValue)
AuthorUtilAccess.escapeAttributeValue(String) instead.
attributeValue - The attribute value.
@Deprecated URL getEditorLocation()
WSEditorBase.getEditorLocation() instead.
@Deprecated File locateFile(URL url)
UtilAccess.locateFile(URL) instead.
url - The URL to be checked.
null if URL is remote.
@Deprecated
File chooseFile(String title,
String[] allowedExtensions,
String filterDescr,
boolean openForSave)
Workspace.chooseFile(String, String[], String, boolean) instead.
title - The file chooser title.allowedExtensions - Allowed file extensions.filterDescr - Description for this file filter.openForSave - True to show the file chooser for saving, false to use it for opening
null if user canceled the dialog...
@Deprecated
File chooseFile(String title,
String[] allowedExtensions,
String filterDescr)
Workspace.chooseURL(String, String[], String) instead.
title - The file chooser title.allowedExtensions - Allowed file extensions.filterDescr - Description for this file filter.
null if user canceled the dialog...
@Deprecated
URL chooseURL(String title,
String[] allowedExtensions,
String filterDescr)
Workspace.chooseURL(String, String[], String) instead.
title - The file chooser title.allowedExtensions - Allowed extensions.filterDescr - Description for this file filter.
null if user canceled the dialog...@Deprecated AuthorElement getTableCellAbove(AuthorElement cellElement)
AuthorTableAccess.getTableCellAbove(AuthorElement) instead.
cellElement - The table cell element.
null.@Deprecated AuthorElement getTableCellBelow(AuthorElement cellElement)
AuthorTableAccess.getTableCellBelow(AuthorElement) instead.
cellElement - The table cell element.
null.@Deprecated int[] getTableCellIndex(AuthorElement authorElement)
AuthorTableAccess.getTableCellIndex(AuthorElement) instead.
authorElement - The element.
null.
@Deprecated
AuthorElement getTableCellAt(int row,
int column,
AuthorElement tableElement)
AuthorTableAccess.getTableCellAt(int, int, AuthorElement) instead.
row - The row, 0 based.column - The column, 0 based.tableElement - The table element.
null if it could not be
found.
@Deprecated
AuthorElement getTableRow(int index,
AuthorElement tableElement)
AuthorTableAccess.getTableRow(int, AuthorElement) instead.
index - The index of the row to find, 0 based.tableElement - The table element.
null.@Deprecated int getTableRowCount(AuthorElement tableElement)
AuthorTableAccess.getTableRowCount(AuthorElement) instead.
tableElement - The table element.
@Deprecated int getTableNumberOfColumns(AuthorElement tableElement)
AuthorTableAccess.getTableNumberOfColumns(AuthorElement) instead.
tableElement - The table element.
@Deprecated int[] getTableColSpanIndices(AuthorElement cellElement)
AuthorTableAccess.getTableColSpanIndices(AuthorElement) instead.
cellElement - The table cell element.
null.@Deprecated boolean isStandalone()
Workspace.isStandalone() instead.
true if this is the standalone Oxygen version,
false if this is the Oxygen Eclipse plugin version.
@Deprecated
boolean inInlineContext(int offset)
throws BadLocationException
AuthorDocumentController.inInlineContext(int) instead.
offset is inline or not.
For example a text paragraph determines an inline context,
and for an offset inside this paragraph the method will return true.
For an offset between two paragraphs(block boxes) the method will returns false.
offset - The offset in the document, zero based.
true if the given offset is inside an inline context.
false otherwise.
BadLocationException - When the offset does not exists in document model.
@Deprecated
void insertMultipleElements(AuthorElement parentElement,
String[] elementNames,
int[] offsets,
String namespace)
AuthorDocumentController.insertMultipleElements(AuthorElement, String[], int[], String) instead.
parentElement - The element that will be the parent of the inserted elements.elementNames - The element names to be inserted.offsets - The absolute offsets where the elements will be inserted.namespace - The namespace of the new inserted elements. null for default namespace.
@Deprecated
void multipleDelete(AuthorElement parentElement,
int[] startOffsets,
int[] endOffsets)
AuthorDocumentController.multipleDelete(AuthorElement, int[], int[]) instead.
parentElement - The element that contains all the deleted intervals.startOffsets - The start offset for each interval. Must be in document order.endOffsets - The end offset for each interval. Must be in document order.
@Deprecated
void removeClonedElementAttribute(AuthorElement element,
String attrName)
AuthorElement.removeAttribute(String) instead.
element - Element node.attrName - The attribute name to remove.
@Deprecated
void setClonedElementAttribute(AuthorElement element,
String name,
AttrValue attributeValue)
AuthorElement.setAttribute(String, AttrValue) instead.
element - Element node.name - Name of the attribute to be set.attributeValue - The attribute value to set. Must not be null.
@Deprecated
int showConfirmDialog(String title,
String message,
String[] buttonNames,
int[] buttonIds)
Workspace.showConfirmDialog(String, String, String[], int[]) instead.
title - The dialog title.message - The message to be presented to the user.buttonNames - The names of the buttons representing the choices.buttonIds - The id for each button. Used to identify which button was pressed.
All ids must be greater or equal to 0.
@Deprecated XMLReader newNonValidatingXMLReader()
AuthorUtilAccess.newNonValidatingXMLReader() instead.
@Deprecated String correctURL(String url)
UtilAccess.correctURL(String) instead.
url - The URL to be corrected.
@Deprecated void showErrorMessage(String message)
Workspace.showErrorMessage(String) instead.
message - The error message to be presented.
@Deprecated
URL resolvePath(URL baseURL,
String relativeLocation,
boolean entityResolve,
boolean uriResolve)
AuthorUtilAccess.resolvePath(URL, String, boolean, boolean) instead.
baseURL - The URL of the current opened XML file.relativeLocation - The relative href.entityResolve - True to pass through catalog entity resolveruriResolve - True to pass through catalog URI resolver.
@Deprecated
AuthorNode[] findNodesByXPath(String xpathExpression,
boolean ignoreTexts,
boolean ignoreCData,
boolean ignoreComments)
throws AuthorOperationException
AuthorDocumentController.findNodesByXPath(String, boolean, boolean, boolean) instead.
//node()
will return an array with all the AuthorNode's in the document.
count(//node())
will return an empty array.
xpathExpression - The XPath expression.ignoreTexts - If true Author text nodes will not be returned.ignoreCData - If true Author CDATA sections will not be returned.ignoreComments - If true Author comments will not be returned.
AuthorOperationException - If the XPath expression failed to be evaluated.
@Deprecated
Object[] evaluateXPath(String xpathExpression,
boolean ignoreTexts,
boolean ignoreCData,
boolean ignoreComments)
throws AuthorOperationException
AuthorDocumentController.evaluateXPath(String, boolean, boolean, boolean) instead.
//node()
will return an array with all the Author DOM Node wrappers in the document.
count(//node())
will return an array having a single component representing the number of nodes in the document.
//node(), count(//node())
will return an array containing all the Author DOM Node wrappers in the document and having as last component
the total number of nodes.
xpathExpression - The XPath expression.ignoreTexts - If true DOM text nodes will not be returned.ignoreCData - If true DOM CDATA sections will not be returned.ignoreComments - If true DOM comments will not be returned.
AuthorOperationException - If the XPath expression failed to be evaluated.@Deprecated void addAuthorListener(AuthorListener listener)
AuthorDocumentController.addAuthorListener(AuthorListener) intead.
listener - The listener to be added.@Deprecated void removeAuthorListener(AuthorListener listener)
AuthorDocumentController.removeAuthorListener(AuthorListener) intead.
listener - The listener to be removed.
@Deprecated
AuthorViewToModelInfo viewToModel(int x,
int y)
WSAuthorEditorPageBase.viewToModel(int, int) instead.
x - The "x" coordinate relative to the viewport origin.y - The "y" coordinate relative to the viewport origin.
@Deprecated boolean isTrackingChanges()
AuthorChangeTrackingController.isTrackingChanges() instead.
true if the current editor is in change tracking mode
true if the current editor is in change tracking mode@Deprecated void toggleTrackChanges()
AuthorChangeTrackingController.toggleTrackChanges() instead.
|
Oxygen XML Editor 11.2 Author API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||