org.apache.tapestry5.internal.model

Class MutableEmbeddedComponentModelImpl

java.lang.Object

org.apache.tapestry5.ioc.BaseLocatable

org.apache.tapestry5.internal.model.MutableEmbeddedComponentModelImpl

All Implemented Interfaces:

Locatable, EmbeddedComponentModel, MutableEmbeddedComponentModel

public class MutableEmbeddedComponentModelImpl
extends BaseLocatable
implements MutableEmbeddedComponentModel

Constructor Summary

Constructors

Constructor and Description
MutableEmbeddedComponentModelImpl(java.lang.String id, java.lang.String componentType, java.lang.String componentClassName, java.lang.String declaredClass, boolean inheritInformalParameters, Location location)

Method Summary

Modifier and Type	Method and Description
void	addMixin(java.lang.String mixinClassName, java.lang.String... constraints) Adds a mixin to the component in terms of its fully qualified class name, with optional ordering constraints.
void	addParameter(java.lang.String name, java.lang.String value)
java.lang.String	getComponentClassName() The class name of the component, as derived from the field to which the Component annotation is applied.
java.lang.String	getComponentType() The type of the component, which may be blank.
java.lang.String[]	getConstraintsForMixin(java.lang.String mixinClassName)
java.lang.String	getId() A unique id for the embedded component.
boolean	getInheritInformalParameters() If true, then the component should inherit informal parameters from its container.
java.util.List<java.lang.String>	getMixinClassNames() Returns the fully qualified class names of all mixins added to this component, sorted alphabetically.
java.util.List<java.lang.String>	getParameterNames() A sorted list of the names of all bound parameters.
java.lang.String	getParameterValue(java.lang.String parameterName) The value for each parameter, which will be interpreted as a binding expression.
java.util.List<java.lang.String>	getPublishedParameters() Returns the list of published parameters of this component (usually an empty list).
void	setPublishedParameters(java.util.List<java.lang.String> parameterNames) Sets the list of published parameters for this embedded component.
java.lang.String	toString()

Methods inherited from class org.apache.tapestry5.ioc.BaseLocatable

getLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tapestry5.ioc.Locatable

getLocation

Constructor Detail

MutableEmbeddedComponentModelImpl

public MutableEmbeddedComponentModelImpl(java.lang.String id,
                                         java.lang.String componentType,
                                         java.lang.String componentClassName,
                                         java.lang.String declaredClass,
                                         boolean inheritInformalParameters,
                                         Location location)

Method Detail

getComponentClassName

public java.lang.String getComponentClassName()

Description copied from interface: EmbeddedComponentModel

The class name of the component, as derived from the field to which the Component annotation is applied. This value is only used when the componentType property is blank.

Specified by:

getComponentClassName in interface EmbeddedComponentModel

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

Specified by:

addParameter in interface MutableEmbeddedComponentModel

getId

public java.lang.String getId()

Description copied from interface: EmbeddedComponentModel

A unique id for the embedded component.

Specified by:

getId in interface EmbeddedComponentModel

getComponentType

public java.lang.String getComponentType()

Description copied from interface: EmbeddedComponentModel

The type of the component, which may be blank.

Specified by:

getComponentType in interface EmbeddedComponentModel

getParameterNames

public java.util.List<java.lang.String> getParameterNames()

Description copied from interface: EmbeddedComponentModel

A sorted list of the names of all bound parameters.

Specified by:

getParameterNames in interface EmbeddedComponentModel

getParameterValue

public java.lang.String getParameterValue(java.lang.String parameterName)

Description copied from interface: EmbeddedComponentModel

The value for each parameter, which will be interpreted as a binding expression.

Specified by:

getParameterValue in interface EmbeddedComponentModel

getMixinClassNames

public java.util.List<java.lang.String> getMixinClassNames()

Description copied from interface: EmbeddedComponentModel

Returns the fully qualified class names of all mixins added to this component, sorted alphabetically.

Specified by:

getMixinClassNames in interface EmbeddedComponentModel

addMixin

public void addMixin(java.lang.String mixinClassName,
                     java.lang.String... constraints)

Description copied from interface: MutableEmbeddedComponentModel

Adds a mixin to the component in terms of its fully qualified class name, with optional ordering constraints.

Specified by:

addMixin in interface MutableEmbeddedComponentModel

getInheritInformalParameters

public boolean getInheritInformalParameters()

Description copied from interface: EmbeddedComponentModel

If true, then the component should inherit informal parameters from its container.

Specified by:

getInheritInformalParameters in interface EmbeddedComponentModel

setPublishedParameters

public void setPublishedParameters(java.util.List<java.lang.String> parameterNames)

Description copied from interface: MutableEmbeddedComponentModel

Sets the list of published parameters for this embedded component.

Specified by:

setPublishedParameters in interface MutableEmbeddedComponentModel

Parameters:

parameterNames - list of names

See Also:

Component.publishParameters()

getPublishedParameters

public java.util.List<java.lang.String> getPublishedParameters()

Description copied from interface: EmbeddedComponentModel

Returns the list of published parameters of this component (usually an empty list).

Specified by:

getPublishedParameters in interface EmbeddedComponentModel

Returns:

list of parameter names to publish

See Also:

Component.publishParameters()

getConstraintsForMixin

public java.lang.String[] getConstraintsForMixin(java.lang.String mixinClassName)

Specified by:

getConstraintsForMixin in interface EmbeddedComponentModel

Returns:

the ordering constraints for the specified mixin, or null.