com.sap.portal.admin.editor
Interface IEditorPane

public interface IEditorPane

UI Editor pane.

Method Summary

void	createUI(IEditorContext editorContext, IWorkspace workspace) Creates the UI of this pane.
EditorResource[]	getEditorResources() Get all the resources that must be included in this pane only. (js, css, etc) The resources should hold the relative path + the name of the resource.
void	init(IEditorContext editorContext, com.sapportals.common.PPLogger logger, java.util.ResourceBundle texts) Init the pane
void	processInput(IEditorContext editorContext, com.sapportals.htmlb.rendering.IPageContext htmlbPageContext) Get the input from the htmlb components from the page context And upate the data model that the editorContext hold.

Method Detail

createUI

public void createUI(IEditorContext editorContext,
                     IWorkspace workspace)

Creates the UI of this pane. Any data model considerations should be taken, using the editor context.

Parameters:

editorContext - The current context of this editor

workspace - The workspace environemt- The UI must be added to the workspace using the editor contianer, and the toolbar.

getEditorResources

public EditorResource[] getEditorResources()

Get all the resources that must be included in this pane only. (js, css, etc) The resources should hold the relative path + the name of the resource. For example: "scripts/pane1.js". and the type of the resource. If there are no specific resources for this pane, the return value can be empty or null.

For non pane specific java scripts, a configuration property must be use in the portalapp.xml file.

Returns:

Array of resources or null.

init

public void init(IEditorContext editorContext,
                 com.sapportals.common.PPLogger logger,
                 java.util.ResourceBundle texts)

Init the pane

Parameters:

editorContext - The edoitor current state.

logger - The logger where log messages should be sent to.

texts - The chained ResourceBundle (contains also common editors texts)

processInput

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

Get the input from the htmlb components from the page context And upate the data model that the editorContext hold. The data model in the editor context can be retrieved later by the event handler.

Parameters:

editorContext - the current context (hold the data model)

htmlbPageContext - the current htmlb context