Page edited by Bob Harner

Comment: Added the new 5.3 components

Changes (12)

Full Content

Tapestry includes a number of built-in components to simplify web development. In addition, there are several other open source component sets available. Of course, Tapestry makes it trivially easy to create your own custom components, so if you don't see what you need, just develop them yourself.

Related Articles
Page: Component Classes
Page: Templating and Markup FAQ
Page: Component Parameters

Contents

Core Components

AJAX-specific Components
Bean Displaying & Editing
Conditional and Looping Components
Form Components
Grids, Tables and Trees
Links and Buttons
Output and Messages
Miscellaneous

Core Mixins
Core Pages
Base Components
Other Component Libraries

Core Components

The core components are found in the org.apache.tapestry5.corelib.components package.

AJAX-specific Components

Main Article: Ajax and Zones

AjaxFormLoop	a special form of the Loop component that adds Ajax support to handle adding new rows and removing existing rows dynamically.
AddRowLink, RemoveRowLink	used inside an AjaxFormLoop component to spur the addition or removal of a row.
ProgressiveDisplay	used to implement the progressive enhancement web design strategy; the component renders itself with a simplified initial content (i.e., "loading ...") and an Ajax request then supplies the component's true body.
Zone	a region of a page marked for dynamic updating via Ajax or other client-side effects.

Bean Displaying & Editing

Main Article: BeanEditForm Guide

BeanDisplay	displays the properties of a bean, using an underlying BeanModel, as a dl element with dt/dd pairs.
BeanEditForm	creates an entire form for editing the properties of a particular bean
BeanEditor	the central component of BeanEditForm, this generates a user interface for editing the properties of a bean
PropertyDisplay	outputs a single property value. Overrides for individual properties come from block parameters whose name matches the . This component used by the BeanDisplay component.
PropertyEditor	Used to edit a single property of a bean. This is used primarily by BeanEditForm.

Conditional and Looping Components

If	conditionally renders its body. May render its tag and any informal parameters
Case	Not really a component, but a technique to emulate a "case" statement using a delegate
Loop	loops over a number of items (provided by its source parameter), rendering its body for each one]
Unless	inverse of the If component, renders its body if the condition is false.
Delegate	does not do any rendering of its own, but will delegate to some other object that can do rendering

Form Components

Checkbox	renders a standard <input type="checkbox"> element
Checklist	renders a vertical list of <input type="checkbox"> elements
DateField	collect a provided date from the user using a client-side _javascript_ calendar
Form	an HTML form, which will enclose other components to render out the various types of fields.
FormFragment	a portion of a Form that may be selectively displayed
FormInjector	adds new content to an existing Form
Hidden	used to record a page property as a value into the form
Label	generates a label element for a particular field
Palette	a multiple selection component. Generates a UI consisting of two select elements configured for multiple selection; the one on the left is the list of "available" elements, the one on the right is "selected".
PasswordField	a version of TextField, but rendered out as an <input type="password"> element.
Radio	a radio button (i.e., <input type="radio">). Radio buttons must operate within a RadioContainer (normally, the RadioGroup component).
RadioGroup	groups together a set of radio components that all affect the same property
Select	renders a <select> element for selecting an item from a list of values
SubmitNotifier	a non visual component used to provide notifications to its container during a form submission
TextArea	renders a <textarea> element for editing multi-line text
TextField	renders an <input type="text"> element to edit single-line text

Grids, Tables and Trees

Grid	presents tabular data in a <table> element by iterating over a List or array
GridCell	part of Grid, renders the markup inside a single data cell
GridColumns	part of Grid, renders out the column headers for the grid, including links (where appropriate) to control column sorting
GridPager	generates a series of links used to jump to a particular page index within the overall data set
GridRows	renders out a series of rows within the table
Tree	A component used to render a recursive tree structure, with expandable/collapsable/selectable nodes.

Links and Buttons

ActionLink	triggers an action on the server with a subsequent full page refresh
EventLink	like ActionLink except that the event that it triggers is explicitly controlled, rather than always "action", and the event is triggered in its container
LinkSubmit	generates a client-side hyperlink that submits the enclosing form
Submit	corresponds to <input type="submit"> or <input type="image">, a client-side element that can force the enclosing form to submit
PageLink	generates a render request link to some other page in the application

Output and Messages

Alerts	Renders out an empty <div> element and provides _javascript_ initialization to make the element the container for alerts.
Dynamic	Allows a component to render itself differently at different times, by making use of an external template file.
Error	Presents validation errors of a single field. Must be enclosed by a Form component
Errors	Standard validation error presenter. Must be enclosed by a Form component. If errors are present, renders a div element around a banner message and around an unnumbered list of error messages
ExceptionDisplay	integral part of the default ExceptionReport page used to break apart and display the properties of the exception
Output	a component for formatting output. If the component is represented in the template using an element, then the element (plus any informal parameters) will be output around the formatted value.
OutputRaw	output raw markup to the client. Unlike an expansion, the output from OutputRaw is unfiltered, with any special characters or entities left exactly as is.
TextOutput	outputs paragraph oriented text, typically collected via a TextArea component. The TextArea is split into lines, and each line it output inside its own p element.

Miscellaneous

Any	renders an arbitrary element including informal parameters
Doctype	overrides the DOCTYPE of the rendered document (via Document.dtd(String, String, String) which can be useful when different component templates that render to the same document disagree about what the correct DOCTYPE is.
RenderObject	renders out an object using the ObjectRenderer service. Used primarily on the ExceptionReport page
Trigger	triggers an arbitrary event during rendering. This is often useful to add _javascript_ to a page or a component (via calls to the _javascript_Support environmental).

Core Mixins

Main Article: Component Mixins

Mixins allow you to add behaviors to existing components. The core mixins are found in the org.apache.tapestry5.corelib.mixins package.

Tapestry includes the following mixins out-of-the-box.

Autocomplete	modifies a text field to provide for auto-completion of text using values retrieved from the server as the user types. See instructions.
DiscardBody	discards a component's body. Returns false from the BeforeRenderBody phase, which prevents the rendering of the body.
NotEmpty	attaches to an element that renders an element. At the end of the render, if the element is empty, then a non-breaking space ( ) is injected into the element.
RenderClientId	forces a client element to render its client id by ensuring that "getClientId" is called.
RenderDisabled	renders an "disabled" attribute if the containing is disabled
RenderInformals	renders out all informal parameters, at the end of the BeginRender phase. This mixin can be used with components that render a single tag inside the BeginRender phase.
RenderNotification	triggers event notifications to identify when it enters the BeginRender and AfterRender render phases
TriggerFragment	a mixin that can be applied to a Checkbox or Radio component that will link the input field and a FormFragment, making the field control the client-side visibility of the FormFragment

Core Pages

Tapestry provides several special pages that provide status information. These are found in the [org.apache.tapestry5.corelib.pages|http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/corelib/pages/package-summary.html package.

ExceptionReport	responsible for reporting runtime exceptions. This page is quite verbose and is usually overridden in a production application.
PropertyDisplayBlocks	contains blocks for displaying basic property types; the blocks are contributed to the BeanBlockSource service.
PropertyEditBlocks	a page that exists to contain blocks used to edit different types of properties. The blocks on this page are contributed into the BeanBlockSource service configuration.
ServiceStatus	page used to see the status of all services defined by the Registry.

Base Components

The base components, in the org.apache.tapestry5.corelib.base package, are intended to be extended by other components rather than used directly in templates.

AbstractComponentEventLink	base class for link-generating components that are based on a component event request. Such events have an event context and may also update a Zone.
AbstractConditional	base class for If and Unless. Will render its body or the block from its else parameter. If it renders anything and it has an element name, then it renders the element and its informal parameters.
AbstractField	provides initialization of the clientId and elementName properties. In addition, adds the RenderInformals, RenderDisabled and DiscardBody mixins.
AbstractLink	provides base utilities for classes that generate clickable links.
AbstractPropertyOutput	base class for components that output a property value using a PropertyModel
AbstractTextField	abstract class for a variety of components that render some variation of a text field. Most of the hooks for user input validation are in this class
BaseMessages	base class for components that output messages

Other Component Libraries

See Modules

Change Notification Preferences

View Online | View Changes

[CONF] Apache Tapestry > Component Reference

Component Reference