org.springframework.extensions.surf.types
Interface Theme

All Superinterfaces:

ModelObject, Serializable

All Known Implementing Classes:

ThemeImpl

public interface Theme
extends ModelObject

Interface for a Theme object type

Author:

muzquiano

Field Summary

static String

TYPE_ID

Fields inherited from interface org.springframework.extensions.surf.ModelObject

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Method Summary

Component	getDefaultComponent(RequestContext context, String regionId) Gets the default component.
String	getDefaultComponentId(String regionId) Gets the default component id for a given region id
String	getPageId(String pageTypeId) Gets the page id given the specified page type.
void	removeDefaultComponentId(String regionId) Removes the default component for a given region id
void	setDefaultComponentId(String regionId, String componentId) Sets the default component id.
void	setDefaultPageId(String pageTypeId, String pageId) Sets the page id for a page type.

Methods inherited from interface org.springframework.extensions.surf.ModelObject

getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModelVersion, getModificationTime, getPersisterId, getProperties, getProperty, getStoragePath, getTitle, getTitleId, getTypeId, isSaved, removeCustomProperty, removeModelProperty, removeProperty, setCustomProperty, setDescription, setDescriptionId, setModelProperty, setProperty, setTitle, setTitleId, touch, toXML

Field Detail

TYPE_ID

static final String TYPE_ID

See Also:

Constant Field Values

Method Detail

getPageId

String getPageId(String pageTypeId)

Gets the page id given the specified page type. If the theme supplies a specific page for a given page type it will be returned, if not null.

Parameters:

pageTypeId - the page type id

Returns:

the page id

setDefaultPageId

void setDefaultPageId(String pageTypeId,
                      String pageId)

Sets the page id for a page type.

Parameters:

pageTypeId - the page type id

pageId - the page id

getDefaultComponentId

String getDefaultComponentId(String regionId)

Gets the default component id for a given region id

Parameters:

regionId - the region id

Returns:

the default component id

removeDefaultComponentId

void removeDefaultComponentId(String regionId)

Removes the default component for a given region id

Parameters:

regionId - the region id

setDefaultComponentId

void setDefaultComponentId(String regionId,
                           String componentId)

Sets the default component id.

Parameters:

regionId - the region id

sourceId - the source id

scope - the scope

componentId - the component id

getDefaultComponent

Component getDefaultComponent(RequestContext context,
                              String regionId)

Gets the default component.

Parameters:

context - the context

regionId - the region id

Returns:

the default component