org.springframework.extensions.surf.types

Interface AdvancedComponent

All Superinterfaces:

Comparable<Component>, Component, ModelObject, Serializable, SurfBugData

All Known Implementing Classes:

AdvancedComponentImpl

public interface AdvancedComponent
extends Component

Extends Component to provide some additional extensibility function. Overriding the default Spring Surf configuration for the Component type to use an implementation of this interface will enable all existing configured components to be treated as AdvancedComponents.

An AdvancedComponent is a Component that contains elements that can be individually rendered. This means that extending modules can add additional renderable elements into them, or update the evaluators that determine the WebScript that renders them.

Author:

David Draper

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT
static String	EVALUATION
static String	EVALUATIONS
static String	EVALUATOR
static String	EVALUATORS
static String	ID
static String	INDEX
static String	NAME
static String	NEGATE
static String	PARAM
static String	PARAMS
static String	PROPERTIES
static String	RENDER_IF_EVALUATED
static String	SUB_COMPONENT
static String	SUB_COMPONENTS
static String	TYPE
static String	URI
static String	URL
static String	VALUE

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

PROP_CHROME, PROP_COMPONENT_TYPE_ID, PROP_GUID, PROP_INDEX, PROP_REGION_ID, PROP_SCOPE, PROP_SOURCE_ID, PROP_URI, PROP_URL, 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
void	applyConfig(org.dom4j.Element componentEl)
List<SubComponent>	getSubComponents()
boolean	isAdvancedConfig()
void	setSubComponents(List<SubComponent> renderableElements)

Methods inherited from interface org.springframework.extensions.surf.types.Component

getChrome, getComponentType, getComponentTypeId, getGUID, getIndex, getRegionId, getScope, getSourceId, getSourceObject, getURI, getURL, setChrome, setComponentTypeId, setGUID, setIndex, setRegionId, setScope, setSourceId, setURI, setURL

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.springframework.extensions.surf.types.SurfBugData

getResolvedWebScript, setResolvedWebScript

Field Detail

SUB_COMPONENTS

static final String SUB_COMPONENTS

See Also:

Constant Field Values

SUB_COMPONENT

static final String SUB_COMPONENT

See Also:

Constant Field Values

COMPONENT

static final String COMPONENT

See Also:

Constant Field Values

INDEX

static final String INDEX

See Also:

Constant Field Values

ID

static final String ID

See Also:

Constant Field Values

EVALUATIONS

static final String EVALUATIONS

See Also:

Constant Field Values

EVALUATION

static final String EVALUATION

See Also:

Constant Field Values

EVALUATORS

static final String EVALUATORS

See Also:

Constant Field Values

EVALUATOR

static final String EVALUATOR

See Also:

Constant Field Values

NEGATE

static final String NEGATE

See Also:

Constant Field Values

URI

static final String URI

See Also:

Constant Field Values

URL

static final String URL

See Also:

Constant Field Values

TYPE

static final String TYPE

See Also:

Constant Field Values

PARAMS

static final String PARAMS

See Also:

Constant Field Values

PARAM

static final String PARAM

See Also:

Constant Field Values

NAME

static final String NAME

See Also:

Constant Field Values

VALUE

static final String VALUE

See Also:

Constant Field Values

RENDER_IF_EVALUATED

static final String RENDER_IF_EVALUATED

See Also:

Constant Field Values

PROPERTIES

static final String PROPERTIES

See Also:

Constant Field Values

Method Detail

getSubComponents

List<SubComponent> getSubComponents()

Returns:

A List of SubComponent instances directly configured (i.e. not defined in an ExtensionModule).

setSubComponents

void setSubComponents(List<SubComponent> renderableElements)

isAdvancedConfig

boolean isAdvancedConfig()

applyConfig

void applyConfig(org.dom4j.Element componentEl)