ro.sync.ecss.extensions.api.component

Interface EditorComponentProvider

All Superinterfaces:

ComponentProvider

All Known Implementing Classes:

AuthorComponentProvider

@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

Method Summary

Modifier and Type	Method and Description
void	addAuthorComponentListener(AuthorComponentListener listener) Adds an author component listener.
javax.swing.JComponent	getAdditionalEditHelper(int helperID) Get an additional edit helper panel.
void	removeAuthorComponentListener(AuthorComponentListener listener) Removes an author component listener.
void	showLocation(java.net.URL url, java.io.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

Method Detail

showLocation

void showLocation(java.net.URL url,
                  java.io.Reader reader)
           throws AuthorComponentException

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

void addAuthorComponentListener(AuthorComponentListener listener)

Adds an author component listener.

Parameters:

listener - The listener.

removeAuthorComponentListener

void removeAuthorComponentListener(AuthorComponentListener listener)

Removes an author component listener.

Parameters:

listener - The listener.

getAdditionalEditHelper

javax.swing.JComponent getAdditionalEditHelper(int helperID)

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:

• AuthorComponentProvider.ATTRIBUTES_PANEL_ID,
• AuthorComponentProvider.ELEMENTS_PANEL_ID,
• AuthorComponentProvider.ENTITIES_PANEL_ID,
• AuthorComponentProvider.MODEL_PANEL_ID,
• AuthorComponentProvider.OUTLINER_PANEL_ID constants.

Returns:

The additional component.