com.sap.portal.admin.editor
Interface IEditorConfiguration

All Known Subinterfaces:

IEditor

public interface IEditorConfiguration

The editor configuration API. This API must be used in order to configure an editor.

Method Summary

void	addEditorPane(java.lang.Class editorPaneClass, java.lang.String activatingEvent) Deprecated. use ddEditorPane(PaneMetaData) instead.
void	addEditorPane(java.lang.Class editorPaneClass, java.lang.String activatingEvent, java.lang.String paneTitle) Deprecated. use ddEditorPane(PaneMetaData) instead.
void	addEditorPane(java.lang.Class editorPaneClass, java.lang.String activatingEvent, java.lang.String paneTitle, java.lang.String description) Deprecated. use ddEditorPane(PaneMetaData) instead.
void	addEditorPane(PaneMetaData paneMetaData) Add editor pane to this editor.
void	setDefaultEditorPane(java.lang.Class defaultEditorPaneClass) Set the editor pane that will be the default pane.
void	setLogger(com.sapportals.common.PPLogger logger) Set the logger that all the log/trace messages will be sent to.
void	setTitle(java.lang.String newTitle) Deprecated. use the titles of the panes.

Method Detail

setDefaultEditorPane

public void setDefaultEditorPane(java.lang.Class defaultEditorPaneClass)

Set the editor pane that will be the default pane. The default pane will be the first pane that will be presented in the portal, when the editor will be called. By default, the first pane that was added, will be consider as the default pane.

Parameters:

defaultEditorPaneClass -

setLogger

public void setLogger(com.sapportals.common.PPLogger logger)

Set the logger that all the log/trace messages will be sent to. The default logger,If no logger will be set, is the Editor Framework logger

Parameters:

logger - a logger object that will be set as the logger for this editor

setTitle

public void setTitle(java.lang.String newTitle)

Deprecated. use the titles of the panes.

Set the title for this editor

Parameters:

newTitle -

addEditorPane

public void addEditorPane(java.lang.Class editorPaneClass,
                          java.lang.String activatingEvent)

Deprecated. use ddEditorPane(PaneMetaData) instead.

Add editor pane to this editor. Each editor must contain at least one editor pane. The instance of the pane will be created only by demand. The demand of the pane will be performed by an activating event.

Parameters:

editorPaneClass - the name of the pane class.

activatingEvent - the name of the event that will activate this pane

addEditorPane

public void addEditorPane(java.lang.Class editorPaneClass,
                          java.lang.String activatingEvent,
                          java.lang.String paneTitle)

Deprecated. use ddEditorPane(PaneMetaData) instead.

Add editor pane to this editor. Each editor must contain at least one editor pane. The instance of the pane will be created only by demand. The demand of the pane will be performed by an activating event.

Parameters:

editorPaneClass - the name of the pane class.

activatingEvent - the name of the event that will activate this pane if this param is null- the activating event will be default by editor ramework.

paneTitle - NLS string that will be used for messages, and for default transitions UI.

addEditorPane

public void addEditorPane(java.lang.Class editorPaneClass,
                          java.lang.String activatingEvent,
                          java.lang.String paneTitle,
                          java.lang.String description)

Deprecated. use ddEditorPane(PaneMetaData) instead.

Add editor pane to this editor. Each editor must contain at least one editor pane. The instance of the pane will be created only by demand. The demand of the pane will be performed by an activating event.

Parameters:

editorPaneClass - the name of the pane class.

activatingEvent - the name of the event that will activate this pane if this param is null- the activating event will be default by editor ramework.

paneTitle - NLS string that will be used for messages, and for default transitions UI.

description - the description of this pane, will be presented as tooltip.

addEditorPane

public void addEditorPane(PaneMetaData paneMetaData)

Add editor pane to this editor. Each editor must contain at least one editor pane. The instance of the pane will be created only by demand. The meta data of this pane is given using the pane meta data helper class.

Parameters:

paneMetaData - the meta data for this pane