Oxygen XML Editor 12.2 Author API

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

All Superinterfaces:
WSEditorPage

public interface WSDITAMapEditorPage
extends WSEditorPage

DITA Maps Manager editor page.

Since:
12.2

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.


Method Summary
 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.
 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.

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.

Oxygen XML Editor 12.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.