nl.gx.webmanager.cms.layout
Interface Region

All Superinterfaces:

Wrapper

public interface Region
extends Wrapper

A Region is the content of a GridPart. A Grid consists of multiple GridParts. Each of these contains a Region which may either contain PageParts or another Grid.

See Also:

Grid, GridPart

Method Summary

java.lang.String	getAlign() Return horizontal alignment.
Color	getBackgroundColor() Return background color.
BackgroundImage	getBackgroundImage() Return background image.
java.lang.String	getClassName() Return table css class name.
Grid	getGrid()
java.lang.String	getHtmlAttributes() Return table tag attributes.
Layout	getLayout() Return layout to which this frame belongs.
int	getMarginHeight() Return marginheight.
int	getMarginWidth() Return margin width.
PagePart[]	getPageParts() Return pageparts in the Region.
RegionContainer	getParent() Return frameset that contains this Region.
RegionContainer	getRegionContainer() Returns the region container for the region when a region is divided in more than one regions.
java.lang.String	getScrolling() Return value for Region scrolling: yes|no|auto.
java.lang.String	getSize() Return size.
java.lang.String	getVerticalAlign() Return vertical align.
boolean	isForceSizeRegion() Return true if size should be enforced explicitly.
boolean	isInlineFrame() Return true if the Region is an iframe.
boolean	isNewTableRegion() Return true if the Region contains a Grid.
boolean	isReSizable()
boolean	isShowWhenEmpty()

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

getBackgroundColor

Color getBackgroundColor()

Return background color.

Returns:

background color.

getBackgroundImage

BackgroundImage getBackgroundImage()

Return background image.

Returns:

background image.

getHtmlAttributes

java.lang.String getHtmlAttributes()

Return table tag attributes.

Returns:

table tag attributes.

getGrid

Grid getGrid()

Returns:

the contained Grid.

getAlign

java.lang.String getAlign()

Return horizontal alignment.

Returns:

horizontal alignment.

getVerticalAlign

java.lang.String getVerticalAlign()

Return vertical align.

Returns:

vertical align.

getPageParts

PagePart[] getPageParts()

Return pageparts in the Region.

Returns:

pageparts in the Region.

isNewTableRegion

boolean isNewTableRegion()

Return true if the Region contains a Grid.

Returns:

true if the Region contains a Grid.

isForceSizeRegion

boolean isForceSizeRegion()

Return true if size should be enforced explicitly.

Returns:

true if size should be enforced explicitly.

isInlineFrame

boolean isInlineFrame()

Return true if the Region is an iframe.

Returns:

true if the Region is an iframe.

getClassName

java.lang.String getClassName()

Return table css class name.

Returns:

table css class name.

getSize

java.lang.String getSize()

Return size. The size may be horizontal or vertical depending on whether it is next to or below a Region in its containing Region.

Returns:

size.

getRegionContainer

RegionContainer getRegionContainer()

Returns the region container for the region when a region is divided in more than one regions.

Returns:

the regioncontainer.

getParent

RegionContainer getParent()

Return frameset that contains this Region.

Returns:

frameset that contains this Region

getMarginWidth

int getMarginWidth()

Return margin width.

Returns:

margin width

getMarginHeight

int getMarginHeight()

Return marginheight.

Returns:

marginheight

getScrolling

java.lang.String getScrolling()

Return value for Region scrolling: yes|no|auto.

Returns:

value for Region scrolling.

isReSizable

boolean isReSizable()

Returns:

true if region is resizable.

getLayout

Layout getLayout()

Return layout to which this frame belongs.

Returns:

layout to which this frame belongs

isShowWhenEmpty

boolean isShowWhenEmpty()