| Java Source Code / Java Documentation » Web Framework » Tapestry » org.apache.tapestry.annotations |
| org.apache.tapestry.annotations | ||
| Java Source File Name | Type | Comment |
| AfterRender.java | Annotation | Marker annotation for methods associated with the AfterRender phase. |
| AfterRenderBody.java | Annotation | Corresponds to BeforeRenderBody , allowing additional markup after rendering the body of a component, but before rendering the rest of the component's template. |
| AfterRenderTemplate.java | Annotation | Corresponds to BeforeRenderTemplate , allowing additional markup after rendering the component's template. |
| ApplicationState.java | Annotation | Marker annotation for a field that is an application state object as controlled by the
ApplicationStateManager .
An ASO file may have a companion field, of type boolean, used to see if the ASO has been created yet. If another field exists with the same name, suffixed with "Exists" (i.e., "_aso" for the ASO field, and "_asoExists" for the companion field) and the type of that field is boolean, then access to the field will determine whether the ASO has already been created. |
| BeforeRenderBody.java | Annotation | Marks methods to be invoked when the component rendering state machine hits the point in the component's template where the body element occurs. |
| BeforeRenderTemplate.java | Annotation | Associated with components that have a template, this phase is invoked to allow the component to decorate its template with additional markup. |
| BeginRender.java | Annotation | Marker annotation for methods that should be executed at the start of rendering the component.
This usually includes rendering of the component's start tag.
Such methods may optionally take a org.apache.tapestry.MarkupWriter parameter, and may return void or boolean. |
| CleanupRender.java | Annotation | Marker annotation for component methods associated with the terminal phase for the component rendering state machine. |
| Component.java | Annotation | Used to define an embedded component within another component. |
| Environmental.java | Annotation | Defines a field that is replaced at runtime with a read-only value obtained from the Environment service. |
| Id.java | Annotation | Optional annotation, used with Inject , which exists to provide the id of an object when it can not be determined by other means (such as from the field name). |
| Inject.java | Annotation | Allows injection of various objects into a component class. |
| InjectComponent.java | Annotation | Used exclusively inside a mixin to connect the mixin to the component to which it is attached. |
| InjectPage.java | Annotation | Allows a a page (really, the root component of the page) to be injected into another component as a read-only field. |
| Meta.java | Annotation | Allows for the specification of per-component meta-data. |
| Mixin.java | Annotation | Defines an implementation mixin for a comopnent. |
| MixinAfter.java | Annotation | A marker annotation applied to a mixin to indicate that the mixin's render state behavior is deferred until after the the behavior of the component to which the mixin is attached. |
| MixinClasses.java | Annotation | Used to attach one or more instance mixins to an embedded component. |
| Mixins.java | Annotation | Used to attach one ore more instance mixin to an embedded component. |
| OnEvent.java | Annotation | Marks a method as a handler for a client side event. |
| PageAttached.java | Annotation | Method annotation used for methods that should be invoked when the page is first attached to a request. |
| PageDetached.java | Annotation | Method annotation used for methods that should be invoked when the page is detached at the end of
a request, before it is returned to the page pool for later reuse.
PageDetached methods should take no parameters and return void. |
| PageLoaded.java | Annotation | Method annotation used for methods that should be invoked once the page is fully loaded. |
| Parameter.java | Annotation | Annotation placed on a field to indicate that it is, in fact, an parameter. |
| Path.java | Annotation | Used in conjunction with the Inject annotation to inject an Asset based on a path. |
| Persist.java | Annotation | Identifies a field as persistent, meaning its value persists from one request to the next.
Different strategies exist for how this is accomplished, the most common being the default,
"session", which stores the field's value in the
Session .
In most cases, the value will be omitted and will default to the empty string. |
| Retain.java | Annotation | Marker annotation placed on fields whose value should be retained past the end of the request. This is most often associated with fields that are lazily loaded. |
| Service.java | Annotation | Used in conjunction with the Inject annotation to identify a service by name and not by type. |
| SetupRender.java | Annotation | Marker annotation for methods that should be executed during the SetupRender phase. |
| SupportsInformalParameters.java | Annotation | Used to identify a component that can support informal parameters. |