org.apache.tapestry
Interface ComponentResources

All Superinterfaces:

ComponentResourcesCommon, Locatable

All Known Subinterfaces:

InternalComponentResources

All Known Implementing Classes:

InternalComponentResourcesImpl

public interface ComponentResources
extends ComponentResourcesCommon

Provides a component instance with the resources provided by the framework. In many circumstances, the resources object can be considered the component itself; in others, it is the component property, and instance of a class provided by the application developer (though transformed in many ways while being loaded) that is the true component. In reality, it is the combination of the resources object with the lifecycle instance.

Method Summary

void	addPageLifecycleListener(PageLifecycleListener listener) Adds a listener object that will be notified about page lifecycle events.
Link	createActionLink(String eventType, boolean forForm, Object... context) Creates a component action request link as a callback for this component.
Link	createPageLink(String pageName, boolean override, Object... context) Creates a render request link to a specific page.
void	discardPersistentFieldChanges() Discards all persistent field changes for the page containing the component.
AnnotationProvider	getAnnotationProvider(String parameterName) Returns an annotation provider, used to obtain annotations related to the parameter.
Resource	getBaseResource() Returns the base resource for the component, which will represent the class's location within the classpath (this is used to resolve relative assets).
Block	getBlockParameter(String parameterName) Used to access an informal parameter that's a Block.
Class	getBoundType(String parameterName) Returns the actual type of the bound parameter, or null if the parameter is not bound.
Component	getComponent() Returns the component this object provides resources for.
ComponentModel	getComponentModel() Returns the component model object that defines the behavior of the component.
Component	getContainer() Returns the component which contains this component, or null for the root component.
Messages	getContainerMessages() Returns the Messages from the container, or null if this is the root component (with no container).
ComponentResources	getContainerResources() Returns the ComponentResources for the container, or null if the this is the root component (that has no container).
String	getElementName() Returns the name of element that represents the component in its template, or null if not known.
Component	getEmbeddedComponent(String embeddedId) Returns an embedded component, given the component's id.
Messages	getMessages() Returns the message catalog for this component.
Component	getPage() Returns the page that contains this component.
<T extends Annotation> T	getParameterAnnotation(String parameterName, Class<T> annotationType) Obtains an annotation provided by a parameter.
Object	getRenderVariable(String name) Returns a previously stored render variable.
boolean	isBound(String parameterName) Returns true if the named parameter is bound, false if not.
void	renderInformalParameters(MarkupWriter writer) Indentifies all parameters that are not formal parameters and writes each as a attribute/value pair into the current element of the markup writer.
void	storeRenderVariable(String name, Object value) Stores a render variable, accessible with the provided name.

Methods inherited from interface org.apache.tapestry.ComponentResourcesCommon

findBlock, getBlock, getCompleteId, getElementName, getId, getLocale, getLogger, getNestedId, getPageName, isRendering, triggerContextEvent, triggerEvent

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

getLocation

Method Detail

getBaseResource

Resource getBaseResource()

Returns the base resource for the component, which will represent the class's location within the classpath (this is used to resolve relative assets).

getComponentModel

ComponentModel getComponentModel()

Returns the component model object that defines the behavior of the component.

getComponent

Component getComponent()

Returns the component this object provides resources for.

getContainer

Component getContainer()

Returns the component which contains this component, or null for the root component. For mixins, this returns the componet to which the mixin is attached.

getContainerResources

ComponentResources getContainerResources()

Returns the ComponentResources for the container, or null if the this is the root component (that has no container). As a special case, for a mixin, this returns the core component's resources.

getContainerMessages

Messages getContainerMessages()

Returns the Messages from the container, or null if this is the root component (with no container). As a special case, for a mixin, this return the core component's messages.

getPage

Component getPage()

Returns the page that contains this component. Technically, the page itself is an internal object in Tapestry and this returns the root component of the actual page, but from an application developer point of view, this is the page.

getEmbeddedComponent

Component getEmbeddedComponent(String embeddedId)

Returns an embedded component, given the component's id.

Parameters:

embeddedId - selects the embedded component (case is ignored)

Throws:

IllegalArgumentException - if this component does not contain a component with the given id

isBound

boolean isBound(String parameterName)

Returns true if the named parameter is bound, false if not.

getParameterAnnotation

<T extends Annotation> T getParameterAnnotation(String parameterName,
                                                Class<T> annotationType)

Obtains an annotation provided by a parameter.

Parameters:

parameterName - name of parameter to search for the annotation

annotationType - the type of annotation

Returns:

the annotation if found or null otherwise

renderInformalParameters

void renderInformalParameters(MarkupWriter writer)

Indentifies all parameters that are not formal parameters and writes each as a attribute/value pair into the current element of the markup writer.

Parameters:

writer - to which attributes will be written

getMessages

Messages getMessages()

Returns the message catalog for this component.

getBoundType

Class getBoundType(String parameterName)

Returns the actual type of the bound parameter, or null if the parameter is not bound. This is primarily used with property bindings, and is used to determine the actual type of the property, rather than the type of parameter (remember that type coercion automatically occurs, which can mask significant differences between the parameter type and the bound property type).

Parameters:

parameterName - used to select the parameter (case is ignored)

Returns:

the type of the bound parameter, or null if the parameter is not bound

See Also:

Binding.getBindingType()

getAnnotationProvider

AnnotationProvider getAnnotationProvider(String parameterName)

Returns an annotation provider, used to obtain annotations related to the parameter.

Parameters:

parameterName - used to select the parameter (case is ignored)

Returns:

the annotation provider, or null if the parameter is not bound

getBlockParameter

Block getBlockParameter(String parameterName)

Used to access an informal parameter that's a Block.

Parameters:

parameterName - the name of the informal parameter (case is ignored)

Returns:

the informal Block parameter, or null if not bound

getRenderVariable

Object getRenderVariable(String name)

Returns a previously stored render variable.

Parameters:

name - of the variable (case will be ignored)

Returns:

the variable's value

Throws:

IllegalArgumentException - if the name doesn't correspond to a stored value

storeRenderVariable

void storeRenderVariable(String name,
                         Object value)

Stores a render variable, accessible with the provided name.

Parameters:

name - of value to store

value - value to store (may not be null)

Throws:

IllegalStateException - if the component is not currently rendering

addPageLifecycleListener

void addPageLifecycleListener(PageLifecycleListener listener)

Adds a listener object that will be notified about page lifecycle events.

createActionLink

Link createActionLink(String eventType,
                      boolean forForm,
                      Object... context)

Creates a component action request link as a callback for this component. The event type and context (as well as the page name and nested component id) will be encoded into a URL. A request for the URL will ComponentResourcesCommon.triggerEvent(String, Object[], ComponentEventCallback) trigger} the named event on the component.

Parameters:

eventType - the type of event to be triggered. Event types should be Java identifiers (contain only letters, numbers and the underscore).

forForm - if true, the link will be used as the eventType for an HTML form submission, which may affect what information is encoded into the link

context - additional objects to be encoded into the path portion of the link; each is converted to a string and URI encoded

Returns:

link object for the callback

createPageLink

Link createPageLink(String pageName,
                    boolean override,
                    Object... context)

Creates a render request link to a specific page.

Parameters:

pageName - the logical name of the page to link to

override - if true, the context is used even if empty (normally, the target page is allowed to passivate, providing a context, when the provided context is empty)

context - the activation context for the page. If omitted, the activation context is obtained from the target paget

discardPersistentFieldChanges

void discardPersistentFieldChanges()

Discards all persistent field changes for the page containing the component. Changes are eliminated from persistent storage (such as the Session) which will take effect in the next request (the attached page instance is not affected).

getElementName

String getElementName()

Returns the name of element that represents the component in its template, or null if not known.

Returns:

the element name or null