Contains annotations, primarily those used inside component classes as well as a few specific to the tapestry-core services layer.
Annotation Types Summary Annotation Type Description ActivationContextParameterAnnotation that may be placed on parameters of event handler methods to define their names in OpenAPI description. ActivationRequestParameterMarks a field of a page (not a component) as persistent within the URL, as with a page activation context. AfterRenderMarker annotation for methods associated with the AfterRender phase. AfterRenderBodyCorresponds to
BeforeRenderBody, allowing additional markup after rendering the body of a component, but before rendering the rest of the component's template.
BeforeRenderTemplate, allowing additional markup after rendering the component's template.
BeforeRenderBodyMarks methods to be invoked when the component rendering state machine hits the point in the component's template where the body element occurs. BeforeRenderTemplateAssociated with components that have a template, this phase is invoked to allow the component to decorate its template with additional markup. BeginRenderMarker annotation for methods that should be executed at the start of rendering the component. BindParameterDesignates a field in a mixin which is bound to the parameter of the containing component corresponding to the value of the annotation. CachedIndicates that a method should only be evaluated once per request and the result cached. CleanupRenderMarker annotation for component methods associated with the terminal phase for the component rendering state machine. ComponentUsed to define an embedded component within another component. ContentTypeAn annotation on a page component used to identify the content type the page returns. DisableStrictChecksDisables strict checks Tapestry-IoC or Tapestry may perform on methods. DiscardAfterMarks a method of a page or a component to discard all persistent field changes. EnvironmentalDefines a field of a component class that is replaced at runtime with a read-only value obtained from the
EventsAnnotation applied to components to document what events a component may trigger. HeartbeatDeferredMarks a component method as deferred until the end of the
IdOptional 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).
t5/core/ajaxfunction when the
optionsparameter has an
RequestBodyAnnotation that may be placed on parameters of event handler methods, usually in page classes. RequestParameterAnnotation that may be placed on parameters of event handler methods. RestInfoAnnotation that provides some information about REST event handler methods for OpenAPI description generation. Retain Deprecated.This rarely used annotation is likely to cause threading issues starting in Tapestry 5.2 (which no longer pools pages but uses shared instances with externalized mutable state) SecureA marker annotation that indicates that the page in question may only be accessed via HTTPS. ServiceUsed in conjunction with the
Injectannotation to identify a service by name and not by type.
SessionAttributeUsed to map a property of a page or component to value stored in session. SessionStateMarker annotation for a property that is a session state object (SSO) as controlled by the
SetupRenderMarker annotation for methods that should be executed during the SetupRender phase. StaticActivationContextValueAnnotation that may be placed on parameters of event handler methods to define them as having a static value. SupportsInformalParametersUsed to identify a component that can support informal parameters. UnknownActivationContextCheckA marker annotation that indicates that the page in question may only be accessed with a exact activation context. WhitelistAccessOnlyIdentifies a page that should only be accessed from clients on the whitelist.