|
Annotation Types Summary |
| AfterRender |
Marker annotation for methods associated with the AfterRender phase. |
| AfterRenderBody |
Corresponds to BeforeRenderBody, allowing additional markup after rendering the body of a component, but
before rendering the rest of the component's template. |
| AfterRenderTemplate |
Corresponds to BeforeRenderTemplate, allowing additional markup after rendering the component's template. |
| ApplicationState |
Marker annotation for a field that is an application state object as controlled by the ApplicationStateManager. |
| BeforeRenderBody |
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 |
Associated with components that have a template, this phase is invoked to allow the component to decorate its
template with additional markup. |
| BeginRender |
Marker annotation for methods that should be executed at the start of rendering the component. |
| Cached |
Indicates that a method should only be evaluated once and the result cached. |
| CleanupRender |
Marker annotation for component methods associated with the terminal phase for the component rendering state machine. |
| Component |
Used to define an embedded component within another component. |
| ContentType |
An annotation on a page component used to identify the content type the page returns. |
| Environmental |
Defines a field of a component class that is replaced at runtime with a read-only value obtained from the Environment service. |
| Id |
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). |
| ImmutableSessionPersistedObject |
Marker annotation that can be placed on a session-persisted object to indicate that the object is immutable, and
therefore does not require end-of-request restoring into the session. |
| IncludeJavaScriptLibrary |
Allows for the inclusion of one or more JavaScript libraries. |
| IncludeStylesheet |
Used to automatically include a CSS stylesheet when rendering the page. |
| InjectComponent |
Allows components defined in the template to be injected as read-only properties. |
| InjectContainer |
Used to inject the component which contains this component. |
| InjectPage |
Allows a a page (really, the root component of the page) to be injected into another component as a read-only field. |
| Log |
Marker annotation for component methods to enable debug-level logging. |
| Meta |
Allows for the specification of per-component meta-data. |
| Mixin |
Defines an implementation mixin for a component. |
| MixinAfter |
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 |
Used to attach one or more instance mixins to an embedded component. |
| Mixins |
Used to attach one ore more instance mixin to an embedded component. |
| OnEvent |
Marks a method as a handler for a client side event. |
| PageActivationContext |
Annotation for a field for which the page activation context handlers (onActivate and onPassivate) should be created. |
| PageAttached |
Method annotation used for methods that should be invoked when the page is first attached to a request. |
| PageDetached |
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. |
| PageLoaded |
Method annotation used for methods that should be invoked once the page is fully loaded. |
| Parameter |
Annotation placed on a field to indicate that it is, in fact, a component parameter. |
| Path |
Used in conjunction with the Inject annotation to inject an Asset based on a path. |
| Persist |
Identifies a field as persistent, meaning its value persists from one request to the next. |
| Property |
Annotation for fields for which accessor methods (getters and setters) should be created. |
| Retain |
Marker annotation placed on fields whose value should be retained past the end of the request. |
| Secure |
A marker annotation that indicates that the page in question may only be accessed via HTTPS. |
| Service |
Used in conjunction with the Inject annotation to identify a service by name and not by type. |
| SetupRender |
Marker annotation for methods that should be executed during the SetupRender phase. |
| SupportsInformalParameters |
Used to identify a component that can support informal parameters. |