Interface Summary Interface Description ApplicationStateCreator<T>Used by
ApplicationStatePersistenceStrategyto create a Session State Object (SSO) on demand.
ApplicationStateManagerResponsible for managing Session State Objects (SSO), objects which persist between requests but are not tied to any individual page or component. ApplicationStatePersistenceStrategyUsed by
ApplicationStateManagerto manage a specific kind of Session State Object (SSO) persistence.
ApplicationStatePersistenceStrategySourceUsed to provide access to
ApplicationStatePersistenceStrategySourceinstances via a logical name for the strategy, such as "session".
AssetSourceto create new
Assets as needed.
AssetPathConverterConverts the path (or URI) of an asset into a new format. AssetSourceUsed to find or create an
Assetwith a given path.
BeanBlockOverrideSourceUsed to override the default
BeanBlockSourcefor a particular data type.
BeanBlockSourceA source of
Blocks used to display the properties of a bean (used by the
Gridcomponent), or to edit the properties of a bean (used by the
BeanEditContextDefines a context for editing a bean via
BindingFactoryCreates a binding of a particular type. BindingSourceUsed to acquire bindings for component parameters. ClasspathAssetAliasManager Deprecated.Deprecated in 5.4, with no replacement. ClasspathAssetProtectionRuleChain-of-responsibility service which defines rules for blocking access to classpath resources based on their paths. ClientBehaviorSupport Deprecated.Deprecated in 5.4 with no replacement. ClientDataEncoderA service used when a component or service needs to encode some amount of data on the client as a string. ClientDataSinkAllows binary object data to be encoded into a string. ComponentClassResolverResolves page names and component types to fully qualified class names. ComponentDefaultProviderA service that can be injected into a component to provide common defaults for various types of parameters. ComponentEventHandlerInterface used with
TransformationSupport.addEventHandler(String, int, String, ComponentEventHandler)}.
ComponentEventLinkEncoderResponsible for creating
Links for page render requests and for component event requests, and for parsing incoming paths to identify requests that are component event or page render requests.
ComponentEventRequestFilterFilter interface for
ComponentEventRequestHandlerHandler interface for component event requests. ComponentEventResultProcessor<T>Responsible for handling the return value provided by a component event handler method. ComponentLibraryInfo.SourceUrlResolverInterface that provides the source URL for a given
ComponentLibraryInfoSourceService that provides information about component libraries. ComponentOverrideService that allows replacing one component, page or mixin class by another without changing the sources. ComponentRequestFilterFilter interface for
ComponentRequestHandlerA facade around
PageRenderRequestHandlerthat allows for simplified filters that cover both types of requests.
ComponentSourceUsed by classes that need to retrieve a component by its complete id, or a page by its logical page name or root component class. ContextPathEncoderA service to provide utilities needed for event context encoding and decoding to and from (partial) URL paths. ContextValueEncoderUsed to convert values used in event contexts to client string representations and back. CookiesUsed by other services to obtain cookie values for the current request, or to write cookie values as part of the request. DateUtilitiesFormatting utilities for dates; this is primarily used when communicating server-side dates to the clients in ISO-8601 format. EnvironmentProvides access to environment objects, which are almost always provided to enclosed components by enclosing components. EnvironmentalShadowBuilderMuch like
PropertyShadowBuilder, except that instead of accessing a property of some other service, it accesses a value from within the
ExceptionReporterInterface implemented by a page used for reporting exceptions. ExceptionReportWriterUsed by the default
ExceptionReporterimplementation to convert an exception into a stream of text that can be stored to a file.
FieldTranslatorSourceFor a particular field, generates the default
FieldTranslatorfor the field.
FieldValidatorDefaultSourceFor a particular field, generates the default validation for the field, in accordance with a number of factors and contributions. FieldValidatorSourceUsed to create
FieldValidators for a particular
FormSupportServices provided by an enclosing Form control component to the various form element components it encloses. HeartbeatAllows for deferred execution of logic, useful when trying to get multiple components to coordinate behavior. HiddenFieldLocationRulesProvides some assistance in determining where to place a hidden field based on standard (X)HTML elements. Html5SupportService related to Tapestry's support of HTML5 features. LinkCreationHubA service that allows listeners to be registered to learn about
LinkCreationListener2 LocalizationSetterSets the thread's locale given a desired locale. MarkupRendererAn object which will perform rendering of a page (or portion of a page). MarkupRendererFilterFilter interface for
MarkupRenderer, which allows for code to execute before and/or after the main rendering process.
MetaDataLocatorUsed to lookup meta data concerning a particular component. MethodInvocationResultCaptures the result of invoking a method. NullFieldStrategySourceA source for
NullFieldStrategyinstances based on a logical name.
ObjectRenderer<T>A strategy interface used for converting an object into markup that describes that object. PageDocumentGeneratorInterface used to programatically render a page, forming a
Documentwhich can then be manipulated or streamed to a PrintWriter.
PageRenderLinkSourceA service that allows other services to create page render links. PageRenderRequestFilterFilter interface for
PageRenderRequestHandler, which allows extra behaviors to be injected into the processing of a page render request.
PageRenderRequestHandlerHandles a invocation related to rendering out a pages complete content. PartialMarkupRendererDefines an Ajax-oriented partial page render, wherein a render of a portion of a page occurs, and the content is stored into a key ("content") of a
JSONObject, which is sent to the client side as the final response.
PartialMarkupRendererFilterA filter (the main interface being
PartialMarkupRenderer) applied when performing a partial page render as part of an Ajax-oriented request.
PartialTemplateRendererService that provides methods that render
<t:block>in the template), component instances and
RenderCommands to a
org.apache.tapestry5.dom.Documentin a programatic way.
PathConstructorCentral location for logic related to building client-side paths, taking into account the context path (if any), and the
PersistentFieldBundleEncapsulates persisted property information for an entire page. PersistentFieldChangeRepresents a previously stored change to a persistent field, within the context of a particular page of the application. PersistentFieldStrategyDefines how changes to fields (within components, within pages) may have their values persisted between requests. PersistentLocaleManages the persistent locale stored in the browser (inside the URL). PropertyEditContextDefines a context for editing a property of a bean via
PropertyOutputContextProvides context information needed when displaying a value. RequestExceptionHandlerService invoked when an uncaught exception occurs. ResourceDigestGenerator Deprecated.Deprecated in 5.4 with no replacement; see release notes about classpath assets moving to /META-INF/assets/, and content checksums inside asset URLs ResponseRendererPublic facade around internal services related to rendering a markup response. SelectModelFactoryUsed to create an
ExceptionDisplayto characterize each stack frame that is presented.
TranslatorAlternatesSourceThis service is used by
Translatoralternates: translators that are used when specified explicitly by name.
TranslatorSourceA source for
Translators, either by name or by property type.
URLEncoderService used to encode or decode strings that are placed into URLs. ValidationConstraintGeneratorInvoked to generate a list of validation constraint strings for a property. ValidationDecoratorFactory Deprecated.Deprecated in 5.4 with no replacement, as
ValidationDecoratoris being phased out.
ValueEncoderFactory<V>A source for
ValueEncoderinstances of a given type.
ValueEncoderSourceA source for value encoders based on a property type. ValueLabelProvider<V>An object capable of providing a user-presentable label from a value.
Class Summary Class Description ApplicationStateContributionA contribution to the configuration of the
ApplicationStateManager, identifying the strategy and creator for a particular Session State Object (SSO), identified by the SSO's class.
AssetAlias Deprecated.Deprecated in 5.4 (see notes in
BeanBlockContributionA contribution to the
BeanBlockSourceservice, defining a page name and block id (within the page) that can edit or display a particular type of property.
ComponentEventRequestParametersEncapsulates all the information that may be provided in a component event request URL. ComponentLibraryInfoClass that encapsulates information about a component library, going beyond what a library mapping provides. ComponentLibraryInfo.DefaultSourceUrlResolverDefault
DefaultObjectRendererDefault object renderer as a catch all for class
DelegatingRequestClass that wraps an Request, delegating all its methods. DisplayBlockContributionContribution to
BeanBlockSourceidentifying a block that is used to display a property.
BeanBlockSourceidentifying a block that is used to edit a property.
HttpErrorAn event handler method may return an instance of this class to send an error response to the client. HttpStatusAn event handler method may return an instance of this class to send an specific HTTP status code to the client. InitializeActivePageNameFilter contributed into the
ComponentRequestHandlerpipeline to set the
LibraryMappingUsed to configure the
ComponentClassResolver, to allow it to map library names to library root packages (the application namespace is a special case of this).
PageRenderRequestFilterto define the logical page name and activation context for the request.
StackTraceElementClassConstantsCSS classes, from the default CSS stylesheet, used with
StreamPageContentAn event handler method may return an instance of this class to trigger the rendering of a particular page without causing a redirect to that page; the rendering takes place as part of the original component event request, thus forming the opposite of Tapestry's normal redirect-after-event behavior. TransformConstantsConstants used by implementations
TransformUtilsSupport code for generating code (used when transforming component classes).
Enum Summary Enum Description RelativeElementPositionUsed by
HiddenFieldLocationRulesto identify where a hidden field may be placed relative to a particular element.
Exception Summary Exception Description AssetNotFoundExceptionClass that represents the exception of an asset not being found.
Annotation Types Summary Annotation Type Description AjaxMarker annotation for services related to processing an Ajax request (rather than a traditional request). AssetRequestDispatcherMarker annotation used to specifically identify the
Dispatcherused to dispatch asset requests (so that
AssetRequestHandlers can be contributed).
ClasspathProviderA marker annotation used to select the correct
ComponentMessagesMarker annotation used to inject the correct
InvalidationEventHubservice responsible for validations when component message catalog (i.e., ".properties") files change.
ComponentTemplatesMarker annotation used to inject the correct
InvalidationEventHubservice responsible for validations when component template files change.
ContextProviderMarker annotation to select the correct
CoreMarker annotation for services that are provided by the Tapestry core module. TraditionalMarker annotation for a service that should be used for traditional page oriented requests, as opposed to Ajax requests (that send ad-hoc or partial page markup responses.