com.sap.portal.admin.editor

Interface IEditorPane

Deprecated.

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

public interface IEditorPane

The interface that represents a single editor pane. The following is the editor pane lifecycle:

• Initialize Pane
• Process Input
• Handle Event (managed by the editor)
• Create User Interface

The editor pane implementation can use the logger and resource bundle objects that are passed in the init method, and can hold them as members for later use. The init method is also used for any initializing process that the pane requires. The initializing process occurs each time a pane is launched. The editor pane is responsible for creating the user interface, processing user input into the data model, and event handling.

Method Summary

Modifier and Type	Method and Description
void	createUI(IEditorContext editorContext, IWorkspace workspace) Deprecated. Creates the user interface for the pane.
EditorResource[]	getEditorResources() Deprecated. Gets the resources to be included in this pane.
void	init(IEditorContext editorContext, PPLogger logger, ResourceBundle texts) Deprecated. Initializes a pane.
void	processInput(IEditorContext editorContext, com.sapportals.htmlb.rendering.IPageContext htmlbPageContext) Deprecated. Updates the data model using input from the HTMLB controls from the page context.

Method Detail

createUI

void createUI(IEditorContext editorContext,
              IWorkspace workspace)

Deprecated.

Creates the user interface for the pane. The user interface must be added to the editor container, which can be obtained from the workspace.
The editor context is used to provide any existing data to include in the user interface.

Parameters:

editorContext - the current editor context

workspace - provides the container for the pane

getEditorResources

EditorResource[] getEditorResources()

Deprecated.

Gets the resources to be included in this pane. The supported resource types are defined in IResource. A resource must contain the relative path plus the name of the resource.
For example: scripts/pane1.js and the type of the resource.
For non-pane specific JavaScripts, a configuration property must be used in the portalapp.xml file instead of using this method.

Returns:

an array of resources or null if there are no specific resources for this pane

init

void init(IEditorContext editorContext,
          PPLogger logger,
          ResourceBundle texts)

Deprecated.

Initializes a pane.

Parameters:

editorContext - the current editor context

logger - a logger for sending log messages

texts - a resource bundle (contains also common editor texts)

processInput

void processInput(IEditorContext editorContext,
                  com.sapportals.htmlb.rendering.IPageContext htmlbPageContext)

Deprecated.

Updates the data model using input from the HTMLB controls from the page context. The data model in the editor context can be retrieved by the event handler.
Implement this method to save to the data model the data from any HTMLB controls that you created in a pane.

Parameters:

editorContext - the current context

htmlbPageContext - the current HTMLB context