Interface EditorComponentProvider
- All Superinterfaces:
ComponentProvider
- All Known Implementing Classes:
AbstractComponentProvider
,AuthorComponentProvider
,GenericEditorComponentProvider
@API(type=NOT_EXTENDABLE,
src=PUBLIC)
public interface EditorComponentProvider
extends ComponentProvider
Provides access to a created editor + helper views and additional panels. The editor might have multiple editor pages.
- Since:
- 14.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Attributes Panelstatic final int
Elements Panelstatic final int
Entities Panelstatic final int
Model Panelstatic final int
Outliner Panelstatic final int
Reviews Panel -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds an author component listener.getAdditionalEditHelper
(int helperID) Get an additional edit helper panel.void
Removes an author component listener.void
showLocation
(URL url, Reader reader) Show the location referenced by a given URL in the editor.Methods inherited from interface ro.sync.ecss.extensions.api.component.ComponentProvider
getEditorComponent, getStatusComponent, getWSEditorAccess, load, print
-
Field Details
-
OUTLINER_PANEL_ID
static final int OUTLINER_PANEL_IDOutliner Panel- See Also:
-
ATTRIBUTES_PANEL_ID
static final int ATTRIBUTES_PANEL_IDAttributes Panel- See Also:
-
MODEL_PANEL_ID
static final int MODEL_PANEL_IDModel Panel- See Also:
-
ELEMENTS_PANEL_ID
static final int ELEMENTS_PANEL_IDElements Panel- See Also:
-
ENTITIES_PANEL_ID
static final int ENTITIES_PANEL_IDEntities Panel- See Also:
-
REVIEWS_PANEL_ID
static final int REVIEWS_PANEL_IDReviews Panel- See Also:
-
-
Method Details
-
showLocation
Show the location referenced by a given URL in the editor.
If the document pointed by this URL is different than the document currently loaded in the editor page, this URL will be used to set the content to edit, to solve relative references (eg: images) and to show the location pointed by the URL reference part.
If the document pointed by this URL is currently loaded in the editor page, only the reference part of the given URL will be used to show the corresponding location in the editor.- Parameters:
url
- The URL to show location for.reader
- The reader over the URL, can be null.- Throws:
AuthorComponentException
- When there was a load problem (eg: IOException).
-
addAuthorComponentListener
Adds an author component listener.- Parameters:
listener
- The listener.
-
removeAuthorComponentListener
Removes an author component listener.- Parameters:
listener
- The listener.
-
getAdditionalEditHelper
Get an additional edit helper panel. It can be the outline, attributes, entities, elements or model helper component, depending on the ID.- Parameters:
helperID
- One of:- ATTRIBUTES_PANEL_ID,
- ELEMENTS_PANEL_ID,
- ENTITIES_PANEL_ID,
- MODEL_PANEL_ID,
- OUTLINER_PANEL_ID constants.
- Returns:
- The additional component.
-