org.osivia.portal.api.theming
Interface IRenderedRegions

public interface IRenderedRegions

Rendered regions interface.

Author:

Cédric Krommenhoek

Field Summary

static java.lang.String	CUSTOMIZER_ATTRIBUTE_ADMINISTATOR Regions theming customizer administrator indicator attribute.
static java.lang.String	CUSTOMIZER_ATTRIBUTE_CONTEXT_PATH Regions theming customizer context path attribute.
static java.lang.String	CUSTOMIZER_ATTRIBUTE_RENDERED_REGIONS Regions theming customizer context path attribute.
static java.lang.String	CUSTOMIZER_ID Regions theming customizer identifier.

Method Summary

boolean	customizeRenderedRegion(java.lang.String regionName, java.lang.String regionPath) Customize rendered region.
boolean	decoratePortletsRegion(java.lang.String regionName, java.lang.String headerPath, java.lang.String footerPath) Decorate portlets region with header and/or footer.
void	defineDefaultRenderedRegion(java.lang.String regionName, java.lang.String regionPath) Define default rendered region.
void	defineFixedRenderedRegion(java.lang.String regionName, java.lang.String regionPath) Define fixed rendered region.
boolean	isSpaceSite() Check if current site is a space site.
boolean	removeRenderedRegion(java.lang.String regionName) Remove rendered region.

Field Detail

CUSTOMIZER_ID

static final java.lang.String CUSTOMIZER_ID

Regions theming customizer identifier.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_CONTEXT_PATH

static final java.lang.String CUSTOMIZER_ATTRIBUTE_CONTEXT_PATH

Regions theming customizer context path attribute.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_ADMINISTATOR

static final java.lang.String CUSTOMIZER_ATTRIBUTE_ADMINISTATOR

Regions theming customizer administrator indicator attribute.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_RENDERED_REGIONS

static final java.lang.String CUSTOMIZER_ATTRIBUTE_RENDERED_REGIONS

Regions theming customizer context path attribute.

See Also:

Constant Field Values

Method Detail

isSpaceSite

boolean isSpaceSite()

Check if current site is a space site.

Returns:

true if current site is a space site

customizeRenderedRegion

boolean customizeRenderedRegion(java.lang.String regionName,
                                java.lang.String regionPath)

Customize rendered region.

Parameters:

regionName - region name

regionPath - region path

Returns:

true if the region was successfully customized

removeRenderedRegion

boolean removeRenderedRegion(java.lang.String regionName)

Remove rendered region.

Parameters:

regionName - region name

Returns:

true if the region was successfully removed

decoratePortletsRegion

boolean decoratePortletsRegion(java.lang.String regionName,
                               java.lang.String headerPath,
                               java.lang.String footerPath)

Decorate portlets region with header and/or footer.

Parameters:

regionName - portlets region name

headerPath - header path, may be null

footerPath - footer path, may be null

Returns:

true if the region was successfully decorated

defineDefaultRenderedRegion

void defineDefaultRenderedRegion(java.lang.String regionName,
                                 java.lang.String regionPath)

Define default rendered region. Don't use this method for customizers !

Parameters:

regionName - region name

regionPath - region path

defineFixedRenderedRegion

void defineFixedRenderedRegion(java.lang.String regionName,
                               java.lang.String regionPath)

Define fixed rendered region. Don't use this method for customizers !

Parameters:

regionName - region name

regionPath - region path