com.sap.portal.pb.services

Interface IPageService

public interface IPageService

The interface that provides methods for modifying the portal page.

The interface enables you to set the URL of dynamic iViews, show and hide iViews, and to restart all iViews and pages in the current application.

Field Summary

static String

KEY The service key

Method Summary

String[]	getVisibleIViews() Returns a String array containing the IDs of all visible iViews in the page.
void	hideDynamicIView() Hides the dynamic iView.
void	hideDynamicIView(String dynamicComponentId) Hides the specified dynamic iView.
void	hideIView(String iViewId) Hides the iView with the specified ID.
boolean	isVisibleOnPage(String iViewID) Indicates whether the iView with the specified ID is visible in the page.
void	printIView(String iViewId) Open a print window of the iView with the specified ID
void	restartApplication() Restarts all iViews and pages in the current application.
void	setDynamicIView(String iViewId) Sets the iView URL in the dynamic iView.
void	setDynamicIView(String dynamicComponentId, String iViewId) Sets the iView URL in a specified dynamic iView.
void	showDynamicIView() Shows the dynamic iView.
void	showDynamicIView(String dynamicComponentId) Shows the specified dynamic iView.
void	showIView(String iViewId) Shows the iView with the specified ID

Field Detail

KEY

static final String KEY

The service key

See Also:

Constant Field Values

Method Detail

getVisibleIViews

String[] getVisibleIViews()

Returns a String array containing the IDs of all visible iViews in the page.

Returns:

String array of all visible iViews in the page

isVisibleOnPage

boolean isVisibleOnPage(String iViewID)

Indicates whether the iView with the specified ID is visible in the page.

Parameters:

iViewID - the iView ID

Returns:

boolean indicates whether the iView is visible on the page

setDynamicIView

void setDynamicIView(String iViewId)

Sets the iView URL in the dynamic iView. Use this method if you have only one dynamic iview in the page.

Parameters:

iViewId - the PCD location of the iView to display

setDynamicIView

void setDynamicIView(String dynamicComponentId,
                     String iViewId)

Sets the iView URL in a specified dynamic iView. Use this method when you have more than one dynamic iViews in the page.

The ID of the dynamic iView is defined in the property "ID of Dynamic iView" of the dynamic iView in the portal.

Parameters:

dynamicComponentId - the ID of the dynamic iView to set

iViewId - the PCD location of the iView

hideIView

void hideIView(String iViewId)

Hides the iView with the specified ID.

Parameters:

iViewId - the ID of the iView to hide

showIView

void showIView(String iViewId)

Shows the iView with the specified ID

Parameters:

iViewId - the ID of the iView to show

hideDynamicIView

void hideDynamicIView(String dynamicComponentId)

Hides the specified dynamic iView. Use this method when you have more than one dynamic iView in the page.

Parameters:

dynamicComponentId - the ID of the dynamic iView to hide

showDynamicIView

void showDynamicIView(String dynamicComponentId)

Shows the specified dynamic iView. Use this method when you have more than one dynamic iviews in the page.

Parameters:

dynamicComponentId - the ID of the dynamic iView to show

hideDynamicIView

void hideDynamicIView()

Hides the dynamic iView. Use this method if you have only one dynamic iView in the page.

showDynamicIView

void showDynamicIView()

Shows the dynamic iView. Use this method if you have only one dynamic iView in the page.

restartApplication

void restartApplication()

Restarts all iViews and pages in the current application. This is needed, for example, to provide the "Refresh" functionalty of an iView.

printIView

void printIView(String iViewId)

Open a print window of the iView with the specified ID

Parameters:

iViewId - the ID of the iView to show

Access Rights

This class can be accessed from:

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