| org.apache.tapestry.model.ComponentModel
ComponentModel | public interface ComponentModel (Code) | | Defines a component in terms of its capabilities, parameters, sub-components, etc. During
runtime, the component model is immutable. During construction time, when
the class is being transformed and loaded, the model is mutable.
See Also: MutableComponentModel |
getBaseResource | Resource getBaseResource()(Code) | | Returns the resource corresponding to the class file for this component. This is used to find
related resources, such as the component's template and message catalog.
|
getComponentClassName | String getComponentClassName()(Code) | | The FQCN of the component.
|
getDeclaredParameterNames | List<String> getDeclaredParameterNames()(Code) | | Returns an alphabetically sorted list of the names of all formal parameters defined by this
specific class (parameters inherited from base classes are not identified).
|
getEmbeddedComponentModel | EmbeddedComponentModel getEmbeddedComponentModel(String componentId)(Code) | | Returns an embedded component.
Parameters: componentId - the id of the embedded component the embedded component model, or null if no component exists with that id |
getFieldPersistenceStrategy | String getFieldPersistenceStrategy(String fieldName)(Code) | | Returns the persistent strategy associated with the field.
Parameters: fieldName - the corresponding strategy, or the empty string |
getLog | Log getLog()(Code) | | Returns object that will be used to log warnings and errors related to this component.
|
getMeta | String getMeta(String key)(Code) | | Gets a meta value identified by the given key. If the current model does not provide a value
for the key, then the parent component model (if any) is searched.
Parameters: key - identifies the value to be accessed the value for the key (possibly inherited from a parent model), or null |
getMixinClassNames | List<String> getMixinClassNames()(Code) | | Returns a list of the class names of mixins that are part of the component's implementation.
|
getParameterModel | ParameterModel getParameterModel(String parameterName)(Code) | | Return a single parameter model by parameter name, or null if the parameter is not defined.
Parameters: parameterName - the name of the parameter (case is ignored) |
getParameterNames | List<String> getParameterNames()(Code) | | Returns an alphabetically sorted list of the names of all formal parameters. This includes
parameters defined by a base class.
|
getParentModel | ComponentModel getParentModel()(Code) | | Returns the component model for this component's super-class, if it exists. Remember that
only classes with the
ComponentClass annotation, and in the correct packages, are
considered component classes.
the parent class model, or null if this component's super class is not itself acomponent class |
getPersistentFieldNames | List<String> getPersistentFieldNames()(Code) | | Returns a list of the names of all persistent fields (within this class, or any super-class).
The names are sorted alphabetically.
See Also: Persist |
getSupportsInformalParameters | boolean getSupportsInformalParameters()(Code) | | Returns true if the model indicates that informal parameters, additional parameters beyond
the formal parameter defined for the component, are supported. This is false in most cases,
but may be set to true for specific classes (when the
SupportsInformalParameters annotation is present, or inherited from a super-class).
true if this component model supports informal parameters |
isMixinAfter | boolean isMixinAfter()(Code) | | Relevant for component mixins only. Indicates that the mixin behavior should occur
after (not before) the component. Normally, this flag is set by the presence of
the
MixinAfter annotation.
true if the mixin should operate after, not before, the component |
isRootClass | boolean isRootClass()(Code) | | Returns true if the modeled component is a root class, a component class whose parent does
not have the
ComponentClass annotation. This is often used to determine whether to
invoke the super-class implementation of certain methods.
true if a root class, false if a subclass |
|
|