API Changes in Oxygen
Please see Javadoc for more details.
Added Classes in version 25.1:
Added Methods in version 25.1:
- public static URL attachKeyScopeInformation(URL targetURL, String keyref, String contextMapURL, String originalKeyName)
- public static List<String> computeQualifiedKeyNames(String keyToken, Stack<Set<String>> keyScopeStack)
- public static boolean preferAddingKeyrefToAlreadyReferencedResource(URL editorURL)
- public static String getKeyRefInfo(String keyref, String contextSystemID)
- public static String getKeyRefAbsoluteReference(String keyref, String contextSystemID)
Added Classes in version 25:
Added Methods in version 25:
- public static final String IMPOSED_INSERTION_TYPE = "ImposedInsertionType"
- public static String buildFigureHrefImageXMLToInsert(AuthorAccess authorAccess, String figTitle, String refAttrValue)
- public static String buildFigureKeyrefImageXMLToInsert(AuthorAccess authorAccess, String figTitle, String keyName)
- public static boolean isReferenceToDITACompatibleResource(AuthorNode node, KeyInfo keyInfo)
- public static String getConverterFormatForDITACompatibleResource(String resourceExtension)
- public static String convertDitaCompatibleResource(Reader toConvert, String systemId, String format) throws ErrorListException
- public static URL proposeFolderUrlForChildTopicref(AuthorElement parent)
- public static DITAImposedReferenceType detectInsertionType(URL url)
- public CharSequence getContentCharSequence()
- private static final String ONLY_TEXT_CONTENT_STYLESHEET_FILE = "resources/onlyTextContent.xsl"
- String PROPERTY_IMAGE_URL = "imageUrl"
- String PROPERTY_IMAGE_MAP_SUPPORT_FACTORY = "imageMapSupportFactory"
- void runTransformationScenario(String scenarioName, Map<String, String> scenarioParameters, TransformationFeedback transformationFeedback) throws TransformationScenarioNotFoundException
- void stopCurrentTransformationScenario()
- ValidationUtilAccess getValidationUtilAccess()
- Iterator<URL> getMainFileResourcesIterator()
- public static JEditorPane createHTMLEditorPane(String text, boolean useStandardTextFont)
- public static JTextArea createTextArea(String contentType)
- public static void changeContentType(JTextArea textArea, String contentType)
- URL chooseURL(String title, String[] allowedExtensions, String filterDescr, String initialURL, String urlLabel, String okLabel)
Added Classes in version 24.1:
Added Methods in version 24.1:
- ProjectIndexer getProjectIndexer()
- public String[] getTokens()
Added Classes in version 24:
Added Methods in version 24:
- public static String getKeyForUrl(KeysManagerBase keyManager, URL url, URL editorLocation, AuthorNode contextNode)
- AuthorXPathExpressionBuilder getXPathExpressionBuilder(int offset) throws BadLocationException
- String getOriginalLocation()
- String getLocationOfLastPaste()
- public int getLength()
- public boolean contains(int offset)
- Iterator<Entry<String, String>> getPropertiesIterator()
- String getProperty(String key)
- Styles getStyles(AuthorNode node)
- AuthorResourceBundle getAuthorResourceBundle()
- public String[] getProjectLevelOptionKeys()
- public URL[] getCurrentSelectedURLs(boolean recurseReferences, boolean includeBinaryAndExternalResources)
- public ImageRenderingContext(Font font, int dotsPerInch, Rectangle imageInfo)
- public Dimension getImageDimensions()
- public boolean canHandleVectorialImages()
- AuthorDocumentProvider createAuthorDocumentProvider(URL systemId, Reader documentReader, boolean expandReferences) throws IOException
- void addPluginExtension(String extensionType, PluginExtension pluginExtension)
- public static Window detectParentFrame(Window parentFrame)
- public static JScrollPane createScrollPane(Component view, int vsbPolicy, int hsbPolicy)
Added Classes in version 23.1.1:
Added Classes in version 23.1:
Added Methods in version 23.1:
- public static String getAutoInsertTopicRefElementName(AuthorDocumentController authorDocumentController, int caretPosition)
- public void markDocumentAsSaved()
- void setPersistentHighlightProperties(AuthorPersistentHighlight highlight, LinkedHashMap<String, String> properties) throws IllegalArgumentException
- void removePersistentHighlightProperties(AuthorPersistentHighlight highlight, List<String> properties) throws IllegalArgumentException
- void addAuthorPersistentHighlightListener(AuthorPersistentHighlightsListener listener)
- void removeAuthorPersistentHighlightListener(AuthorPersistentHighlightsListener listener)
- void addPersistentHighlightsFilter(AuthorPersistentHighlightsFilter persistentHighlightsFilter)
- default void beforeCompoundEditCancelled()
- public void removeHighlights(Highlight[] highlights)
- public List<File> getWebResources()
- public void processAboutToStart(String processName, String fullCommand)
- public void processStarted(Process process)
- Object openDiffFilesApplication(String leftLabelText, URL leftURL, String rightLabelText, URL rightURL)
- Object openDiffFilesApplication(String leftLabelText, URL leftURL, String rightLabelText, URL rightURL, URL ancestorURL, boolean showAncestorURLPanel)
- ProcessController createProcess(ProcessListener processListener, String name, File workingDirectory, String cmdLine, boolean showConsole)
Added Classes in version 23:
Added Methods in version 23:
- public static void setKeyNameGenerator(DITAKeyNameGenerator ditaKeyNameGenerator)
- public static Object createReferencesGraph()
- public static List<DocumentPositionedInfo> searchReferences(URL targetTopicURL, Object referencesGraph)
- public static List<DitaReferenceTargetDescriptor> getDitaReferenceTargets(URL baseUrl, URL topicUrl) throws IOException
- public UnsavedContentReferenceManager getUnsavedContentReferenceManager()
- AuthorDocumentFragment createDocumentFragment(int startOffset, int endOffset, boolean preserveTrackChange) throws BadLocationException
- SchemaAwareHandlerResult insertXMLFragmentSchemaAware(String xmlFragment, String xpathLocation, String relativePosition, boolean insertEvenIfInvalid) throws AuthorOperationException
- public AuthorPersistentHighlight addPersistentMarker(AuthorDocumentFilterBypass filterBypass, PersistentHighlightType type, int startOffset, int endOffset, Map<String, String> properties)
- public AuthorPersistentHighlight addPersistentMarker(PersistentHighlightType type, int startOffset, int endOffset, Map<String, String> properties)
- default boolean hasEditableReference(String systemID, AuthorNode referenceNodeParent)
- default boolean allowsValidatationForEditableReference(String systemID, AuthorNode referenceNodeParent)
- default void replaceReference(AuthorDocumentProvider targetProvider, AuthorAccess authorAccess, AuthorReferenceNode referenceNode) throws IOException
- Map<QName, Collection<QName>> getElementToParentsMap(AuthorNode nodeContext)
- List<CIElement> getGlobalElements(AuthorNode nodeContext)
- public AuthorNode getNode()
- boolean inSpacePreserve()
- public default Object getGrammarCache()
- public default void setGrammarCache(Object grammarCache)
- public boolean matches(String systemID, String rootNamespace, String rootLocalName, String doctypePublicID, String doctypeSystemID, Attributes rootAttributes, Map<String, String> queryParameters, Reader contentReader)
- public AuthorPreloadProcessor createAuthorPreloadProcessor()
- public void highlightRangeReconfiguredUpdated(AuthorPersistentHighlight highlight, int oldStartOffset, int oldEndOffset)
- public void setSuggestedRelativeCaretOffset(int suggestedRelativeCaretOffset)
- public int getSuggestedRelativeCaretOffset()
- InputStream getContentInputStream() throws IOException
- public void editingSessionFailedToStart(String sessionId, String licenseeId, URL systemId, Map<String, Object> options)
- public abstract void addReply(Map<String, String> properties, AuthorPersistentHighlight parentHighlight)
- public abstract AuthorPersistentHighlight addPersistentMarker(PersistentHighlightType type, int startOffset, int endOffset, Map<String, String> properties)
- void showRangeRuler(boolean showRangeRuler)
- void showValidationStatusBar(boolean showValidationStatus)
- Map<PseudoElementDescriptor, Styles> getPseudoElementStyles(AuthorParentNode node)
- public UnsavedContentReferenceManager getUnsavedContentReferenceManager()
- public static JComboBox createComboBox(ComboBoxModel model)
- public static InputUrlComponentProvider createInputURLPanelProvider( String[] extensions, String filesDescription, String[] initialContent, boolean showEditorVariables, String persistenceKey, LocalFileBrowseType browseType)
Added Classes in version 22.1:
Added Methods in version 22.1:
- String SHOW_ALL_FILES_TOOLTIP = "merge.filter.show_all_files.tooltip"
- String SHOW_ONLY_FILES_MODIFIED_BY_OTHERS_TOOLTIP = "merge.filter.show_only_files_modified_by_others.tooltip"
- String SHOW_ONLY_FILES_MODIFIED_BY_YOU_AND_OTHERS_TOOLTIP = "merge.filter.show_only_files_modified_by_you_and_others.tooltip"
- String SHOW_ONLY_FILES_MODIFIED_BY_YOU_TOOLTIP = "merge.filter.show_only_files_modified_by_you.tooltip"
- String SHOW_ONLY_CONFLICTING_FILES_TOOLTIP = "merge.filter.show_only_conflicting_files.tooltip"
- public String customizeLinkTooltipDescription(URL currentEditorURL, AuthorNode contextNode, String linkHref, AuthorAccess authorAccess, String computedDescription)
- public boolean startExternalContentCompletion(IExternalContentCompletionContext context)
- void addExternalContentCompletionProvider(ExternalContentCompletionProvider ccProvider)
- void removeExternalContentCompletionProvider(ExternalContentCompletionProvider ccProvider)
- AuthorDocumentProvider createAuthorDocumentProvider(URL systemId, Reader documentReader) throws IOException
- public static JComponent createMultilineLabel(String text, boolean boldText)
Added Classes in version 22:
Added Methods in version 22:
- public static HrefInfo getHrefInformation(KeysManagerBase keyManager, AuthorNode node)
- public static List<RelLink> getRelatedLinksFromReltable(URL originatorURL)
- public boolean removeMarker(AuthorDocumentFilterBypass filterBypass, AuthorPersistentHighlight marker)
- public AuthorPersistentHighlight addCommentMarker(AuthorDocumentFilterBypass filterBypass, int startOffset, int endOffset, String comment, String parentID)
- public AuthorPersistentHighlight addCommentMarker(int startOffset, int endOffset, String comment, String parentID)
- public boolean removeMarker(AuthorPersistentHighlight marker)
- public void init(File frameworksAndPluginsFolder, URL optionsZipURL, URL appletCodeBase, String appletID, String servletURL, String userName, String password) throws AuthorComponentException
- public URL resolveCustomAttributeValue(CustomAttributeValueContext attributeValueEditingContext)
- public boolean shouldAddProfilingDirectlyOnElement(AuthorElement element)
- public static final String SCHEMATRON_IMPOSED_PHASE_ATTR_NAME = "schematron.imposed.phase"
- public List<String> getSchematronPhases(String systemId)
- public void setSchematronPhaseChooser(WebappSchematronPhaseChooser phaseChooser)
- public boolean isPerspectiveAllowed(String perspID)
- public void editorReloaded(URL editorURL)
- public void setPersistentObjectOption(String key, ExternalPersistentObject persistentObject)
- public ExternalPersistentObject getPersistentObjectOption(String key, ExternalPersistentObject defaultValue)
- default void clearCache()
- void loadProject(File project)
- public boolean isViewAvailable(String viewID)
- public static JToolTip installMultilineTooltip(JComponent component)
- AuthorDifferencePerformer createAuthorDiffPerformer() throws DiffException
- String expandEditorVariables(String pathWithEditorVariables, URL currentEditedURL, boolean expandAskEditorVariables)
- URL createNewEditor(URL saveTo, String extension, String contentType, String content)
Added Classes in version 21.1.1:
Added Methods in version 21.1.1:
- public abstract boolean addCommentOnSelection(int startOffset, int endOffset, String comment)
- void handleDragAndDrop(int start, int end, int target) throws InvalidEditException, BadLocationException
Added Classes in version 21.1:
Added Methods in version 21.1:
- public WebappExtensionsProvider getWebappExtensionsProvier()
- void addListener(AuthorHighlighterListener listener)
- public AuthorPersistentHighlight clone(Content content) throws CloneNotSupportedException
- public boolean handleCreateTable(AuthorTableArguments arguments) throws AuthorOperationException
- public static final int NORMAL_SORT_PRIORITY = 0
- public static final int SPLIT_ITEM_PRIORITY = 10000
- public int getSortPriority()
- public static final String SAVE_AUTO = "save_auto"
- public boolean isPassKeyTargetReferencesThroughXMLCatalogMappings()
- public Object getOldValueObject()
- public Object getNewValueObject()
- void addProjectChangeListener(ProjectChangeListener projectChangeListener)
- void removeProjectChangeListener(ProjectChangeListener projectChangeListener)
- URL getCurrentProjectURL()
Added Classes in version 21:
Added Methods in version 21:
- public static void insertContentKeyReference( final AuthorAccess authorAccess, String initialKeyName) throws AuthorOperationException
- public static String computeLinkText(AuthorNode contextNode, String keyRefValue, String hrefValue, final String baseSystemID, KeysManagerBase keysManager) throws Exception
- public static void insertLinkReference(// NOSONAR String referenceValue, String targetElementClass, String targetElementQName, final AuthorAccess authorAccess, final String typeValue, final String formatValue, final String scopeValue, final boolean isXref, boolean useKeyRef, final String hrefType) throws AuthorOperationException
- public static String getKeyForUrl(KeysManagerBase keyManager, URL url, URL editorLocation)
- public static String getKeyRefValueForUrl(KeysManagerBase keysManager, URL referenceUrl, URL editorLocation)
- public static boolean isReferenceToDITAResource(AuthorNode node, KeyInfo keyInfo)
- public static boolean isKeyDefToDITAResource(KeyInfo keyInfo)
- void setPseudoClassUndoable(String pseudoClass, AuthorElement element)
- void removePseudoClassUndoable(String pseudoClass, AuthorElement element)
- AuthorNode getStrictCommonAncestor(AuthorNode[] nodes)
- public boolean shouldHandleAttribute(EditedAttribute attribute, CustomAttributeValueEditingContext editContext)
- public TooltipIconInfo getTooltipButtonInfo(EditedAttribute attribute)
- public OptionListener()
- public void setKey(String key)
- public SpellCheckingProblemInfoWithSuggestions(int startOffset, int endOffset, String lang, String word, List<String> suggestions)
- void commitEditedValueForProcessingInstruction(AuthorParentNode elem, String toEdit, String valueToCommit)
- public List<SpellCheckingProblemInfoWithSuggestions> check(List<TextChunkDescriptor> text)
- public Dictionary getTermsDictionary()
- public void setTermsDictionary(Dictionary apiDict)
- public void setDefaultLanguage(String lang)
- public void setSpellcheckingEngine(String lang, SpellcheckingEngine checker)
- public String customizeRenderedTopicrefTitle(AuthorNode topicref, String defaultRenderedTitle)
- public KeyDefinitionInfo getKeyDefinitionForTarget(URL originatorURL, URL targetURL)
- public KeyDefinitionInfo getKeyDefinitionForKeyName(URL originatorURL, String keyName)
- void insertXMLFragment(String xmlFragment, int caretOffset) throws TextOperationException
- public Anchor createAnchor(int offset) throws BadLocationException
- public int getOffsetForAnchor(Anchor anchor) throws BadLocationException
- String serializePersistentObject(Object persistentObject) throws IOException
- Object deserializePersistentObject(String persistentObjectStringRepresentation) throws IOException
- public WSOptionListener()
- public void setKey(String key)
Added Classes in version 20.1:
Added Methods in version 20.1:
- ExtensionsBundle getExtensionsBundle()
- public void setParentFrame(Frame parentFrame)
- void changeActiveCssGroups(Set<String> titles) throws IOException
- List<String> getActiveCssGroupsTitles()
- public WebappDocumentValidator getDocumentValidator()
- public abstract List<CSSGroup> getAvailableCssGroups()
- public boolean isChangeTrackingAware()
Added Classes in version 20:
Added Methods in version 20:
- public boolean isPreferPercentageColumnWidths(String tableCellsTagName)
- public void acceptSelection(int startOffset, int endOffset)
- public void rejectSelection(int startOffset, int endOffset)
- SessionStore getSessionStore()
- public abstract String getID()
- void addRendererCustomizer(ProjectRendererCustomizer rendererCustomizer)
- void removeRendererCustomizer(ProjectRendererCustomizer rendererCustomizer)
- void showStatusMessage(String statusMessage, OperationStatus status)
Added Classes in version 19.1:
Added Methods in version 19.1:
- void markSelection(List<int[]> newSelection, int newCaretOffset, SelectionInterpretationMode newSelectionType, List<int[]> oldSelection, int oldCaretOffset, SelectionInterpretationMode oldSelectionType)
- public void handleRemoveInvalidColNamesFromTableCells(AuthorAccess authorAccess, AuthorElement tableElement, List<AuthorElement> cells) throws AuthorOperationException
- public boolean handleAttributeChange(AuthorAccess authorAccess, AuthorElement currentElement, String attributeName, AttrValue newValue)
- Map<String, String> getMonitoringStats()
- void setDITAKeyDefinitionManagerProvider(KeyDefinitionManagerProvider keyDefinitionManagerProvider)
- public AuthorHighlighter getSearchHighlightsProvider(String searchFor, WebappFindOptions options)
- public void replaceAll(String textToFind, String textToReplaceWith, WebappFindOptions options)
- public static final String OXYGEN_READ_ONLY_REASON_CODE_HEADER = "oxygen_read_only_reason_code"
- public URL buildURLForReferencedContent(int caretOffset, boolean shortAnchor)
- public void setReadOnly(ReadOnlyReason reason)
- public boolean editorAboutToBeClosedVeto(URL editorLocation)
- public void customizeEditorTabPopUpMenu(JPopupMenu popUpMenu, WSEditor editor)
- ProxyDetailsProvider getProxyDetailsProvider()
- ProjectController getProjectManager()
- DifferencePerformer createDiffPerformer() throws DiffException
- ImageHolder optimizeImage(URL imageUrl) throws IOException
- void showErrorMessage(String message, Throwable exception)
- void openInExternalApplication(String url, boolean preferAssociatedApplication, String mediaType)
Added Classes in version 19:
Added Methods in version 19:
- public static URL attachKeyScopeInformation( URL targetURL, Stack<Set<String>> context, // NOSONAR java:S1149 API String contextMapURL)
- boolean isRequiredElement(AuthorElement element)
- public AbstractAction getDefaultAction(AuthorAccess authorAccess, AuthorPersistentHighlight highlight, List<AbstractAction> actionsList)
- public TextPageExternalObjectInsertionHandler createTextPageExternalObjectInsertionHandler()
- public abstract void executeSplit(AuthorSelectionAndCaretModel selectionModel)
- abstract void executeAction(CCItemProxy ccItem, AuthorSelectionAndCaretModel selectionModel) throws BadLocationException, ItemNotFoundException
- public TransformerFactory getXSLTTransformerFactory(ConfigurationProperties properties)
- ApplicationType getApplicationType()
- String getApplicationName()
- String getLicenseRegistrationName()
Added Methods in version 18.1.1:
- public abstract File getBaseFrameworkFolder()
Added Classes in version 18.1:
Added Methods in version 18.1:
- public static HrefInfo getHrefInformation(AuthorNode node)
- public static void exportDITAMap(URL ditamapURL, final File exportDirectory, final boolean exportAsZip, final String zipFileName, ExportProgressUpdater progressUpdater)
- public boolean shouldFilterAttribute(CIElement parentElement, String attributeQName, int source)
- public String getHelpPageID(String currentEditorPage)
- public void customizeHoverActions(AuthorAccess authorAccess, AuthorPersistentHighlight authorPersistentHighlight, List actions)
- public void setAttribute(String attributeName, String attributeValue)
- public Map<String, String> getAttributes()
- void addNodeRendererCustomizer(DITAMapNodeRendererCustomizer customizer)
- void removeNodeRendererCustomizer(DITAMapNodeRendererCustomizer customizer)
- public void importGlobalOptions(File optionsFile, boolean preserveExistingOptionKeys) throws IOException
- void addBatchOperationsListener(BatchOperationsListener listener)
- void removeBatchOperationsListener(BatchOperationsListener listener)
- public void customizeAuthorOutlinePopUpMenu(JPopupMenu popUp, AuthorAccess authorAccess)
- public void customizeAuthorBreadcrumbPopUpMenu(JPopupMenu popUp, AuthorAccess authorAccess, AuthorNode currentNode)
- Object openDiffFilesApplication(URL leftURL, URL rightURL, URL ancestorURL)
- public List<MergedFileState> openMergeApplication(File baseDir, File personalModifiedFilesDir, File externalModifiedFilesDir, Map<String, String> mergeOptions) throws MergeFilesException
- public EditorComponentProvider createEditorComponentProvider(String[] allowedPages, String initialPage) throws AuthorComponentException
- PluginResourceBundle getResourceBundle()
- public List<EditorVariableDescription> getCustomResolverEditorVariableDescriptions()
- void openInExternalApplication(URL url, boolean preferAssociatedApplication, String mediaType)
- void startProcess(String name, File workingDirectory, String cmdLine, boolean showConsole)
Added Classes in version 18:
Added Methods in version 18:
- public static void insertLinkReference(// NOSONAR final AuthorAccess authorAccess, final String typeValue, final String formatValue, final String scopeValue, final boolean isXref, final String hrefType, URL initialReferenceURL, boolean displayReferenceUrl, final InsertLinkReferenceShortcut insertLinkReferenceShortcut) throws AuthorOperationException
- public static void insertLinkReference(// NOSONAR final AuthorAccess authorAccess, final String typeValue, final String formatValue, final String scopeValue, final boolean isXref, final String preferredElName, final String hrefType, URL initialReferenceURL, boolean displayReferenceUrl, final InsertLinkReferenceShortcut insertLinkReferenceShortcut) throws AuthorOperationException
- public static void insertLinkReference(// NOSONAR String referenceValue, String targetElementClass, String targetElementQName, final AuthorAccess authorAccess, final String typeValue, final String formatValue, final String scopeValue, final boolean isXref, final String hrefType) throws AuthorOperationException
- public static List<DitaReferenceTargetDescriptor> getDitaReferenceTargets(AuthorAccess authorAccess, URL targetURL) throws IOException
- public static String chooseLocalLink(AuthorAccess authorAccess, boolean isXref, boolean isDocbook5)
- public static String chooseURLForLink(AuthorAccess authorAccess, String title)
- public int getXPathLocationOffset(String xpathLocation, String relativePosition, boolean processChangeMarkers) throws AuthorOperationException
- boolean split(AuthorNode toSplit, int splitOffset)
- String getFilteredText(int offset, int length) throws BadLocationException
- public void insertURLs(AuthorAccess authorAccess, List<URL> urls, List<ReferenceType> types, int source) throws AuthorOperationException
- public WrapInAncestorsOptions getAncestorDetectionOptions()
- public boolean canBeReplaced(AuthorNode nodeToReplace)
- Map<QName, Collection<QName>> getElementToParentsMap(NamespaceContext namespaceContext)
- void addSelectionIntervals(List<ContentInterval> intervals, boolean scrollToVisible)
- public AuthorTableColumnWidthProviderBase(TableLayoutErrorsListener errorsListener)
- public void setErrorsListener(TableLayoutErrorsListener errorsListener)
- public String getHeaderInformation()
- public AuthorActionEventHandler getAuthorActionEventHandler()
- public AuthorImageDecorator getAuthorImageDecorator()
- public ZLayer getZLayer()
- public boolean handleDeleteRows(AuthorTableDeleteRowsArguments arguments) throws AuthorOperationException
- public abstract void toggleMarkAsDone(AuthorPersistentHighlight highlight)
- public abstract void addReply(String replyComment, AuthorPersistentHighlight parentHighlight)
- public static final String OXYGEN_READ_ONLY_REASON_HEADER = "oxygen_read_only_reason"
- DITAMapReviewController getReviewController()
- public void setReadOnly(String reason)
- public WSEditor getParentEditor()
- boolean checkValid(boolean automatic)
- void setEditable(boolean editable)
- boolean isEditable()
- public boolean editorsAboutToBeClosed(URL[] editorLocations)
- public void documentTypeExtensionsReconfigured()
- public Map<String, Object> getGlobalActions()
- public void registerAction(String actionID, Object action, String defaultKeyStroke)
- public void unregisterAction(String actionID)
- Object openDiffFilesApplication(URL leftURL, URL rightURL)
- ActionsProvider getActionsProvider()
- void addMenusAndToolbarsContributorCustomizer(MenusAndToolbarsContributorCustomizer customizer)
- void removeMenusAndToolbarsContributorCustomizer(MenusAndToolbarsContributorCustomizer customizer)
- URL convertFileToURL(File file) throws MalformedURLException
- ImageUtilities getImageUtilities()
- TemplateManager getTemplateManager()
Added Classes in version 17.1:
Added Methods in version 17.1:
- public static void editProperties (// NOSONAR URL location, AuthorCCManager ccM, AuthorDocumentControllerImpl ctrl, AuthorElement[] elementsToEdit, TopicRefInserter topicRefInserter, Object parentFrame, boolean displayReferenceUrl)
- public static void pushElement(final AuthorAccess authorAccess) throws AuthorOperationException
- AuthorClipboardObject getAuthorObjectFromClipboard()
- AuthorNode[] findNodesByXPath(String xpathExpression, AuthorNode contextNode, boolean ignoreTexts, boolean ignoreCData, boolean ignoreComments, boolean processChangeMarkers, XPathVersion xpathVersion, boolean transparentReferences) throws AuthorOperationException
- public AuthorReviewViewController getAuthorReviewViewController()
- void setSelectionIntervals(List<ContentInterval> intervals, boolean scrollToVisible)
- public AuthorCalloutRenderingInformation getDefaultAuthorCalloutRenderingInformation(AuthorPersistentHighlight highlight)
- public boolean handlesAlsoDefaultHighlights()
- public EditPropertiesHandler createEditPropertiesHandler()
- public Object getAdditionalData(String key)
- public void setAdditionalData(String key, Object additionalData)
- public void setTitle(String title)
- public void addDNDListener(Object dndListener)
- public void removeDNDListener(Object dndListener)
- public void setTagsDisplayMode(int displayMode)
- public int getTagsDisplayMode()
- void refreshReferences()
- void showPreferencesPages(String[] pagesToShowKeys, String pageToSelectKey, boolean showChildrenOfPages)
- MergeResult threeWayAutoMerge(String ancestor, String left, String right, MergeConflictResolutionMethods conflictResolutionMethod)
- BufferedImage createImage(String imageUrl) throws IOException
- String unescapeAttributeValue(String attributeValue)
- String prettyPrint(Reader reader, String systemID) throws PrettyPrintException
Added Classes in version 17:
Added Methods in version 17:
- void setMultipleDistinctAttributes(int parentElementStartOffset, int[] elementOffsets, List<Map<String, AttrValue>> attributes)
- public SchemaAwareHandlerResult insertXMLFragmentSchemaAware(String xmlFragment, int offset, int actionID, boolean replaceSelection) throws AuthorOperationException
- String getXPathExpression(int offset, boolean processChanges) throws BadLocationException
- void disableLayoutUpdate()
- void enableLayoutUpdate(AuthorNode ancestorOfChanges)
- public void addCalloutActionsProvider(CalloutActionsProvider actionsProvider)
- public void removeCalloutActionsProvider(CalloutActionsProvider actionsProvider)
- AuthorPersistentHighlight[] getAttributeChangeHighlights()
- String PROPERTY_HTML_CONTENT_BASE_URL = "oxy_htmlcontent_base_url"
- public boolean validateToolbarComposite(String toolbarCompositeTag)
- Platform getPlatform()
- int moveOutOfInvisibleBounds(int offset, boolean forward) throws BadLocationException
- public AuthorFoldManager getAuthorFoldManager()
- void addDropHandler(DITAMapTreeDropHandler dropHandler)
- void removeDropHandler(DITAMapTreeDropHandler dropHandler)
- void addAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
- void removeAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
- Reader createReader(URL url, String defaultEncoding) throws IOException
Added Classes in version 16.1:
Added Methods in version 16.1:
- String getXPathExpression(int offset) throws BadLocationException
- public DynamicPropertyEvaluator getPropertyEvaluator()
- void refresh(AuthorInplaceContext context)
- boolean insertContent(String content)
- public JToolBar createBasicAuthorToolbar()
- TextDocumentController getDocumentController()
- DocumentTypeInformation getDocumentTypeInformation()
- public boolean editorPageAboutToBeChangedVeto(String newPageID)
- boolean isHighContrastTheme()
- boolean isHighContrastWhiteTheme()
- ColorTheme getColorTheme()
- ImageInverter getImageInverter()
- void addCustomEditorVariablesResolver(EditorVariablesResolver resolver)
- void removeCustomEditorVariablesResolver(EditorVariablesResolver resolver)
- String chooseURLPath(String title, String[] allowedExtensions, String filterDescr, String initialURL)
Added Classes in version 16:
Added Methods in version 16:
- void setMultipleAttributes(int parentElementStartOffset, int[] elementOffsets, Map<String, AttrValue> attributes)
- public PluginWorkspace getPluginWorkspace()
- public void setName(String newName) throws IllegalArgumentException
- String getVersionBuildID()
- public void invokeAuthorExtensionActionInContext(Object action, int offset)
- int[] getBalancedSelection(int selectionStart, int selectionEnd)
- AuthorNode getFullySelectedNode(int selectionStart, int selectionEnd)
- public void setMathFlowFixedLicenseFile(File licenseFile)
- public void setMathFlowInstallationFolder(File installationFolder)
- public void importGlobalOptions(File optionsFile)
- WSEditorChangeListener[] getEditorChangeListeners(int editingArea)
Added Classes in version 15.2:
Added Methods in version 15.2:
- EditingSessionContext getEditingContext()
- AuthorDocumentFilter getDocumentFilter()
- UniqueAttributesProcessor getUniqueAttributesProcessor()
- void refreshNodeReferences(AuthorNode node)
- void setRenderingInfoChangedListener(RenderingInfoChangedListener listener)
- void setPseudoClass(String pseudoClass, AuthorElement element)
- void removePseudoClass(String pseudoClass, AuthorElement element)
- public boolean changeElementsToMoveUpDown(List<AuthorNode> selectedElements)
- public JToolBar createCSSAlternativesToolbar()
- DITAMapActionsProvider getActionsProvider()
- InputStream createContentInputStream() throws IOException
- public void saveGlobalOptions() throws IOException
- String getCurrentEditedAttributeValue()
- NodeContext getElementContext()
- boolean open(URL url, String imposedPage, String imposedContentType)
- File[] chooseFiles(File currentFileContext, String title, String[] allowedExtensions, String filterDescr)
Added Classes in version 15.1:
Added Methods in version 15.1:
- public Map<AuthorElement, LinkedHashMap<String, AuthorPersistentHighlight>> getAttributesChangeHighlights()
- public void setAttributesChanges( Map<AuthorElement, LinkedHashMap<String, AuthorPersistentHighlight>> attributesChanges)
Added Classes in version 15:
Added Methods in version 15:
- Object[] evaluateXPath(String xpathExpression, AuthorNode contextNode, boolean ignoreTexts, boolean ignoreCData, boolean ignoreComments, boolean processChangeMarkers, XPathVersion xpathVersion) throws AuthorOperationException
- AuthorNode[] findNodesByXPath(String xpathExpression, AuthorNode contextNode, boolean ignoreTexts, boolean ignoreCData, boolean ignoreComments, boolean processChangeMarkers, XPathVersion xpathVersion) throws AuthorOperationException
- public void setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
- public WorkspaceUtilities getWorkspaceUtilities()
- public void handleOpenURLAsDITAMapTree(URL toOpen) throws IOException
- public CustomAttributeValueEditor createCustomAttributeValueEditor(boolean forEclipsePlugin)
- public URL resolveCustomHref(URL currentEditorURL, AuthorNode contextNode, String linkHref, AuthorAccess authorAccess) throws CustomResolverException, IOException
- public void addActionPerformedListener(Object action, ActionPerformedListener listener)
- public void removeActionPerformedListener(Object action, ActionPerformedListener listener)
- public void setGlobalObjectProperty(String key, Object value)
- AttributeEditingContextDescription getAttributeEditingContextDescription()
- public void hideView(String viewID)
- public boolean isViewShowing(String viewID)
- public void hideToolbar(String toolbarID)
- public boolean isToolbarShowing(String toolbarID)
Added Classes in version 14.2:
Added Methods in version 14.2:
- public static void insertContentReference( final AuthorAccess authorAccess, URL initialReferenceURL, boolean displayReferenceUrl) throws AuthorOperationException
- public String getUnparsedEntityUri(AuthorNode contextNode, String entityName)
- public Rectangle getCalloutRectangle(AuthorPersistentHighlight persistentHighlight)
- public EditorComponentProvider createEditorComponentProvider(String[] allowedPages, String initialPage) throws AuthorComponentException
- public XMLUtilAccess getXMLUtilAccess()
- public UtilAccess getUtilAccess()
- public List<ToolbarComponentsCustomizer> getPluginToolbarCustomizers()
- public List<ViewComponentCustomizer> getPluginViewCustomizers()
- public List<MenuBarCustomizer> getPluginMenubarCustomizers()
- public LinkTextResolver createLinkTextResolver()
- public void customizePopUpMenu(Object popUp, AuthorAccess authorAccess, AuthorNode clickedNode)
- TextActionsProvider getActionsProvider()
- Point getLocationRelativeToEditorFromScreen(int x, int y)
- URL chooseURL(String title, String[] allowedExtensions, String filterDescr, String initialURL)
Added Classes in version 14.1:
Added Methods in version 14.1:
- public AuthorPersistentHighlight[] getCommentHighlights(int startOffset, int endOffset)
- AuthorPersistentHighlight[] getChangeHighlights(int startOffset, int endOffset)
- public void accept(int startOffset, int endOffset)
- public void accept(AuthorPersistentHighlight highlight)
- public void reject(int startOffset, int endOffset)
- public void reject(AuthorPersistentHighlight highlight)
- public void showLocation(URL url) throws AuthorComponentException
- public boolean canAddHighlight(int startOffset, int endOffset)
- public AuthorPersistentHighlight[] getHighlights(int startOffset, int endOffset)
- AuthorAccess getAuthorAccess()
- void addPopUpMenuCustomizer(AuthorPopupMenuCustomizer popUpCustomizer)
- void removePopUpMenuCustomizer(AuthorPopupMenuCustomizer popUpCustomizer)
- void goToNextEditablePosition(int startOffset, int endOffset) throws BadLocationException
- void editAttribute(AuthorElement targetElement, String attributeName)
- public void scrollToRectangle(Rectangle rectangle)
- void addPopUpMenuCustomizer(TextPopupMenuCustomizer popUpCustomizer)
- void removePopUpMenuCustomizer(TextPopupMenuCustomizer popUpCustomizer)
- public int[] getStartEndOffsets(final DocumentPositionedInfo dpInfo) throws BadLocationException
Added Classes in version 14:
Added Methods in version 14:
- public List executeXPath(String expression, String[] prefixNamespaceMappings, boolean useFullDocumentContent)
- AuthorDocumentFragment[] createNewDocumentFragmentsInContext(String[] xmlFragments, int[] contentOffsets) throws AuthorOperationException
- public boolean insertMultipleFragments(AuthorElement parentElement, AuthorDocumentFragment[] fragments, int[] offsets)
- public AuthorDocumentFragment unwrapDocumentFragment(AuthorDocumentFragment fragmentToUnwrap) throws BadLocationException
- public boolean insertMultipleFragments(AuthorDocumentFilterBypass filterBypass, AuthorElement parentElement, AuthorDocumentFragment[] fragments, int[] offsets)
- boolean insertMultipleFragments(AuthorElement parentElement, AuthorDocumentFragment[] fragments, int[] offsets)
- public AuthorCalloutsController getAuthorCalloutsController()
- public void setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider provider)
- public DITAMapTreeComponentProvider createDITAMapTreeComponentProvider() throws AuthorComponentException
- public void addDITAMapTreeTargetInformationProvider(String protocol, TopicRefTargetInfoProvider targetInformationProvider)
- public AuthorTableOperationsHandler getAuthorTableOperationsHandler()
- public void setHighlightsActionsProvider(AuthorPersistentHighlightActionsProvider provider)
- void drawImage(Object img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2)
- AuthorSelectionModel getAuthorSelectionModel()
- int getLineOfOffset(int offset) throws BadLocationException
- int getColumnOfOffset(int offset) throws BadLocationException
- int getOffsetOfLineStart(int lineNumber) throws BadLocationException
- public int getOffsetOfLineEnd(int lineNumber) throws BadLocationException
- public void setMathFlowFixedLicenseKeyForEditor(String fixedKey)
- public void setMathFlowFixedLicenseKeyForComposer(String fixedKey)
- void setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
- File chooseFile(File currentFileContext, String title, String[] allowedExtensions, String filterDescr, boolean usedForSave)
- String chooseURLPath(String title, String[] allowedExtensions, String filterDescr)
Added Classes in version 13.2:
Added Methods in version 13.2:
- URL[] getAllEditorLocations()
- WSEditor getEditorAccess(URL location)
- boolean handleTypingFallback(int offset, char ch, AuthorAccess authorAccess) throws InvalidEditException
- public ProfilingConditionalTextProvider getProfilingConditionalTextProvider()
- public XMLNodeRendererCustomizer createXMLNodeCustomizer()
- public void setTextForegroundColor(Color foregroundColor)
- String getAttributeNamespace(String attributePrefix)
- AuthorElementBaseInterface getParentElement()
- public String getXMLFragmentForContentProfiling(int startOffset, int endOffset, AuthorAccess authorAccess)
- public String getActionID(Object actionOrUIObject)
- void reloadContent(Reader reader, boolean discardUndoableEdits)
Added Methods in version 13.1:
- AuthorNode getFullySelectedNode()
- void addAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
- void removeAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
- ResourceFilter[] getResourceFilters()
- public Menu(String menuName, boolean forMenuBar)
- int showConfirmDialog(String title, String message, String[] buttonNames, int[] buttonIds, int initialSelectedIndex)
Added Classes in version 13:
Added Methods in version 13:
- int[] getTableRowSpanIndices(AuthorElement cellElement)
- TextContentIterator getTextContentIterator(int startOffset, int endOffset)
- Position createPositionInContent(int offset) throws BadLocationException
- void addClipboardFragmentProcessor(ClipboardFragmentProcessor clipboardFragmentProcessor)
- void removeClipboardFragmentProcessor(ClipboardFragmentProcessor clipboardFragmentProcessor)
- void addUniqueAttributesProcessor(UniqueAttributesProcessor uniqueAttributesProcessor)
- void removeUniqueAttributesProcessor(UniqueAttributesProcessor uniqueAttributesProcessor)
- AuthorNode[] findNodesByXPath(String xpathExpression, AuthorNode contextNode, boolean ignoreTexts, boolean ignoreCData, boolean ignoreComments, boolean processChangeMarkers) throws AuthorOperationException
- Object[] evaluateXPath(String xpathExpression, AuthorNode contextNode, boolean ignoreTexts, boolean ignoreCData, boolean ignoreComments, boolean processChangeMarkers) throws AuthorOperationException
- public void setModified(boolean modified)
- void setFragment(AuthorDocumentFragment newFragment)
- void addAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
- void removeAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
- void addEditorListener(WSEditorListener editorListener)
- void removeEditorListener(WSEditorListener editorListener)
- void changePage(String pageID)
- void addValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)
- void removeValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)
- void addPriorityEntityResolver(EntityResolver entityResolver)
- void removePriorityEntityResolver(EntityResolver entityResolver)
- void addPriorityURIResolver(URIResolver uriResolver)
- void removePriorityURIResolver(URIResolver uriResolver)
Added Classes in version 12.2:
Added Methods in version 12.2:
- public OffsetInformation getContentInformationAtOffset(int offset) throws BadLocationException
- boolean processContentRange(int startOffset, int endOffset, RangeProcessor rangeProcessor) throws BadLocationException, AuthorOperationException
- public void setOpenURLHandler(final OpenURLHandler openURLHandler)
- public ClipboardFragmentProcessor getClipboardFragmentProcessor()
- Object getAuthorComponent()
- Styles getStyles(AuthorNode node)
- void beginCompoundUndoableEdit()
- void endCompoundUndoableEdit()
- public void setEditable(boolean editable)
- public boolean editorAboutToBeOpenedVeto(URL editorLocation)
- public void editorActivated(URL editorLocation)
- public void editorDeactivated(URL editorLocation)
- public boolean editorAboutToBeClosed(URL editorLocation)
- public void editorRelocated(URL previousEditorLocation, URL newEditorLocation)
- public void addRelativeReferencesResolver(String protocol, RelativeReferenceResolver resolver)
- public void addTopicRefTargetInfoProvider(String protocol, TopicRefTargetInfoProvider targetInfoProvider)
- public String getOxygenActionID(Action action)
- Transformer createXSLTTransformer( Source styleSource, URL[] extensionJars, int transformerType, boolean useOxygenOptions) throws TransformerConfigurationException
- Transformer createSaxon9HEXSLTTransformerWithExtensions( Source styleSource, ExtensionFunctionDefinition[] saxonExtensions) throws TransformerConfigurationException
- Transformer createXQueryTransformer( Source xquerySource, URL[] extensionJars, int transformerType, boolean useOxygenOptions) throws TransformerConfigurationException
Added Classes in version 12.1:
Added Methods in version 12.1:
- ClassPathResourcesAccess getClassPathResourcesAccess()
- void surroundInFragment(AuthorDocumentFragment xmlFragment, int startOffset, int endOffset) throws AuthorOperationException
- public AuthorFilteredContent getFilteredContent(int start, int end, AuthorNodesFilter nodesFilter)
- void renameElement(AuthorElement contextNode, String newName)
- public void surroundInFragment(AuthorDocumentFilterBypass filterBypass, AuthorDocumentFragment xmlFragment, int startOffset, int endOffset) throws AuthorOperationException
- void surroundInFragment(AuthorDocumentFragment xmlFragment, int startOffset, int endOffset) throws AuthorOperationException
- public void insertXHTMLFragment(AuthorAccess authorAccess, Reader xhtmlContentReader) throws AuthorOperationException
- protected StreamSource createImporterStylesheetSource(AuthorAccess authorAccess)
- protected String getImporterStylesheetFileName(AuthorAccess authorAccess)
- boolean handleDeleteNodes(AuthorNode[] nodes, int deleteType, AuthorAccess authorAccess) throws InvalidEditException
- AuthorDocumentFragment handleCreateDocumentFragment(int startOffset, int endOffset, int creationPurposeID, AuthorAccess authorAccess) throws BadLocationException
- public void init(URL[] frameworksZIPURLs, URL optionsZipURL, URL appletCodeBase, String appletID, String servletURL, String userName, String password) throws AuthorComponentException
- public void setIgnoreNodeFromDisplay(boolean ignoreNodeFromDisplay)
- StandalonePluginWorkspace getPluginWorkspace()
- StandalonePluginWorkspace getPluginWorkspace()
- StandalonePluginWorkspace getPluginWorkspace()
- public void invokeAction(Object action)
- LicenseInformationProvider getLicenseInformationProvider()
- String getPreferencesDirectory()
- String getUserInterfaceLanguage()
- public Map<String, Object> getAuthorExtensionActions()
- AuthorSchemaAwareEditingHandler getDefaultAuthorSchemaAwareEditingHandler()
- AuthorActionsProvider getActionsProvider()
- WSTextXMLSchemaManager getXMLSchemaManager()
- void setEditorTabText(String tabText)
- void setEditorTabTooltipText(String tabTooltip)
- public void editorAboutToBeOpened(URL editorLocation)
- public void addInputURLChooserCustomizer(InputURLChooserCustomizer inputURLChooserCustomizer)
- URL removeUserCredentials(URL url)
- String expandEditorVariables(String pathWithEditorVariables, URL currentEditedURL)
- String encrypt(String toEncrypt)
- String decrypt(String toDecrypt)
- EntityResolver getEntityResolver()
- URIResolver getURIResolver()
- URL createNewEditor(String extension, String contentType, String content)
- void setParentFrameTitle(String parentFrameTitle)
Added Classes in version 12:
Added Methods in version 12:
- public AuthorPersistentHighlight[] getCommentHighlights()
- AuthorPersistentHighlight[] getChangeHighlights()
- public AuthorExternalObjectInsertionHandler createExternalObjectInsertionHandler()
- public String getDocumentTypeName()
- public List<AuthorPersistentHighlight> getChangeHighlights()
- public List<AuthorPersistentHighlight> getCommentsAndCustomHighlights()
- public void setCommentAndCustomHighlights(List<AuthorPersistentHighlight> highlights)
- public void setChangeHighlights(List<AuthorPersistentHighlight> markers)
- AuthorReviewController getReviewController()
- AuthorPersistentHighlighter getPersistentHighlighter()
- int getBalancedSelectionStart()
- int getBalancedSelectionEnd()
- void addPageChangedListener(WSEditorPageChangedListener pageChangedListener)
- void removePageChangedListener(WSEditorPageChangedListener pageChangedListener)
- public void showView(String viewID, boolean requestFocus)
- public void showToolbar(String toolbarID)
- void openInExternalApplication(URL url, boolean preferAssociatedApplication)
Added Classes in version 11.2:
Added Methods in version 11.2:
- AuthorDocumentFragment createAuthorDocumentFragment(CIElement element) throws BadLocationException
- List<CIElement> getGlobalElements()
- public abstract List<CIElement> getGlobalElements()