org.springframework.extensions.surf.types

Class ThemeImpl

java.lang.Object

org.springframework.extensions.surf.types.AbstractModelObject

org.springframework.extensions.surf.types.ThemeImpl

All Implemented Interfaces:

Serializable, ModelObject, ResourceProvider, Theme

public class ThemeImpl
extends AbstractModelObject
implements Theme

Default theme implementation

Author:

muzquiano, David Draper, Kevin Roast

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.extensions.surf.types.AbstractModelObject

customProperties, description, descriptionId, id, info, modelProperties, modificationTime, resourceContainer, title, titleId

Fields inherited from interface org.springframework.extensions.surf.types.Theme

CSS_TOKENS, TYPE_ID

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

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Constructor Summary

Constructors

Constructor and Description
ThemeImpl(String id, ModelPersisterInfo key, org.dom4j.Document document) Instantiates a new theme for a given XML document.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getCssTokens()
String	getPageId(String pageTypeId) Checks the theme to find the id of the page that is mapped to the requested page type.
String	getTypeId() Returns the type id of the model object.
void	setDefaultPageId(String pageTypeId, String pageId) Sets the page id for a page type.

Methods inherited from class org.springframework.extensions.surf.types.AbstractModelObject

addResource, addResource, getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModificationTime, getPersisterId, getProperties, getProperty, getResource, getResourceContainer, getResources, getResourcesMap, getStoragePath, getTitle, getTitleId, isCustomProperty, isModelProperty, isSaved, removeCustomProperty, removeModelProperty, removeProperty, removeResource, setCustomProperty, setDescription, setDescriptionId, setId, setModelProperty, setModificationTime, setProperty, setTitle, setTitleId, toString, touch, toXML, updateResource, updateXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

Constructor Detail

ThemeImpl

public ThemeImpl(String id,
         ModelPersisterInfo key,
         org.dom4j.Document document)

Instantiates a new theme for a given XML document.

Parameters:

document - the document

Method Detail

getCssTokens

public Map<String,String> getCssTokens()

Specified by:

getCssTokens in interface Theme

Returns:

A Map of CSS tokens to substitution values. These are used when processing CSS source files so that a common CSS file can be modified per theme.

getTypeId

public String getTypeId()

Description copied from interface: ModelObject

Returns the type id of the model object.

Specified by:

getTypeId in interface ModelObject

Specified by:

getTypeId in class AbstractModelObject

Returns:

The type id

getPageId

public String getPageId(String pageTypeId)

Checks the theme to find the id of the page that is mapped to the requested page type. A mapping is defined in a theme configuration file by specifying a element containing and (or ) elements.

Specified by:

getPageId in interface Theme

Parameters:

pageTypeId - The id of the page type to look for

Returns:

The id of the page mapped to the page in the theme. Returns null if a mapping is not defined.

setDefaultPageId

public void setDefaultPageId(String pageTypeId,
                    String pageId)

Description copied from interface: Theme

Sets the page id for a page type.

Specified by:

setDefaultPageId in interface Theme

Parameters:

pageTypeId - the page type id

pageId - the page id