com.sap.portal.admin.editor

Interface IEditorContainer

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

public interface IEditorContainer

The interface that represents a container, which is the area in each pane where the custom user interface is displayed. The user interface elements that can be added to a container are HTMLB or wizard framework components.

Method Summary

void	addComponent(String componentId, com.sapportals.htmlb.Component component) Deprecated. Adds an HTMLB component to the container.
void	addComponent(String componentId, IWizardComponent component) Deprecated. Adds a wizard component to a container.
boolean	isPropertyEditorVisible() Deprecated. Indicates whether the property editor is visible (true) or hidden (false).
void	setEditorTitle(String title, String description, boolean showTitle) Deprecated. Sets a title for the editor.
void	setEditorTitleVisible(boolean visible) Deprecated. Sets whether to display a title in the editor header.
void	setPropertyEditorObjectId(String objectId) Deprecated. Sets an ID for the object displayed by the property editor.
void	setPropertyEditorVisible(boolean visible) Deprecated. Sets whether the property editor is visible (true) or hidden (false).
void	setTabHeaderTitle(String title, String description) Deprecated. Sets a title and tooltip to display in the tab header.

Method Detail

addComponent

void addComponent(String componentId,
                  IWizardComponent component)

Deprecated.

Adds a wizard component to a container.

Parameters:

componentId - an ID for the added component

component - a wizard component

addComponent

void addComponent(String componentId,
                  com.sapportals.htmlb.Component component)

Deprecated.

Adds an HTMLB component to the container.

Parameters:

componentId - an ID for the added component

component - an HTMLB component

setPropertyEditorVisible

void setPropertyEditorVisible(boolean visible)

Deprecated.

Sets whether the property editor is visible (true) or hidden (false). The default is true.

Parameters:

visible - true shows the property editor, false hides it

setPropertyEditorObjectId

void setPropertyEditorObjectId(String objectId)

Deprecated.

Sets an ID for the object displayed by the property editor. The default ID is the ID passed as a parameter to the URL of the object.

Parameters:

objectId - an object ID

isPropertyEditorVisible

boolean isPropertyEditorVisible()

Deprecated.

Indicates whether the property editor is visible (true) or hidden (false).

Returns:

true if the property editor is visible, false if hidden

setTabHeaderTitle

void setTabHeaderTitle(String title,
                       String description)

Deprecated.

Sets a title and tooltip to display in the tab header.

Parameters:

title - a title

description - a tooltip

setEditorTitle

void setEditorTitle(String title,
                    String description,
                    boolean showTitle)

Deprecated.

Sets a title for the editor. The title is displayed in the header of the editor container and in the editor alert messages. The default title is the pane name.
If a multi-pane bar selection is available, the title is not displayed.

Parameters:

title - a title

description - a tooltip

showTitle - true displays the title in the editor header, false displays the title in alert messages only

setEditorTitleVisible

void setEditorTitleVisible(boolean visible)

Deprecated.

Sets whether to display a title in the editor header.

Parameters:

visible - true displays the title in the editor header, false displays the title in alert messages only

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN