com.sap.portal.admin.editor

Interface IEditorContainer

public interface IEditorContainer

IContentPane a container that related with editor UI. Any Ui that will be added to this container, will be presented in the main editor site in the adminstudio environmnt

Method Summary

void	addComponent(String componentId, Component component) Add HTMLB component to this container
void	addComponent(String componentId, IWizardComponent component) Add wizrd component to this container
boolean	isPropertyEditorVisible() Indicates weather property editor is visible.
void	setEditorTitle(String title, String description, boolean showTitle) Set the title of this editor, this title will be presented in the header of the editor container, and in the alert messages for this editor.
void	setEditorTitleVisible(boolean visible) set whether the title will be presented in the editor header, else it will be presented only in the alert messages.
void	setPropertyEditorObjectId(String objectId) Set the object id that the property editor shoudl load, and show its properties.
void	setPropertyEditorVisible(boolean visible) Shows or hides the property editor.
void	setTabHeaderTitle(String title, String description) Set the caption(title) and tooltip that will be visible in the tab header for this editor

Method Detail

addComponent

public void addComponent(String componentId,
                         IWizardComponent component)

Add wizrd component to this container

Parameters:

componentId - the id for the added component

component - the wizrad component object

addComponent

public void addComponent(String componentId,
                         Component component)

Add HTMLB component to this container

Parameters:

componentId - the id for the added component

component - the HTMLB component object

setPropertyEditorVisible

public void setPropertyEditorVisible(boolean visible)

Shows or hides the property editor. Default is true. Note that when invisible means does not exist

Parameters:

visible - true to show property editor or false to hide it

setPropertyEditorObjectId

public void setPropertyEditorObjectId(String objectId)

Set the object id that the property editor shoudl load, and show its properties. The default object id is the id that was passes as parameter to the URL.

Parameters:

objectId - the id of the object that the property editor presents.

isPropertyEditorVisible

public boolean isPropertyEditorVisible()

Indicates weather property editor is visible.

Returns:

true if visible or false otherwise

setTabHeaderTitle

public void setTabHeaderTitle(String title,
                              String description)

Set the caption(title) and tooltip that will be visible in the tab header for this editor

Parameters:

title - short caption

description - tooltip

setEditorTitle

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

Set the title of this editor, this title will be presented in the header of the editor container, and in the alert messages for this editor. If there is multi pane bar selection, this title will not be presented. The default title is the pane name.

Parameters:

title - name for this editor

description - tooltip for this title

showTitle - if set to true, the title will be presented in the editor header, else it will be presented only in the alert messages.

setEditorTitleVisible

public void setEditorTitleVisible(boolean visible)

set whether the title will be presented in the editor header, else it will be presented only in the alert messages.

Parameters:

visible - if set to true, the title will be presented in the editor header, else it will be presented only in the alert messages.