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

Fields

Modifier and Type	Field and Description
static String	CSS_TOKENS
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

Methods

Modifier and Type	Method and Description
Map<String,String>	getCssTokens()
String	getPageId(String pageTypeId) Gets the page id given the specified page type.
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, 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

CSS_TOKENS

static final String CSS_TOKENS

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

getCssTokens

Map<String,String> getCssTokens()

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.