ShellPresentationContext Class

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

public class ShellPresentationContext

    extends PresentationContext

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

Related Topics

ShellPresentationContext.getShellPresentationContext(HttpServletRequest)


Hierarchy
Object
  ControlContext
    PresentationContext
      ShellPresentationContext
All Implemented Interfaces

Serializable

Field Summary

protected static final String
CLASS_NAME
String
   
Fields from  com.bea.netuix.servlets.controls.ControlContext
debug
 

Constructor Summary

 

Method Summary

public BodyPresentationContext
getBodyPresentationContext()
Returns the BodyPresentationContext contained by this shell.
public BookPresentationContext
getBookPresentationContext()
Returns the BookPresentationContext for the Portal's primary book, contained by this shell.
public HeadPresentationContext
getHeadPresentationContext()
Returns the HeadPresentationContext contained by this shell.
public static ShellPresentationContext
getShellPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only ShellPresentationContext.
 
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
   

Field Detail

CLASS_NAME

protected static final String CLASS_NAME

 

Constructor Detail

 

Method Detail

getBodyPresentationContext() Method

public BodyPresentationContext getBodyPresentationContext()
Returns the BodyPresentationContext contained by this shell. There should be exactly one body component per portal. The body component typically corresponds to an HTML <body/> tag, but this is not a requirement.

Returns

The portal's body; should not be null

getBookPresentationContext() Method

public BookPresentationContext getBookPresentationContext()
Returns the BookPresentationContext for the Portal's primary book, contained by this shell.

Returns

The primary book; should not be null, as all portals require at least one book

getHeadPresentationContext() Method

public HeadPresentationContext getHeadPresentationContext()
Returns the HeadPresentationContext contained by this shell. There should be exactly one head component per portal. The head component typically corresponds to an HTML <head/> tag, but this is not a requirement.

Returns

The portal's head; should not be null

getShellPresentationContext(HttpServletRequest) Method

public static ShellPresentationContext getShellPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only ShellPresentationContext. Note this method will only work if called from within a portal (typically, from the shell.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 ShellPresentationContext, if any