|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSDITAMapEditorPage
DITA Maps Manager editor page.
Method Summary | |
---|---|
void |
addAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
Adds a filter for displaying attributes to the current DITA Map Tree. |
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 |
---|
AuthorDocumentController getDocumentController()
null
.OptionsStorage getOptionsStorage()
void setPopUpMenuCustomizer(DITAMapPopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- the pop-up menu customizer.java.lang.Object getDITAMapTreeComponent()
void addAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
attributesDisplayFilter
- The AuthorAttributesDisplayFilter
to be added.void removeAuthorAttributesDisplayFilter(AuthorAttributesDisplayFilter attributesDisplayFilter)
attributesDisplayFilter
- The AuthorAttributesDisplayFilter
to be removed.void setEditable(boolean editable)
editable
- true
if the DITA Map page should be editable.boolean isEditable()
true
if the DITA Map page is editable, false
otherwise.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.
AuthorNode[] getSelectedNodes(boolean minimizeSelection)
minimizeSelection
- If true
and a parent and a child is selected, then only the parent is the list.
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.
|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |