BorderLayoutPresentationContext Class
- public class BorderLayoutPresentationContext
extends LayoutPresentationContext
Used to provide location-based access to the PlaceholderPresentationContext
objects contained in a
BorderLayout
portal component, as well as other presentation-related attributes specific to the
BorderLayout
in use. Typically used during portal rendering via look and feel skeleton files
(e.g. borderlayout.jsp).
Related Topics
BorderLayoutPresentationContext.getBorderLayoutPresentationContext(HttpServletRequest)
-
Hierarchy
-
Object
ControlContext
PresentationContext
LayoutPresentationContext
BorderLayoutPresentationContext
-
All Implemented Interfaces
-
Serializable
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, getContextKey, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest |
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CLASS_NAME
protected static final String
CLASS_NAME
center() Method
public PlaceholderPresentationContext
center()
Returns the "center" PlaceholderPresentationContext
contained within the BorderLayout
.
Returns
- The "center"
PlaceholderPresentationContext
, if any
columns() Method
public int columns()
Returns the number of columns that this BorderLayout
contains. A BorderLayout
will
have a minimum of 1 column, and a maximum of 3.
Returns
- The number of columns of this
BorderLayout
, between 1 and 3
east() Method
public PlaceholderPresentationContext
east()
Returns the "east" PlaceholderPresentationContext
contained within the BorderLayout
.
Returns
- The "east"
PlaceholderPresentationContext
, if any
getBorderLayoutPresentationContext(HttpServletRequest) Method
public static BorderLayoutPresentationContext
getBorderLayoutPresentationContext(HttpServletRequest
request)
This is a convenience method for returning a reference to the one and only BorderLayoutPresentationContext.
Note this method will only work if called from within a portal (typically, from the borderlayout.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 BorderLayoutPresentationContext, if any
getLayoutStrategy() Method
public String
getLayoutStrategy()
Returns the text of the layoutStrategy attribute that corresponds to this
BorderLayout
portal component. Will be either BorderLayout.LAYOUT_BY_ORDER
or BorderLayout.LAYOUT_BY_TITLE
. LAYOUT_BY_ORDER
will arrange the
Placeholder
s in order based on their position in the layout (e.g. the first Placeholder
listed will be "north", the next will be "west", etc.). LAYOUT_BY_TITLE
will arrange the
Placeholder
s based on their title. Placeholders with no title attribute or with a title attribute
whose value is not one of "north", "west", "center", "east", or "south" will be ignored and not rendered. In the
case of multiple placeholders with the same title, only one will be rendered - which one is not defined.
Returns
- The text of the layoutStrategy attribute as a String. If unspecified in the .layout file,
BorderLayout.LAYOUT_BY_ORDER
is returned.
Related Topics
BorderLayout#LAYOUT_BY_ORDER
BorderLayout#LAYOUT_BY_TITLE
north() Method
public PlaceholderPresentationContext
north()
Returns the "north" PlaceholderPresentationContext
contained within the BorderLayout
.
Returns
- The "north"
PlaceholderPresentationContext
, if any
south() Method
public PlaceholderPresentationContext
south()
Returns the "south" PlaceholderPresentationContext
contained within the BorderLayout
.
Returns
- The "south"
PlaceholderPresentationContext
, if any
west() Method
public PlaceholderPresentationContext
west()
Returns the "west" PlaceholderPresentationContext
contained within the BorderLayout
.
Returns
- The "west"
PlaceholderPresentationContext
, if any