Package ro.sync.ecss.extensions.api.webapp.access

Interface IWebappAuthorEditorAccess

All Superinterfaces:

AuthorEditorAccess, AuthorTooltipCustomizerProvider, ModifiedStatusProvider, ScenarioInvoker, TransformationScenarioInvoker, ValidationScenarioInvoker, WSAuthorEditorPageBase, WSEditorBase, WSEditorPage, WSTextBasedEditorPage

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface IWebappAuthorEditorAccess
extends AuthorEditorAccess

Extended AuthorEditorAccess interface for Web Author.

Since:

19.1

Method Summary

Modifier and Type	Method	Description
void	changeActiveCssGroups(java.util.Set<java.lang.String> titles)	Each framework (document type) can provide a list of CSS files that can be selected (activated) to change the rendering of the documents described by the framework rules.
java.util.List<java.lang.String>	getActiveCssGroupsTitles()	Each framework (document type) can provide a list of CSS files that can be selected (activated) to change the rendering of the documents described by the framework rules.
ReadOnlyReason	getReadOnlyReason()
boolean	isModified()	Call this method to determine the modified status of this object.

Methods inherited from interface ro.sync.ecss.extensions.api.access.AuthorEditorAccess

getEditingContext, getExtensionsBundle, getLocationOnScreen, getUnsavedContentReferenceManager, modelToView

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

addTooltipCustomizer, removeTooltipCustomizer

Methods inherited from interface ro.sync.exml.workspace.api.editor.transformation.TransformationScenarioInvoker

runTransformationScenario, runTransformationScenarios, stopCurrentTransformationScenario

Methods inherited from interface ro.sync.exml.workspace.api.editor.validation.ValidationScenarioInvoker

runValidationScenarios

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

close, createContentInputStream, createContentReader, getDocumentTypeInformation, getEditorLocation, getEncodingForSerialization, isNewDocument, reloadContent, reloadContent, save, saveAs, setEditorTabText, setEditorTabTooltipText, setModified

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

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

Method Detail

getReadOnlyReason

ReadOnlyReason getReadOnlyReason()

Returns:

The reason for which the editor is read-only.

isModified

boolean isModified()

Call this method to determine the modified status of this object. If the modified status was set to true during a "compound edit" AuthorDocumentController.beginCompoundEdit() this method should also be called inside the same "compound edit".

Specified by:

isModified in interface ModifiedStatusProvider

Returns:

true if this object contains modifications.

changeActiveCssGroups

void changeActiveCssGroups(java.util.Set<java.lang.String> titles)
                    throws java.io.IOException

Each framework (document type) can provide a list of CSS files that can be selected (activated) to change the rendering of the documents described by the framework rules. Each CSS file have a title associated with it. Call this method to change the active CSS files that will be used to render the document from the current editor. To find the list of all available CSS titles for a specific document type you can call DocumentTypeInfo.getAvailableCssGroups().

Parameters:

titles - The titles of the CSS files to use.

Throws:

java.io.IOException - If the CSS parsing fails.

Since:

20.1

getActiveCssGroupsTitles

java.util.List<java.lang.String> getActiveCssGroupsTitles()

Each framework (document type) can provide a list of CSS files that can be selected (activated) to change the rendering of the documents described by the framework rules. Each CSS file have a title associated with it. This method returns the list of titles for all (active) CSS files that are used to render the document from the current editor. To find the list of all available CSS titles for a specific document type you can call DocumentTypeInfo.getAvailableCssGroups().

Returns:

The list of titles of the active CSS groups.

Since:

20.1