BodyPresentationContext Class

com.bea.netuix.servlets.controls.application
BodyPresentationContext Class

public class BodyPresentationContext

    extends PresentationContext

This class represents a portal body component. All presentation-related attributes of a body component are available from instances of this class. Such instances are typically used during portal rendering via look and feel skeleton files (e.g. body.jsp).

Related Topics

BodyPresentationContext.getBodyPresentationContext(HttpServletRequest)

Hierarchy
Object
  ControlContext
    PresentationContext
      BodyPresentationContext
All Implemented Interfaces

Serializable

Field Summary
   
Fields from  com.bea.netuix.servlets.controls.ControlContext
debug
 

Constructor Summary
 

Method Summary
public static BodyPresentationContext
getBodyPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only BodyPresentationContext.
public String
getOnloadScript()
Returns any configured onload script code that should appear in an HTML/XHTML body's onload attribute.
public String
getOnunloadScript()
Returns any configured 'onunload' script code that should appear in an HTML/XHTML body's 'onunload' attribute.
 
Methods from  com.bea.netuix.servlets.controls.PresentationContext
getChildren, getChildren, getFirstChild, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getResolvedLocale, getTagName, isVisible, setVisible
 
Methods from  com.bea.netuix.servlets.controls.ControlContext
getContextFromRequest, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail
 

Method Detail

getBodyPresentationContext(HttpServletRequest) Method

public static BodyPresentationContext getBodyPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only BodyPresentationContext. Note this method will only work if called from within a portal (typically, from the body.jsp skeleton). This method may return null if called when no appropriate context exists, but such a context should safely exist when being fetched from the associated skeleton JSP during normal portal rendering.

Parameters

request
The current HTTPServletRequest instance

Returns

A reference to the current BodyPresentationContext, if any

getOnloadScript() Method

public String getOnloadScript()
Returns any configured onload script code that should appear in an HTML/XHTML body's onload attribute. This information is the aggregation of code generated by components of the portal runtime and/or configured in the look and feel's skin.properties file.

Returns

A string containing the aggregated script code to be executed after the body element has loaded into the consuming client (typically an HTML/XHTML browser supporting JavaScript or another client-side scripting language)

getOnunloadScript() Method

public String getOnunloadScript()
Returns any configured 'onunload' script code that should appear in an HTML/XHTML body's 'onunload' attribute. This information is the aggregation of code generated by components of the portal runtime and/or configured in the look and feel's skin.properties file.

Returns

A string containing the aggregated script code to be executed after the body element has unloaded from the consuming client (typically an HTML/XHTML browser supporting JavaScript or another client-side scripting language)