Package org.sakaiproject.portal.api

Interface EditorRegistry

public interface EditorRegistry

Method Summary

Modifier and Type	Method	Description
Editor	getEditor(String id)	Retrieve an Editor by its ID.
List<Editor>	getEditors()	Retrieve a list of all registered Editors.
void	register(String id, String name, String editorUrl, String launchUrl, String preloadScript)	Registers an editor for portal use by supplying requisite values instead of an instance.
void	register(Editor editor)	Registers an instantiated Editor for portal use.
boolean	unregister(String id)	Unregister an Editor by its ID, making it unavailable.
boolean	unregister(Editor editor)	Unregister an Editor, making it unavailable.

Method Detail

register

void register(Editor editor)

Registers an instantiated Editor for portal use. Note that the ID is case-insensitive.

Parameters:

editor - the Editor

register

void register(String id,
              String name,
              String editorUrl,
              String launchUrl,
              String preloadScript)

Registers an editor for portal use by supplying requisite values instead of an instance. An Editor instance will be created and registered. The ID is case-insensitive. See Editor for details.

Parameters:

id - Editor ID

name - Editor Name

editorUrl - Editor URL

launchUrl - Launch URL

preloadScript - Preload Script

unregister

boolean unregister(Editor editor)

Unregister an Editor, making it unavailable. Note that the Editor is identified by its getId() method, not by object identity.

Parameters:

editor - The Editor to unregister.

Returns:

Whether the editor was unregistered successfully.

unregister

boolean unregister(String id)

Unregister an Editor by its ID, making it unavailable.

Parameters:

id - The ID of the Editor to unregister.

Returns:

Whether the editor was unregistered successfully.

getEditor

Editor getEditor(String id)

Retrieve an Editor by its ID.

Parameters:

id - The ID of the desired Editor.

Returns:

The identified Editor or null if one is not registered with the supplied ID.

getEditors

List<Editor> getEditors()

Retrieve a list of all registered Editors.

Returns:

All registered editors in a copied list; any modifications will not be reflected in the registered Editors.