Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Exceptions
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
ro.sync.ecss.extensions.api.AttributesValueEditor Starting with version 15 the CustomAttributeValueEditor can be used instead to edit only specific attributes using a custom editor.
ro.sync.exml.plugin.urlstreamhandler.URLChooserPluginExtension This approach will continue to work but it is recommanded to use the ro.sync.exml.plugin.urlstreamhandler.URLChooserPluginExtension2 interface which also receives access to the Oxygen workspace.

Deprecated Exceptions

Exceptions and Description
ro.sync.ecss.extensions.commons.CannotEditException

Deprecated Fields

Field and Description
ro.sync.exml.MainFrameComponentsConstants.CUSTOM Since Oxygen 12.2 the preferred way is to define view IDs at plugin.xml level.
ro.sync.exml.workspace.api.standalone.ToolbarComponentsCustomizer.CUSTOM Since Oxygen 12.2 toolbar IDs are defined in the "plugin.xml".
ro.sync.exml.workspace.api.standalone.ViewComponentCustomizer.CUSTOM since Oxygen 12.2. Please define a view id for the extension in the "plugin.xml".
ro.sync.ecss.css.Styles.KEY_LINK_URL since 17
ro.sync.ecss.css.Styles.KEY_TEXT_DECORATION It is a shorthand now, use Styles.KEY_TEXT_DECORATION_LINE, Styles.KEY_TEXT_DECORATION_COLOR, Styles.KEY_TEXT_DECORATION_STYLE instead.
ro.sync.ecss.extensions.api.AuthorConstants.POSITION_INSIDE Use the constant POSITION_INSIDE_FIRST instead.
ro.sync.ecss.extensions.api.editor.InplaceEditorCSSConstants.PROPERTY_EDIT Use InplaceEditorArgumentKeys.PROPERTY_EDIT_QUALIFIED instead. In case of an attribute it will offer a clark name instead of the QName used in the CSS.
ro.sync.exml.MainFrameComponentsConstants.TOOLBAR_CUSTOM Since Oxygen 12.2 toolbar IDs are defined in the "plugin.xml".
ro.sync.exml.plugin.PluginDescriptor.URL_STREAM_HANDLER

Deprecated Methods

Method and Description
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.addAuthorListener(AuthorListener) Use AuthorDocumentController.addAuthorListener(AuthorListener) intead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.chooseFile(String, String[], String) Use WorkspaceUtilities.chooseURL(String, String[], String) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.chooseFile(String, String[], String, boolean) Use WorkspaceUtilities.chooseFile(String, String[], String, boolean) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.chooseURL(String, String[], String) Use WorkspaceUtilities.chooseURL(String, String[], String) instead.
ro.sync.exml.workspace.api.WorkspaceUtilities.clearImageCache()
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.correctURL(String) Use UtilAccess.correctURL(String) instead.
ro.sync.ecss.extensions.api.component.AuthorComponentFactory.createAuthorComponentProvider() Please use ro.sync.ecss.extensions.api.component.AuthorComponentFactory.createEditorComponentProvider(String[], String) instead.
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.createExtensionActionsToolbars() Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).createExtensionActionsToolbars();
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.deleteSelection() Use WSAuthorEditorPageBase.deleteSelection() instead.
ro.sync.ecss.extensions.api.component.AuthorComponentFactory.disposeAuthorComponentProvider(AuthorComponentProvider) Please use ro.sync.ecss.extensions.api.component.AuthorComponentFactory.disposeEditorComponentProvider() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.escapeAttributeValue(String) Use AuthorUtilAccess.escapeAttributeValue(String) instead.
ro.sync.ecss.extensions.api.access.AuthorUtilAccess.escapeAttributeValue(String) Use the method from the AuthorXMLUtilAccess class.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.evaluateXPath(String, boolean, boolean, boolean) Use AuthorDocumentController.evaluateXPath(String, boolean, boolean, boolean) instead.
ro.sync.ecss.dita.DITAAccess.filterAttributeValues(List<CIValue>, WhatPossibleValuesHasAttributeContext, String) Please use the equivalent method which also receives the URL of the requestor.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.findNodesByXPath(String, boolean, boolean, boolean) Use AuthorDocumentController.findNodesByXPath(String, boolean, boolean, boolean) instead.
ro.sync.ecss.extensions.api.editor.AuthorInplaceContext.getAttributeToEdit() Use AuthorInplaceContext.getAttributeToEditQName() instead. This method returns the attribute name as it was specified in the CSS. If a QName was specified then this QName might not be valid in the context of the current element. Property InplaceEditorArgumentKeys.PROPERTY_EDIT_QUALIFIED should be used in these situations.
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.getAuthorAccess() Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getAuthorAccess().
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.getAuthorCommonActions() Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getActionsProvider().getAuthorCommonActions().
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.getAuthorExtensionActions() Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getActionsProvider().getAuthorExtensionActions().
ro.sync.ecss.extensions.api.AuthorElementBaseInterface.getBeforeElement() This functionality is needed from the CSS style matcher, so it will eventually move there. Will be removed in 17.0 or later.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getCaretOffset() Use WSTextBasedEditorPage.getCaretOffset() instead. For example if you have an AuthorAccess object then use authorAccess.getEditorAccess().getCaretOffset().
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getChangeTrackingController() Use AuthorAccess.getReviewController() instead.
ro.sync.exml.workspace.api.editor.page.author.WSAuthorEditorPage.getChangeTrackingController() Use WSAuthorEditorPage.getReviewController() instead.
ro.sync.ecss.extensions.api.node.AuthorElement.getChild(String) Use AuthorElement.getElementsByLocalName(String)[0] instead.
ro.sync.ecss.extensions.api.component.ditamap.DITAMapTreeComponentProvider.getDITACommonActions() Please use instead the method getDITAAccess().getActionsProvider().getActions().
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getEditorLocation() Use WSEditorBase.getEditorLocation() instead.
ro.sync.ecss.dita.DITAAccess.getInsertTopicgroup(Object, AuthorCCManager, AuthorDocumentControllerImpl, int) This method is not used anymore from oXygen to insert topic group elements and it will be removed in a future release. All topic reference elements are inserted using the same method: #insertTopicReference(URL, Object, AuthorCCManager, AuthorDocumentController, int, String, TopicRefInserter, String, boolean)
ro.sync.ecss.dita.DITAAccess.getInsertTopichead(Object, AuthorCCManager, AuthorDocumentControllerImpl, int) This method is not used anymore from oXygen to insert topichead elements and it will be removed in a future release. All topic reference elements are inserted using the same method: #insertTopicReference(URL, Object, AuthorCCManager, AuthorDocumentController, int, String, TopicRefInserter, String, boolean)
ro.sync.ecss.dita.DITAAccess.getKeys() Please use the equivalent method which also receives the URL of the requestor.
ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandlerAdapter.getLastResult() Will be removed in a future version
ro.sync.ecss.extensions.api.access.AuthorEditorAccess.getLocationOnScreen(int, int) Use the getLocationOnScreenAsPoint(int x, int y) method instead.
ro.sync.ecss.dita.DITAAccess.getNewMapTitle(Object, String, boolean) This method is not used anymore from oXygen to edit map titles and it will be removed in a future release. The map root is now edited using the following method: DITAAccess.editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
ro.sync.ecss.extensions.api.OptionChangedEvent.getNewValue()
ro.sync.ecss.extensions.api.OptionChangedEvent.getOldValue()
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getParentFrame() Use WorkspaceUtilities.getParentFrame() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getSelectedText() Use WSAuthorEditorPageBase.getSelectedText() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getSelectionEnd() Use WSAuthorEditorPageBase.getSelectionEnd() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getSelectionStart() Use WSAuthorEditorPageBase.getSelectionStart() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableCellAbove(AuthorElement) Use AuthorTableAccess.getTableCellAbove(AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableCellAt(int, int, AuthorElement) Use AuthorTableAccess.getTableCellAt(int, int, AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableCellBelow(AuthorElement) Use AuthorTableAccess.getTableCellBelow(AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableCellIndex(AuthorElement) Use AuthorTableAccess.getTableCellIndex(AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableColSpanIndices(AuthorElement) Use AuthorTableAccess.getTableColSpanIndices(AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableNumberOfColumns(AuthorElement) Use AuthorTableAccess.getTableNumberOfColumns(AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableRow(int, AuthorElement) Use AuthorTableAccess.getTableRow(int, AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getTableRowCount(AuthorElement) Use AuthorTableAccess.getTableRowCount(AuthorElement) instead.
ro.sync.ecss.extensions.api.AuthorDocumentController.getText(int, int) Please use the API AuthorDocumentController.getChars(int, int, Segment).
ro.sync.ecss.extensions.api.AuthorDocumentController.getTextContentLength() Use the API based on the AuthorNode to get the length of the displayed text only, without mark-up markers.
ro.sync.ecss.css.Styles.getTextDecoration() This was used to return only the text-decoration-line part from the text-decoration shorthand, as defined here https://drafts.csswg.org/css-text-decor-3/#text-decoration-property.
ro.sync.ecss.dita.DITAAccess.getTopicGroupInfo(Object, AuthorCCManager, AuthorDocumentControllerImpl, int, TopicgroupInfo) This method is not used anymore from oXygen to edit topic group elements and it will be removed in a future release. All topic reference elements are edited using the same method: DITAAccess.editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
ro.sync.ecss.dita.DITAAccess.getTopicHeadInfo(Object, AuthorCCManager, AuthorDocumentControllerImpl, int, TopicheadInfo) This method is not used anymore from oXygen to edit topichead elements and it will be removed in a future release. All topic reference elements are edited using the same method: DITAAccess.editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
ro.sync.ecss.dita.DITAAccess.getTopicRefInfo(URL, Object, AuthorCCManager, AuthorDocumentControllerImpl, int, TopicrefInfo, TopicRefInserter) This method is not used anymore from oXygen to insert topic reference elements and it will be removed in a future release. All topic reference elements are inserted using the same method: DITAAccess.editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.getWordAtCaret() Use WSTextBasedEditorPage.getWordAtCaret() instead.
ro.sync.ecss.extensions.api.table.operations.AuthorTableOperationsHandler.handleDeleteRow(AuthorTableDeleteRowArguments) Use AuthorTableOperationsHandler.handleDeleteRows(AuthorTableDeleteRowsArguments) method instead.
ro.sync.ecss.extensions.docbook.DocbookAuthorTableOperationsHandler.handleDeleteRow(AuthorTableDeleteRowArguments)
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.hasSelection() Use WSAuthorEditorPageBase.hasSelection() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.inInlineContext(int) Use AuthorDocumentController.inInlineContext(int) instead.
ro.sync.ecss.extensions.api.component.AuthorComponentFactory.init(URL[], URL, URL, String, String, String, int) Use {init(URL[], URL, URL, String, String, LicenseServerInformation)} or {init(URL[], URL, URL, String, String)} instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.insertMultipleElements(AuthorElement, String[], int[], String) Use AuthorDocumentController.insertMultipleElements(AuthorElement, String[], int[], String) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.insertText(String, int) Use AuthorDocumentController.insertText(int, String) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.insertXMLFragment(String, int) Use AuthorDocumentController.insertXMLFragment(String, int) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.insertXMLFragment(String, String, String) Use AuthorDocumentController.insertXMLFragment(String, String, String) instead.
ro.sync.ecss.extensions.api.AuthorElementBaseInterface.isFirstChildElement()
ro.sync.ecss.extensions.api.DocumentContentChangedEvent.isSimpleTextEdit() Use DocumentContentChangedEvent.getType() to determine the type of edit.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.isStandalone() Use Workspace.isStandalone() instead.
ro.sync.exml.workspace.api.Workspace.isStandalone() This method returns false also when running inside the WebApp. Use Workspace.getPlatform() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.isTrackingChanges() Use ChangeTrackingController.isTrackingChanges() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.locateFile(URL) Use UtilAccess.locateFile(URL) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.makeRelative(URL, URL) Use UtilAccess.makeRelative(URL, URL) instead.
ro.sync.ecss.extensions.api.access.AuthorEditorAccess.modelToView(int) use modelToViewRectangle(int offset) instead
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.multipleDelete(AuthorElement, int[], int[]) Use AuthorDocumentController.multipleDelete(AuthorElement, int[], int[]) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.newNonValidatingXMLReader() Use AuthorUtilAccess.newNonValidatingXMLReader() instead.
ro.sync.ecss.extensions.api.access.AuthorUtilAccess.newNonValidatingXMLReader() Use the method from the AuthorXMLUtilAccess class.
ro.sync.ecss.extensions.api.access.AuthorWorkspaceAccess.open(File) Use Workspace.open(URL) instead.
ro.sync.ecss.dita.DITAAccess.parseDITAKeyRef(String) Please use the equivalent method which also receives the URL of the requestor.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.removeAuthorListener(AuthorListener) Use AuthorDocumentController.removeAuthorListener(AuthorListener) intead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.removeClonedElementAttribute(AuthorElement, String) Use AuthorElement.removeAttribute(String) instead.
ro.sync.ecss.extensions.api.access.AuthorUtilAccess.resetXMLCatalogs() Use the method from the AuthorXMLUtilAccess class.
ro.sync.ecss.dita.DITAAccess.resolveKeyRef(String) Please use the equivalent method which also receives the URL of the requestor.
ro.sync.ecss.dita.DITAAccess.resolveKeyRef(String, boolean) Please use the equivalent method which also receives the URL of the requestor.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.resolvePath(URL, String, boolean, boolean) Use AuthorUtilAccess.resolvePath(URL, String, boolean, boolean) instead.
ro.sync.ecss.extensions.api.access.AuthorUtilAccess.resolvePath(URL, String, boolean, boolean) Use the method from the AuthorXMLUtilAccess class.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.select(int, int) Use WSAuthorEditorPageBase.select(int, int) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.selectWord() Use WSTextBasedEditorPage.selectWord() instead.
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.setBreadCrumbPopUpCustomizer(PopupMenuCustomizer) Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).setBreadCrumbPopUpCustomizer();
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.setCaretPosition(int) Use WSTextBasedEditorPage.setCaretPosition(int) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.setClonedElementAttribute(AuthorElement, String, AttrValue) Use AuthorElement.setAttribute(String, AttrValue) instead.
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.setEditorPopUpCustomizer(PopupMenuCustomizer) Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage())addPopUpMenuCustomizer(AuthorPopupMenuCustomizer popUpCustomizer)
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.setOutlinerPopUpCustomizer(PopupMenuCustomizer) Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).setOutlinerPopUpCustomizer();
ro.sync.exml.workspace.api.editor.page.author.WSAuthorEditorPageBase.setPopUpMenuCustomizer(AuthorPopupMenuCustomizer) This method removes all pop-up menu customizers already registered, please use the "addPopUpMenuCustomizer" method instead.
ro.sync.ecss.extensions.api.highlights.ColorHighlightPainter.setStrikeOut(boolean) Use ColorHighlightPainter.setTextDecoration(TextDecoration) instead.
ro.sync.ecss.extensions.api.component.AuthorComponentProvider.showBreadCrumb(boolean) Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).showBreadCrumbPanel();
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.showConfirmDialog(String, String, String[], int[]) Use WorkspaceUtilities.showConfirmDialog(String, String, String[], int[]) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.showErrorMessage(String) Use WorkspaceUtilities.showErrorMessage(String) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.surroundInFragment(String, int, int) Use AuthorDocumentController.surroundInFragment(String, int, int) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.surroundInText(String, String, int, int) Use AuthorDocumentController.surroundInText(String, String, int, int) instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.toggleTrackChanges() Use ChangeTrackingController.toggleTrackChanges() instead.
ro.sync.ecss.extensions.api.AuthorAccessDeprecated.viewToModel(int, int) Use WSAuthorEditorPageBase.viewToModel(int, int) instead.

Deprecated Constructors

Constructor and Description
ro.sync.ecss.extensions.dita.conref.DITAConRefResolver(ContextKeyManager) use DITAConRefResolver.DITAConRefResolver(ContextKeyManagerProvider) instead.
ro.sync.ecss.extensions.dita.link.DitaLinkTextResolver(ContextKeyManager) use DitaLinkTextResolver.DitaLinkTextResolver(ContextKeyManagerProvider) instead.
ro.sync.ecss.extensions.dita.map.topicref.DITAMapRefResolver(ContextKeyManager) use DITAMapRefResolver.DITAMapRefResolver(ContextKeyManagerProvider) instead.
ro.sync.ecss.extensions.api.highlights.HighlightPainterInfo(Graphics, int, Point, int, int, int, int, int, int, int, int, int, Point) Use the constructors with parentLineBoxWidth, parentLineBoxHeight, parentLineBoxOrigin.
ro.sync.ecss.extensions.api.highlights.HighlightPainterInfo(Graphics, int, Point, int, int, int, int, int, int, int, int, Point) Use the constructors with parentLineBoxWidth, parentLineBoxHeight, parentLineBoxOrigin.
ro.sync.ecss.extensions.api.OptionChangedEvent(String, String, String)

Deprecated Enum Constants

Enum Constant and Description
ro.sync.ecss.extensions.api.CursorType.CURSOR_RESIZE Use CursorType.CURSOR_E_RESIZE instead.
ro.sync.ecss.extensions.api.CursorType.CURSOR_SELECT_ROW You should use one of the two other constants, specifying the direction.
ro.sync.ecss.extensions.api.CursorType.CURSOR_SELECT_TABLE You should use one of the two other constants, specifying the direction.