org.jboss.portal.theme.page
Class Region

java.lang.Object
  org.jboss.portal.theme.page.Region

All Implemented Interfaces:

MarkupContainer

public final class Region

extends java.lang.Object

implements MarkupContainer

A region on a page.

A region wraps one or more portlets to allow them to act as one unit inside the layout of a page.

Constructor Summary

Region(java.lang.String name)
Create a region with default orientation (how the portlet windows are arranged) and the region name as the css id selector

Region(java.lang.String name, java.lang.String cssId, RegionOrientation orientation)
Create a region with the provided properties.

Method Summary

java.lang.String	getCssId()
java.lang.String	getId()
RegionOrientation	getOrientation()
java.util.List	getWindows() Get a list of all window contexts in this region.
boolean	isEmpty()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Region

public Region(java.lang.String name)

Create a region with default orientation (how the portlet windows are arranged) and the region name as the css id selector

Parameters:

name - the name of the region to create

Region

public Region(java.lang.String name,
              java.lang.String cssId,
              RegionOrientation orientation)

Create a region with the provided properties.

Parameters:

name - the name of the region to create

cssId - the id attribute value that can be used by css selectors to identify this region

orientation - arrange portlet windows inside this region in this orientation

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface MarkupContainer

Returns:

the identifier of this region (i.e. the name of this region)

getCssId

public java.lang.String getCssId()

Returns:

the attribute value to use in the markup to allow a css selector to select this region

getOrientation

public RegionOrientation getOrientation()

Returns:

the orientation of this region

isEmpty

public boolean isEmpty()

Returns:

if there are any portlet windows in this region

getWindows

public java.util.List getWindows()

Get a list of all window contexts in this region. The list is sorted by order according to the order provided in the window definition.

Returns:

a sorted list of org.jboss.portal.theme.page.WindowContext items

toString

public java.lang.String toString()