ro.sync.exml.workspace.api.editor.page.author

Interface WSAuthorComponentEditorPage

All Superinterfaces:

AuthorTooltipCustomizerProvider, WSAuthorEditorPage, WSAuthorEditorPageBase, WSEditorPage, WSTextBasedEditorPage

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WSAuthorComponentEditorPage
extends WSAuthorEditorPage

Provides enhanced access (with additional methods) to the author page from an Author Component editor.

Since:

14.2

Method Summary

Modifier and Type	Method and Description
javax.swing.JToolBar	createBasicAuthorToolbar() Create the toolbar which contains Refresh, Change Element Tags and Profiling Sets switch button.
javax.swing.JToolBar	createCSSAlternativesToolbar() Retrieve the toolbar containing the drop-down button for CSS alternative stylesheets.
java.util.List<javax.swing.JToolBar>	createExtensionActionsToolbars() Create toolbars with all the actions defined at the framework level in exactly the same order in which they have been added to the toolbars from the Document Type Edit dialog.
javax.swing.JToolBar	createReviewToolbar() Retrieve the toolbar for author review.
void	setBreadCrumbPopUpCustomizer(PopupMenuCustomizer popUpCustomizer) The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author bread crumb before showing it.
void	setOutlinerPopUpCustomizer(PopupMenuCustomizer popUpCustomizer) The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author Outliner view before showing it.
void	showBreadCrumb(boolean showBreadCrumb) Show or hide the Bread Crumb panel in Author component.
void	showRangeRuler(boolean showRangeRuler) Hide or show the vertical stripe located on the right side of the editing area which presents ranges for errors or various other highlights.
void	showValidationStatusBar(boolean showValidationStatus) Hide or show the validation status bar which appears at the bottom of the editing area when placing the caret inside an error highlight.

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

getAuthorAccess, getChangeTrackingController, getDocumentController, getOptionsStorage, getOutlineAccess, getReviewController, getTableAccess

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

addAuthorAttributesDisplayFilter, addAuthorCaretListener, addAuthorMouseListener, addDNDListener, addPopUpMenuCustomizer, buildURLForReferencedContent, deleteSelection, editAttribute, getActionsProvider, getAuthorComponent, getAuthorFoldManager, getAuthorSelectionModel, getBalancedSelection, getBalancedSelectionEnd, getBalancedSelectionStart, getDefaultAuthorSchemaAwareEditingHandler, getFullySelectedNode, getFullySelectedNode, getHighlighter, getPersistentHighlighter, getPseudoElementStyles, getSelectedText, getSelectionEnd, getSelectionStart, getStyles, getTagsDisplayMode, goToNextEditablePosition, hasSelection, isOffsetInInvisibleBounds, moveOutOfInvisibleBounds, refresh, refresh, removeAuthorAttributesDisplayFilter, removeAuthorCaretListener, removeAuthorMouseListener, removeDNDListener, removePopUpMenuCustomizer, scrollToRectangle, select, setPopUpMenuCustomizer, setTagsDisplayMode, viewToModel

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

createAnchor, getCaretOffset, getLocationOnScreenAsPoint, getLocationRelativeToEditorFromScreen, getOffsetForAnchor, getStartEndOffsets, getWordAtCaret, modelToViewRectangle, scrollCaretToVisible, selectWord, setCaretPosition, viewToModelOffset

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

getParentEditor, hasFocus, isEditable, requestFocus, setEditable, setReadOnly, setReadOnly

Methods inherited from interface ro.sync.exml.workspace.api.editor.page.author.tooltip.AuthorTooltipCustomizerProvider

addTooltipCustomizer, removeTooltipCustomizer

Method Detail

createExtensionActionsToolbars

java.util.List<javax.swing.JToolBar> createExtensionActionsToolbars()

Create toolbars with all the actions defined at the framework level in exactly the same order in which they have been added to the toolbars from the Document Type Edit dialog. The toolbars will look almost identical with the ones which appear when the XML is opened in an Oxygen standalone version.

Returns:

toolbars with all the actions defined at the framework level.

setBreadCrumbPopUpCustomizer

void setBreadCrumbPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)

The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author bread crumb before showing it. If everything is removed then the menu will not be shown.

Parameters:

popUpCustomizer - The pop Up Customizer.

showBreadCrumb

void showBreadCrumb(boolean showBreadCrumb)

Show or hide the Bread Crumb panel in Author component.

Parameters:

showBreadCrumb - true to show the Bread Crumb.

setOutlinerPopUpCustomizer

void setOutlinerPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)

The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author Outliner view before showing it. If everything is removed then the menu will not be shown.

Parameters:

popUpCustomizer - The pop Up Customizer.

createReviewToolbar

javax.swing.JToolBar createReviewToolbar()

Retrieve the toolbar for author review.

Returns:

The toolbar for author review.

createCSSAlternativesToolbar

javax.swing.JToolBar createCSSAlternativesToolbar()

Retrieve the toolbar containing the drop-down button for CSS alternative stylesheets.

Returns:

The toolbar containing the drop-down button for CSS alternative stylesheets.

Since:

15.2

createBasicAuthorToolbar

javax.swing.JToolBar createBasicAuthorToolbar()

Create the toolbar which contains Refresh, Change Element Tags and Profiling Sets switch button.

Returns:

The toolbar which contains Refresh, Change Element Tags and Profiling Sets switch button.

Since:

16.1

showRangeRuler

void showRangeRuler(boolean showRangeRuler)

Hide or show the vertical stripe located on the right side of the editing area which presents ranges for errors or various other highlights. By default the validation stripe is shown.

Parameters:

showRangeRuler - true to show the validation stripe, false to hide it.

Since:

23

*********************************
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.

********************************

showValidationStatusBar

void showValidationStatusBar(boolean showValidationStatus)

Hide or show the validation status bar which appears at the bottom of the editing area when placing the caret inside an error highlight. By default it is shown.

Parameters:

showValidationStatus - true to show the validation status bar. false to always hide it.

Since:

23

*********************************
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.