org.osivia.portal.api.theming

Interface IRenderedRegions

public interface IRenderedRegions

Rendered regions interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOMIZER_ATTRIBUTE_ADMINISTATOR Regions theming customizer administrator indicator attribute.
static String	CUSTOMIZER_ATTRIBUTE_LAYOUT_CONTEXT_PATH Regions theming customizer layout context path attribute.
static String	CUSTOMIZER_ATTRIBUTE_RENDERED_REGIONS Regions theming customizer context path attribute.
static String	CUSTOMIZER_ATTRIBUTE_THEME_CONTEXT_PATH Regions theming customizer theme context path attribute.
static String	CUSTOMIZER_ID Regions theming customizer identifier.

Method Summary

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

Field Detail

CUSTOMIZER_ID

static final String CUSTOMIZER_ID

Regions theming customizer identifier.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_LAYOUT_CONTEXT_PATH

static final String CUSTOMIZER_ATTRIBUTE_LAYOUT_CONTEXT_PATH

Regions theming customizer layout context path attribute.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_THEME_CONTEXT_PATH

static final String CUSTOMIZER_ATTRIBUTE_THEME_CONTEXT_PATH

Regions theming customizer theme context path attribute.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_ADMINISTATOR

static final String CUSTOMIZER_ATTRIBUTE_ADMINISTATOR

Regions theming customizer administrator indicator attribute.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_RENDERED_REGIONS

static final 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(String regionName,
                                String regionPath)

Customize rendered region.

Parameters:

regionName - region name

regionPath - region path

Returns:

true if the region was successfully customized

customizeRenderedRegion

boolean customizeRenderedRegion(String regionName,
                                String regionPath,
                                String contextPath)

Customize rendered region.

Parameters:

regionName - region name

regionPath - region path

contextPath - region context path

Returns:

true if the region was successfully customized

removeRenderedRegion

boolean removeRenderedRegion(String regionName)

Remove rendered region.

Parameters:

regionName - region name

Returns:

true if the region was successfully removed

decoratePortletsRegion

boolean decoratePortletsRegion(String regionName,
                               String headerPath,
                               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

decoratePortletsRegion

boolean decoratePortletsRegion(String regionName,
                               String headerPath,
                               String footerPath,
                               String contextPath)

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

contextPath - decorator context path

Returns:

true if the region was successfully decorated

defineDefaultRenderedRegion

void defineDefaultRenderedRegion(String regionName,
                                 String regionPath)

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

Parameters:

regionName - region name

regionPath - region path

defineFixedRenderedRegion

void defineFixedRenderedRegion(String regionName,
                               String regionPath)

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

Parameters:

regionName - region name

regionPath - region path