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

Modifier and Type	Method and Description
void	addAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter) Adds a filter for displaying attributes to the current DITA Map Tree.
void	addDropHandler(DITAMapTreeDropHandler dropHandler) Add a drop handler to the DITA Map tree.
void	addNodeRendererCustomizer(DITAMapNodeRendererCustomizer customizer) Add a node renderer customizer.
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.
DITAMapReviewController	getReviewController() Retrieve a controller that can be used to toggle the change tracking state.
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	refreshReferences() Refresh all references in the opened DITA Map.
void	removeAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter) Remove a filter for displaying attributes to the current DITA Map Tree.
void	removeDropHandler(DITAMapTreeDropHandler dropHandler) Remove a drop handler from the DITA Map tree.
void	removeNodeRendererCustomizer(DITAMapNodeRendererCustomizer customizer) Remove a node renderer customizer.
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.

Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSEditorPage

getParentEditor, setReadOnly

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.

Specified by:

setEditable in interface WSEditorPage

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.

Specified by:

isEditable in interface WSEditorPage

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

addDropHandler

void addDropHandler(DITAMapTreeDropHandler dropHandler)

Add a drop handler to the DITA Map tree.

Parameters:

dropHandler - The newly added drop handler

Since:

17

removeDropHandler

void removeDropHandler(DITAMapTreeDropHandler dropHandler)

Remove a drop handler from the DITA Map tree.

Parameters:

dropHandler - The newly added drop handler

Since:

17

refreshReferences

void refreshReferences()

Refresh all references in the opened DITA Map. This is equivalent to pressing F5 in the map tree.

Since:

17.1

getReviewController

DITAMapReviewController getReviewController()

Retrieve a controller that can be used to toggle the change tracking state.

Returns:

The review controller. Cannot be null.

Since:

18

addNodeRendererCustomizer

void addNodeRendererCustomizer(DITAMapNodeRendererCustomizer customizer)

Add a node renderer customizer. The customizer can customize the icon and title which appears for each topicref in the DITA Maps Manager view.

Parameters:

customizer - The customizer can customize the icon and title which appears for each topicref in the DITA Maps Manager view.

Since:

18.1

removeNodeRendererCustomizer

void removeNodeRendererCustomizer(DITAMapNodeRendererCustomizer customizer)

Remove a node renderer customizer. The customizer can customize the icon and title which appears for each topicref in the DITA Maps Manager view.

Parameters:

customizer - The customizer can customize the icon and title which appears for each topicref in the DITA Maps Manager view.

Since:

18.1