PlaceholderPresentationContext Class

com.bea.netuix.servlets.controls.layout
PlaceholderPresentationContext Class

public class PlaceholderPresentationContext

    extends PresentationContext

Used to provide access to presentation-related attributes specific to the Placeholder in use. Typically used during portal rendering via look and feel skeleton files (specifically: JSPs used in layout components, e.g. gridlayout.jsp).

Related Topics

PlaceholderPresentationContext.getPlaceholderPresentationContext(HttpServletRequest)


Hierarchy
Object
  ControlContext
    PresentationContext
      PlaceholderPresentationContext
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 String
getFlow()
Returns the text of the flow attribute for this Placeholder portal component.
public static PlaceholderPresentationContext
getPlaceholderPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only PlaceholderPresentationContext for a given Placeholder portal component.
public String
getTitle()
Returns the text of the title attribute for this Placeholder portal component.
public String
getWidth()
Returns the value of the width attribute for this Placeholder portal component.
public boolean
isUsingFlow()
Returns the value of the isUsingFlow attribute for this Placeholder portal component.
 
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

getFlow() Method

public String getFlow()
Returns the text of the flow attribute for this Placeholder portal component. The flow attribute can be either FlowLayout.ORIENT_HORIZONTAL or FlowLayout.ORIENT_VERTICAL.

Returns

The text of the flow attribute as a String, if any

Related Topics

FlowLayout#ORIENT_HORIZONTAL
FlowLayout#ORIENT_VERTICAL


getPlaceholderPresentationContext(HttpServletRequest) Method

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

getTitle() Method

public String getTitle()
Returns the text of the title attribute for this Placeholder portal component.

Returns

The text of the title attribute as a String, if any

getWidth() Method

public String getWidth()
Returns the value of the width attribute for this Placeholder portal component. The width attribute can be used to set the width of a <td> HTML element within a layout JSP, for example.

Returns

The value of the width attribute, if any

isUsingFlow() Method

public boolean isUsingFlow()
Returns the value of the isUsingFlow attribute for this Placeholder portal component. If true, a FlowLayout will be used within this Placeholder to manage its contents.

Returns

The value of the isUsingFlow attribute; if unspecified, defaults to true