com.sap.portal.admin.editor

Interface IEditorConfiguration

All Known Subinterfaces:

IEditor

Deprecated.

As of SAP NetWeaver 2007 release, replaced by package com.sap.portal.adminstudio.workunitfwapi

public interface IEditorConfiguration

The interface for configuring an editor, including adding panes. Each editor must contain at least one editor pane. The following can be configured:

• Setting a default pane to be displayed when the editor is launched.
• Setting a logger to send log/trace messages.
• Adding an editor pane to the editor.

Method Summary

Modifier and Type	Method and Description
void	addEditorPane(Class editorPaneClass, String activatingEvent) Deprecated. use addEditorPane(PaneMetaData paneMetaData)
void	addEditorPane(Class editorPaneClass, String activatingEvent, String paneTitle) Deprecated. use addEditorPane(PaneMetaData paneMetaData)
void	addEditorPane(Class editorPaneClass, String activatingEvent, String paneTitle, String description) Deprecated. use addEditorPane(PaneMetaData paneMetaData)
void	addEditorPane(PaneMetaData paneMetaData) Deprecated. Adds an editor pane to the editor.
void	setDefaultEditorPane(Class defaultEditorPaneClass) Deprecated. Sets the default editor pane.
void	setLogger(PPLogger logger) Deprecated. Sets a logger where the log/trace messages are sent.
void	setTitle(String newTitle) Deprecated. use the title of the pane

Method Detail

setDefaultEditorPane

void setDefaultEditorPane(Class defaultEditorPaneClass)

Deprecated.

Sets the default editor pane. The default pane is the pane displayed when the editor is launched. By default, the first pane that was added, is the default pane.

Parameters:

defaultEditorPaneClass - a default pane

setLogger

void setLogger(PPLogger logger)

Deprecated.

Sets a logger where the log/trace messages are sent. If no logger is set, the default logger is the editor framework logger.

Parameters:

logger - to send log messages

setTitle

void setTitle(String newTitle)

Deprecated. use the title of the pane

Sets a title for the editor.

Parameters:

newTitle - a title

addEditorPane

void addEditorPane(Class editorPaneClass,
                   String activatingEvent)

Deprecated. use addEditorPane(PaneMetaData paneMetaData)

Adds an editor pane to the editor. The request for a new pane is performed by an activating event.

Parameters:

editorPaneClass - a pane class name

activatingEvent - an event name that activates this pane

addEditorPane

void addEditorPane(Class editorPaneClass,
                   String activatingEvent,
                   String paneTitle)

Deprecated. use addEditorPane(PaneMetaData paneMetaData)

Adds an editor pane to the editor including a pane title. The request for a new pane is performed by an activating event.

Parameters:

editorPaneClass - a pane class name

activatingEvent - an event name that activates this pane

paneTitle - NLS string that is used for messages

addEditorPane

void addEditorPane(Class editorPaneClass,
                   String activatingEvent,
                   String paneTitle,
                   String description)

Deprecated. use addEditorPane(PaneMetaData paneMetaData)

/** Adds an editor pane to the editor including a pane title and tooltip. The request for a new pane is performed by an activating event.

Parameters:

editorPaneClass - a pane class name

activatingEvent - an event name that activates this pane

paneTitle - NLS string that is used for messages

description - a tooltip

addEditorPane

void addEditorPane(PaneMetaData paneMetaData)

Deprecated.

Adds an editor pane to the editor. The metadata of the pane is supplied using a PaneMetaData object.

Parameters:

paneMetaData - metadata for the pane