|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MutableComponentModel
Mutable version of ComponentModel
used during the transformation phase.
Method Summary | |
---|---|
MutableEmbeddedComponentModel |
addEmbeddedComponent(java.lang.String id,
java.lang.String type,
java.lang.String componentClassName,
boolean inheritInformalParameters,
Location location)
Defines a new embedded component. |
void |
addEventHandler(java.lang.String eventType)
Identifies that the component includes an event handler for the indicated event type. |
void |
addMixinClassName(java.lang.String mixinClassName,
java.lang.String... order)
Adds a mixin to the component's implementation, optionally specifying ordering constraints, as per OrderedConfiguration. |
void |
addParameter(java.lang.String name,
boolean required,
boolean allowNull,
java.lang.String defaultBindingPrefix)
Deprecated. Use addParameter(String, boolean, boolean, String, boolean) instead. |
void |
addParameter(java.lang.String name,
boolean required,
boolean allowNull,
java.lang.String defaultBindingPrefix,
boolean cached)
Adds a new formal parameter to the model. |
void |
addRenderPhase(java.lang.Class renderPhase)
Identifies that the component does handle the render phase. |
void |
enableSupportsInformalParameters()
Sets the internal flag to indicate that this model (and all models that extend from it) support informal parameters. |
java.lang.String |
setFieldPersistenceStrategy(java.lang.String fieldName,
java.lang.String strategy)
Used to define the field persistence strategy for a particular field name. |
void |
setMeta(java.lang.String key,
java.lang.String value)
Stores a meta data value under the indicated key. |
void |
setMixinAfter(boolean mixinAfter)
Changes the value of the mixinAfter flag. |
Methods inherited from interface org.apache.tapestry5.model.ComponentModel |
---|
getBaseResource, getComponentClassName, getDeclaredParameterNames, getEmbeddedComponentIds, getEmbeddedComponentModel, getFieldPersistenceStrategy, getHandledRenderPhases, getLogger, getMeta, getMixinClassNames, getOrderForMixin, getParameterModel, getParameterNames, getParentModel, getPersistentFieldNames, getSupportsInformalParameters, handlesEvent, isFormalParameter, isMixinAfter, isPage, isRootClass |
Method Detail |
---|
void addParameter(java.lang.String name, boolean required, boolean allowNull, java.lang.String defaultBindingPrefix)
addParameter(String, boolean, boolean, String, boolean)
instead.
name
- new, unique name for the parameterrequired
- if true, the parameter must be boundallowNull
- if true, then parameter may be bound to null, if false a null check will be addeddefaultBindingPrefix
- the default binding prefix for this parameter @throws IllegalArgumentException if a
parameter with the given name has already been defined for this modelParameter
void addParameter(java.lang.String name, boolean required, boolean allowNull, java.lang.String defaultBindingPrefix, boolean cached)
name
- new, unique name for the parameterrequired
- if true, the parameter must be boundallowNull
- if true, then parameter may be bound to null, if false a null check will be addeddefaultBindingPrefix
- the default binding prefix for this parameter @throws IllegalArgumentException if a
parameter with the given name has already been defined for this modelcached
- if true, the parameter value should be cached within the component during renderingParameter
MutableEmbeddedComponentModel addEmbeddedComponent(java.lang.String id, java.lang.String type, java.lang.String componentClassName, boolean inheritInformalParameters, Location location)
id
- the unique id for the embedded component, which must not already exist.type
- the type of the component (posslibly blank)componentClassName
- the fully qualified class name (derived from the field), used if the type is
blankinheritInformalParameters
- if true, then the component will inherit informal parameters provided to its
containerlocation
- where the component is defined @return a mutable model allowing parameters to be
setjava.lang.String setFieldPersistenceStrategy(java.lang.String fieldName, java.lang.String strategy)
fieldName
- the name of the field which is to be made persistentstrategy
- the strategy for persisting the field, from Persist.value()
. This value may be blank, in
which case the stategy is inherited from the component, or the component's container.
ComponentModel.getFieldPersistenceStrategy(String)
,
and with InternalComponentResources.persistFieldChange(String, Object)
, etc.void addMixinClassName(java.lang.String mixinClassName, java.lang.String... order)
void enableSupportsInformalParameters()
void setMixinAfter(boolean mixinAfter)
void setMeta(java.lang.String key, java.lang.String value)
void addRenderPhase(java.lang.Class renderPhase)
renderPhase
- annotation class corresponding to the render phaseComponentModel.getHandledRenderPhases()
void addEventHandler(java.lang.String eventType)
eventType
- of handled event
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |