com.ibm.portal.state.accessors.screentemplate
Interface ScreenTemplateAccessor

All Superinterfaces:

Accessor, Disposable

All Known Subinterfaces:

ScreenTemplateAccessorController

public interface ScreenTemplateAccessor
extends Accessor

This accessor allows to read the screen template of the requested portal page. A screen template is a name for a screen used to generate parts of a portal page during portal rendering.
WebSphere Portal provides a set of default screen templates including "Home" (default), "Login", and "Error". Custom screen templates can also be defined and added to the portal system.

Since:

5.1

Method Summary

java.lang.String

getScreenTemplate() Returns the screen template of the navigation node (aka portal page) which is currently selected.

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getScreenTemplate

java.lang.String getScreenTemplate()

Returns the screen template of the navigation node (aka portal page) which is currently selected. Returns null if no selection information is available.

Returns:

String representing the screen template of the currently selected portal page