Uses of Class
org.apache.tapestry5.ioc.annotations.UseWith
-
Packages that use UseWith Package Description org.apache.tapestry5.annotations Contains annotations, primarily those used inside component classes as well as a few specific to the tapestry-core services layer.org.apache.tapestry5.beaneditor org.apache.tapestry5.clojure Allows Clojure functions to be injected into Tapestry services and componentsorg.apache.tapestry5.hibernate.annotations Annotations for using Hibernate within Tapestry components or servicesorg.apache.tapestry5.http.annotations org.apache.tapestry5.ioc.annotations Annotations for Tapestry IOC servicesorg.apache.tapestry5.jpa.annotations JPA annotationsorg.apache.tapestry5.kaptcha.annotations Kaptcha annotationsorg.apache.tapestry5.services Core services -
-
Uses of UseWith in org.apache.tapestry5.annotations
Classes in org.apache.tapestry5.annotations with annotations of type UseWith Modifier and Type Class Description interfaceActivationContextParameterAnnotation that may be placed on parameters of event handler methods to define their names in OpenAPI description.interfaceActivationRequestParameterMarks a field of a page (not a component) as persistent within the URL, as with a page activation context.interfaceAfterRenderMarker annotation for methods associated with the AfterRender phase.interfaceAfterRenderBodyCorresponds toBeforeRenderBody, allowing additional markup after rendering the body of a component, but before rendering the rest of the component's template.interfaceAfterRenderTemplateCorresponds toBeforeRenderTemplate, allowing additional markup after rendering the component's template.interfaceBeforeRenderBodyMarks methods to be invoked when the component rendering state machine hits the point in the component's template where the body element occurs.interfaceBeforeRenderTemplateAssociated with components that have a template, this phase is invoked to allow the component to decorate its template with additional markup.interfaceBeginRenderMarker annotation for methods that should be executed at the start of rendering the component.interfaceBindParameterDesignates a field in a mixin which is bound to the parameter of the containing component corresponding to the value of the annotation.interfaceCachedIndicates that a method should only be evaluated once per request and the result cached.interfaceCleanupRenderMarker annotation for component methods associated with the terminal phase for the component rendering state machine.interfaceComponentUsed to define an embedded component within another component.interfaceContentTypeAn annotation on a page component used to identify the content type the page returns.interfaceDiscardAfterMarks a method of a page or a component to discard all persistent field changes.interfaceEnvironmentalDefines a field of a component class that is replaced at runtime with a read-only value obtained from theEnvironmentservice.interfaceEventsAnnotation applied to components to document what events a component may trigger.interfaceHeartbeatDeferredMarks a component method as deferred until the end of theHeartbeat.interfaceIdOptional annotation, used withInject, which exists to provide the id of an object when it can not be determined by other means (such as from the field name).interfaceImportAnnotations to control the importing of JavaScript stacks and libraries as well as stylesheets.interfaceInjectComponentAllows components defined in the template to be injected as read-only properties.interfaceInjectContainerUsed to inject the component which contains this component.interfaceInjectPageAllows a a page (really, the root component of the page) to be injected into another component as a read-only field.interfaceLogMarker annotation for component methods to enable debug-level logging.interfaceMetaAllows for the specification of per-component meta-data.interfaceMixinDefines an implementation mixin for a component.interfaceMixinAfterA 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.interfaceMixinClassesUsed to attach one or more instance mixins to an embedded component.interfaceMixinsUsed to attach one ore more instance mixin to an embedded component.interfaceOnEventMarks a method as a handler for a client side event.interfacePageActivationContextAnnotation for a field for which the page activation context handlers (onActivate and onPassivate) should be created.interfacePageAttachedMethod annotation used for methods that should be invoked when the page is first attached to a request.interfacePageDetachedMethod 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.interfacePageLoadedMethod annotation used for methods that should be invoked once the page is fully loaded.interfacePageResetMarker annotation for a method that should be invoked when a page is reset.interfaceParameterAnnotation placed on a field to indicate that it is, in fact, a component parameter.interfacePathinterfacePersistIdentifies a field as persistent, meaning its value persists from one request to the next.interfacePropertyAnnotation for fields for which accessor methods (getters and setters) should be created.interfacePublishEventMarks an event handler method to be published as an event to be called in JavaScript through thet5/core/ajaxfunction when theoptionsparameter has anelementattribute.interfaceRequestBodyAnnotation that may be placed on parameters of event handler methods, usually in page classes.interfaceRequestParameterAnnotation that may be placed on parameters of event handler methods.interfaceRestInfoAnnotation that provides some information about REST event handler methods for OpenAPI description generation.interfaceRetainDeprecated.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)interfaceSecureA marker annotation that indicates that the page in question may only be accessed via HTTPS.interfaceServiceUsed in conjunction with theInjectannotation to identify a service by name and not by type.interfaceSessionAttributeUsed to map a property of a page or component to value stored in session.interfaceSessionStateMarker annotation for a property that is a session state object (SSO) as controlled by theApplicationStateManager.interfaceSetupRenderMarker annotation for methods that should be executed during the SetupRender phase.interfaceStaticActivationContextValueAnnotation that may be placed on parameters of event handler methods to define them as having a static value.interfaceSupportsInformalParametersUsed to identify a component that can support informal parameters.interfaceUnknownActivationContextCheckA marker annotation that indicates that the page in question may only be accessed with a exact activation context.interfaceWhitelistAccessOnlyIdentifies a page that should only be accessed from clients on the whitelist. -
Uses of UseWith in org.apache.tapestry5.beaneditor
Classes in org.apache.tapestry5.beaneditor with annotations of type UseWith Modifier and Type Class Description interfaceDataTypeUsed to explicitly set the data type used to select an editor (or display) block.interfaceNonVisualMarker annotation for properties which are non-visual, and so should not appear (by default) inside a BeanModel.interfaceReorderPropertiesAn annotation that may be placed on a JavaBean to re-order the properties.interfaceSortableUsed to explicitly define whether a property should be considerable sortable or not.interfaceTranslateUsed to attach the name of a Translator used to convert the associated property between server-side and client-side representations.interfaceValidateUsed to attach validation constraints directly to a property (either the getter or the setter method).interfaceWidthDefines the desired width of the field used to edit the property. -
Uses of UseWith in org.apache.tapestry5.clojure
Classes in org.apache.tapestry5.clojure with annotations of type UseWith Modifier and Type Class Description interfaceFunctionNameOverrides the default mapping from method name to Clojure function name.interfaceNamespaceMaps a service interface to a Clojure namespace. -
Uses of UseWith in org.apache.tapestry5.hibernate.annotations
Classes in org.apache.tapestry5.hibernate.annotations with annotations of type UseWith Modifier and Type Class Description interfaceCommitAfterMarks a method of a service (or a component method) as transactional: the active transaction should commit after invoking the method. -
Uses of UseWith in org.apache.tapestry5.http.annotations
Classes in org.apache.tapestry5.http.annotations with annotations of type UseWith Modifier and Type Class Description interfaceImmutableSessionPersistedObjectMarker 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. -
Uses of UseWith in org.apache.tapestry5.ioc.annotations
Classes in org.apache.tapestry5.ioc.annotations with annotations of type UseWith Modifier and Type Class Description interfaceAutobuildDirects that the value to be built should be an autobuild instance of the type with injections performed, via ObjectLocator.html#autobuild(Class).interfaceDescriptionAnnotation used by Tapestry to describe the annotated class or package in runtime, specially in the T5Dashboard page.interfaceEagerLoadMarker annotation placed on a service builder method to indicate that the service should be eagerly loaded: realized as if a service method had been invoked.interfaceImportModuleAttached to a module class, this annotation identifies other module classes that should also be added to the Registry.interfaceInjectThis annotation serves is something of the Swiss Army knife for operations related to injection of dependencies into an arbitrary method of Java Bean.interfaceInjectResourceDeprecated.Deprecated in Tapestry 5.3, to be removed in a later release.interfaceInjectServiceAnnotation used with parameters of service builder methods to identify the service to be injected into the service builder method via the parameter.interfaceIntermediateTypeUsed to guide Tapestry when coercing from a raw type to a field or parameter type, by forcing Tapestry to coerce to the intermediate type.interfaceLocalA special marker annotation which limits the search for possible services to just the same module containing the service being injected.interfaceMarkerUsed to define one or more ServiceDef#getMarkers() marker annotations for a service implementation.interfaceMatchOptional, but typically used, annotation for service decorator methods, used to define which services the decorator applies to.interfaceNotLazyMarks a method as specifically not-lazy, even if other methods in the same interface are being advised as lazy.interfaceOperationDescribes a method as one that should be operation tracked.interfaceOptionalMarks a service contribution method within a module as being optional: it is not an error if the contribution does not match against an actual service.interfaceOrderUsed with a service decorator method to control the order in which decorations occur.interfacePostInjectionAnnotation for methods that should be invoked after injection.interfacePreventServiceDecorationMarks a service as not eligible for decoration.interfacePrimaryMarker annotation used to denote a service that is the primary instance of some common interface.interfaceScopeAn optional annotation that may be placed on a service building method of a module, or on the implementation class (when using service binding).interfaceServiceIdAn optional annotation that may be placed on a service building method of a module, or on the implementation class (when using service binding via theServiceBinder).interfaceSubModuleDeprecated.Deprecated in 5.4, useImportModuleinstead.interfaceSymbolUsed to inject a symbol value, via a symbol name.interfaceUsesConfigurationA documentation-only interface placed on service interfaces for services which have an unordered configuration, to identify the type of contribution.interfaceUsesMappedConfigurationA documentation-only interface placed on service interfaces for services which have a mapped configuration, to identify the type of key (often, a String), and type of contribution.interfaceUsesOrderedConfigurationA documentation-only interface placed on service interfaces for services which have an ordered configuration, to identify the type of contribution.interfaceValueUsed in conjunction withInjectto inject a literal value, rather than a service. -
Uses of UseWith in org.apache.tapestry5.jpa.annotations
Classes in org.apache.tapestry5.jpa.annotations with annotations of type UseWith Modifier and Type Class Description interfaceCommitAfter -
Uses of UseWith in org.apache.tapestry5.kaptcha.annotations
Classes in org.apache.tapestry5.kaptcha.annotations with annotations of type UseWith Modifier and Type Class Description interfaceKaptchaUsed to explicitly select the kaptcha editor block for a property. -
Uses of UseWith in org.apache.tapestry5.services
Classes in org.apache.tapestry5.services with annotations of type UseWith Modifier and Type Class Description interfaceAssetRequestDispatcherMarker annotation used to specifically identify theDispatcherused to dispatch asset requests (so thatAssetRequestHandlers can be contributed).
-