Oxygen XML Editor 16.1 Author API

ro.sync.exml.workspace.api.editor.page.ditamap
Interface WSDITAMapEditorPage

All Superinterfaces:
WSEditorPage

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WSDITAMapEditorPage
extends WSEditorPage

DITA Maps Manager editor page.

Since:
12.2

Method Summary
 void addAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
          Adds a filter for displaying attributes to the current DITA Map Tree.
 DITAMapActionsProvider getActionsProvider()
          Provides access to actions already defined in the DITA Map page like: Undo, Redo, etc.
 java.lang.Object getDITAMapTreeComponent()
          Get the internal component on which the DITA Map page is rendered (a javax.swing.JTree).
 AuthorDocumentController getDocumentController()
          Returns the DITA Map document controller.
 OptionsStorage getOptionsStorage()
          The object that manages the options stored for DITA Map extensions.
 AuthorNode[] getSelectedNodes(boolean minimizeSelection)
          Get the selected nodes from DITA Map tree.
 boolean isEditable()
          Checks whether or not the DITA Map page is editable.
 void removeAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
          Remove a filter for displaying attributes to the current DITA Map Tree.
 void setEditable(boolean editable)
          Sets the specified flag to indicate whether or not the DITA Map page should be editable.
 void setPopUpMenuCustomizer(DITAMapPopupMenuCustomizer popUpCustomizer)
          Set the pop-up menu customizer which can be used to customize the pop-up menu (add/remove actions) before showing it in the DITA Mapa Manager page.
 

Method Detail

getDocumentController

AuthorDocumentController getDocumentController()
Returns the DITA Map document controller. It has methods for changing the document model. The insertions of XML content using the controller are not schema aware.

Returns:
The controller for DITA Map structure. Cannot be null.

getOptionsStorage

OptionsStorage getOptionsStorage()
The object that manages the options stored for DITA Map extensions. This is also responsible for adding and removing listeners that are notified about the option changes.

Returns:
The object that manages the options stored for DITA Map extensions.

setPopUpMenuCustomizer

void setPopUpMenuCustomizer(DITAMapPopupMenuCustomizer popUpCustomizer)
Set the pop-up menu customizer which can be used to customize the pop-up menu (add/remove actions) before showing it in the DITA Mapa Manager page.

Parameters:
popUpCustomizer - the pop-up menu customizer.

getDITAMapTreeComponent

java.lang.Object getDITAMapTreeComponent()
Get the internal component on which the DITA Map page is rendered (a javax.swing.JTree).

Returns:
for the stand alone version, a javax.swing.JTree, for the Oxygen plugin for Eclipse an instance of TreeViewer

addAuthorAttributesDisplayFilter

void addAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
Adds a filter for displaying attributes to the current DITA Map Tree. The filter will be applied when editing the attributes for a topic reference.

Parameters:
attributesDisplayFilter - The AuthorAttributesDisplayFilter to be added.
Since:
13.1

removeAuthorAttributesDisplayFilter

void removeAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
Remove a filter for displaying attributes to the current DITA Map Tree.

Parameters:
attributesDisplayFilter - The AuthorAttributesDisplayFilter to be removed.
Since:
13.1

setEditable

void setEditable(boolean editable)
Sets the specified flag to indicate whether or not the DITA Map page should be editable.

Parameters:
editable - true if the DITA Map page should be editable.
Since:
13.1

isEditable

boolean isEditable()
Checks whether or not the DITA Map page is editable.

Returns:
true if the DITA Map page is editable, false otherwise.
Since:
15

getSelectedNodes

AuthorNode[] getSelectedNodes(boolean minimizeSelection)
Get the selected nodes from DITA Map tree.

Parameters:
minimizeSelection - If true and a parent and a child is selected, then only the parent is the list.
Returns:
The selected nodes from DITA Map tree.

getActionsProvider

DITAMapActionsProvider getActionsProvider()
Provides access to actions already defined in the DITA Map page like: Undo, Redo, etc.

Returns:
access to actions already defined in the DITA Map page.
Since:
15.2

Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.