atg.portal.framework

Interface Region

public interface Region

A context in which gears are rendered. The Region defines the dimensions and the layout of gears.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
Gear[]	getGears() Deprecated.
java.util.Set	getGearSet() Access all the gears of the region as a list of gear objects
RegionHeightEnum	getHeight() Access the hight of the region
java.lang.String	getId() Access the id of the region
java.lang.String	getName() Access the name of the region
RegionDefinition	getRegionDefinition() Access the region definition for this region
RegionWidthEnum	getWidth() Access the width of the region
boolean	isFixed() True if the region is fixed
void	setGears(java.util.Collection pGears) Set the given array of gears to this region

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Access the id of the region

Returns:

an id

getName

java.lang.String getName()

Access the name of the region

Returns:

a name

getWidth

RegionWidthEnum getWidth()

Access the width of the region

Returns:

a width

getHeight

RegionHeightEnum getHeight()

Access the hight of the region

Returns:

a height

isFixed

boolean isFixed()

True if the region is fixed

Returns:

true if the region is fixed, false otherwise

getGears

Gear[] getGears()

Deprecated.

Access all the gears of the region. This method is deprecated in favor of getGearList method

Returns:

an array of gears

getGearSet

java.util.Set getGearSet()

Access all the gears of the region as a list of gear objects

Returns:

an list of gears

getRegionDefinition

RegionDefinition getRegionDefinition()

Access the region definition for this region

Returns:

an array of gears

setGears

void setGears(java.util.Collection pGears)

Set the given array of gears to this region