Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
5.3.0thttp://tapestry.apache.org/schema/tapestry_5_1_0.xsdbasemessagesorg.apache.tapestry5.corelib.base.BaseMessagesJSPRenders out an object using the org.apache.tapestry5.services.ObjectRenderer service. Used primarily on the org.apache.tapestry5.corelib.pages.ExceptionReport page.
This is focused on objects that have a specific org.apache.tapestry5.services.ObjectRenderer strategy. The org.apache.tapestry5.corelib.components.BeanDisplay component is
used for displaying the contents of arbitrary objects in terms of a series of property names and values.renderobjectorg.apache.tapestry5.corelib.components.RenderObjectJSPNo description found <br/> Allow null : true
<br/> Default prefix : prop
objecttruejava.lang.ObjectUsed to output raw markup to the client. Unlike, say, an expansion, the output from OutputRaw is unfiltered, with any
special characters or entities left exactly as is. This is used in situations where the markup is provided
externally, rather than constructed within Tapestry.outputraworg.apache.tapestry5.corelib.components.OutputRawJSPThe value to to render. If unbound, and a property of the container matches the component's id, then that
property will be the source of the value. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.StringTextField component corresponds to input type="text" element. The value parameter will be editted. TextField
is generally used with string values, but other values are acceptible, as long as they can be freely converted back
and forth to strings.
Includes the size attribute, if a org.apache.tapestry5.beaneditor.Width annotation is present on
the property bound to the value parameter.textfieldorg.apache.tapestry5.corelib.components.TextFieldJSPIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringDefines how nulls on the server side, or sent from the client side, are treated. The selected strategy may
replace the nulls with some other value. The default strategy leaves nulls alone. Another built-in strategy,
zero, replaces nulls with the value 0. <br/> Allow null : true
<br/> Default prefix : nullfieldstrategy
nullsfalseorg.apache.tapestry5.NullFieldStrategyProvider of annotations used for some defaults. Annotation are usually provided in terms of the value parameter
(i.e., from the getter and/or setter bound to the value parameter). <br/> Allow null : true
<br/> Default prefix : prop
annotationProviderfalseorg.apache.tapestry5.ioc.AnnotationProviderThe object which will perform translation between server-side and client-side representations. If not specified,
a value will usually be generated based on the type of the value parameter. <br/> Allow null : false
<br/> Default prefix : translate
translatetrueorg.apache.tapestry5.FieldTranslatorThe value to be read and updated. This is not necessarily a string, a translator may be provided to convert
between client side and server side representations. If not bound, a default binding is made to a property of the
container matching the component's id. If no such property exists, then you will see a runtime exception due to
the unbound value parameter. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectThe object that will perform input validation (which occurs after translation). The validate binding prefix is
generally used to provide this object in a declarative fashion. <br/> Allow null : true
<br/> Default prefix : validate
validatefalseorg.apache.tapestry5.FieldValidatorGenerates a series of links used to jump to a particular page index within the overall data set.gridpagerorg.apache.tapestry5.corelib.components.GridPagerJSPIf not null, then each link is output as a link to update the specified zone. <br/> Allow null : true
<br/> Default prefix : prop
zonefalsejava.lang.StringThe number of rows displayed per page. <br/> Allow null : true
<br/> Default prefix : prop
rowsPerPagetrueintNumber of pages before and after the current page in the range. The pager always displays links for 2 * range + 1
pages, unless that's more than the total number of available pages. <br/> Allow null : true
<br/> Default prefix : prop
rangefalseintThe current page number (indexed from 1). <br/> Allow null : true
<br/> Default prefix : prop
currentPagetrueintThe source of the data displayed by the grid (this is used to determine how many rows are available, which in turn determines the page count). <br/> Allow null : true
<br/> Default prefix : prop
sourcetrueorg.apache.tapestry5.grid.GridDataSourceA non visual component used to provide notifications to its container during a form submission. Records actions into
the form on org.apache.tapestry5.annotations.BeginRender and org.apache.tapestry5.annotations.AfterRender
that (during the form submission) triggers "BeginSubmit" and "AfterSubmit" events. The container can receive these
events to perform setup before a group of components process their submission, and perform cleanup afterwards.submitnotifierorg.apache.tapestry5.corelib.components.SubmitNotifierJSPUsed to display the properties of a bean, using an underlying org.apache.tapestry5.beaneditor.BeanModel. The output definition list: a
dl element containing a series of dt/dd pairs. The property label is used as the dt
and the property value (formatted as per the datatype) is the dd. Only properties that have a known data type
are displayed.
The property id is used as the class attribute of the dt and dd element, allowing CSS customization
per property. This does not occur when lean is bound to true.
The outer dl element has the CSS class "t-beandisplay".beandisplayorg.apache.tapestry5.corelib.components.BeanDisplayJSPWhere to search for local overrides of property display blocks as block parameters. Further, the container of the
overrides is used as the source for overridden validation messages. This is normally the component itself, but
when the component is used within a BeanEditForm, it will be the BeanEditForm's block parameter that will be
searched. <br/> Allow null : true
<br/> Default prefix : prop
overridesfalseorg.apache.tapestry5.ComponentResourcesA comma-separated list of property names to be added to the org.apache.tapestry5.beaneditor.BeanModel
(only used
when a default model is created automatically). <br/> Allow null : true
<br/> Default prefix : literal
addfalsejava.lang.StringA comma-separated list of property names indicating the order in which the properties should be presented. The
names are case insensitive. Any properties not indicated in the list will be appended to the end of the display
orde. Only used
when a default model is created automatically. <br/> Allow null : true
<br/> Default prefix : literal
reorderfalsejava.lang.StringA comma-separated list of property names to be retained from the
org.apache.tapestry5.beaneditor.BeanModel (only used
when a default model is created automatically).
Only these properties will be retained, and the properties will also be reordered. The names are
case-insensitive. <br/> Allow null : true
<br/> Default prefix : literal
includefalsejava.lang.StringThe object to be rendered; if not explicitly bound, a default binding to a property whose name matches this
component's id will be used. <br/> Allow null : false
<br/> Default prefix : prop
objecttruejava.lang.ObjectA comma-separated list of property names to be removed from the org.apache.tapestry5.beaneditor.BeanModel
(only used
when a default model is created automatically).
The names are case-insensitive. <br/> Allow null : true
<br/> Default prefix : literal
excludefalsejava.lang.StringThe model that identifies the parameters to be edited, their order, and every other aspect. If not specified, a
default bean model will be created from the type of the object bound to the object parameter. The add, include,
exclude and reorder
parameters are only applied to a default model, not an explicitly provided one. <br/> Allow null : true
<br/> Default prefix : prop
modelfalseorg.apache.tapestry5.beaneditor.BeanModelIf true, then the CSS class attribute on the dt and dd elements will be ommitted. <br/> Allow null : true
<br/> Default prefix : prop
leanfalsebooleanTriggers an arbitrary event during rendering. This is often useful to add JavaScript
to a page or a component (via calls to the org.apache.tapestry5.services.javascript.JavaScriptSupport environmental).triggerorg.apache.tapestry5.corelib.components.TriggerJSPNo description found <br/> Allow null : true
<br/> Default prefix : literal
eventfalsejava.lang.StringUsed to edit a single property of a bean. This is used primarily by org.apache.tapestry5.corelib.components.BeanEditForm. Unlike BeanEditForm, the
object to be edited must already exist and the must be passed in explicitly.propertyeditororg.apache.tapestry5.corelib.components.PropertyEditorJSPSource for property editor blocks. This defaults to the default implementation of org.apache.tapestry5.services.BeanBlockSource. <br/> Allow null : false
<br/> Default prefix : prop
beanBlockSourcetrueorg.apache.tapestry5.services.BeanBlockSourceWhere to search for local overrides of property editing blocks as block parameters. This is normally the
containing component of the PropertyEditor, but when the component is used within a BeanEditor, it will be the
BeanEditor's block parameters that will be searched. <br/> Allow null : false
<br/> Default prefix : prop
overridesfalseorg.apache.tapestry5.PropertyOverridesThe model that identifies the parameters to be edited, their order, and every other aspect. <br/> Allow null : false
<br/> Default prefix : prop
modeltrueorg.apache.tapestry5.beaneditor.BeanModelThe object to be edited by the BeanEditor. This will be read when the component renders and updated when the form
for the component is submitted. Typically, the container will listen for a "prepare" event, in order to ensure
that a non-null value is ready to be read or updated. <br/> Allow null : false
<br/> Default prefix : prop
objecttruejava.lang.ObjectIdentifies the property to be edited by the editor. <br/> Allow null : true
<br/> Default prefix : prop
propertytruejava.lang.StringA Checkbox component is simply a input type="checkbox".checkboxorg.apache.tapestry5.corelib.components.CheckboxJSPIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringThe value to be read or updated. If not bound, the Checkbox will attempt to edit a property of its container
whose name matches the component's id. <br/> Allow null : true
<br/> Default prefix : prop
valuetruebooleanCorresponds to input type="submit" or input type="image", a client-side element that can force the
enclosing form to submit. The submit responsible for the form submission will post a notification that allows the
application to know that it was the responsible entity. The notification is named "selected" and has no context.submitorg.apache.tapestry5.corelib.components.SubmitJSPDefines the mode, or client-side behavior, for the submit. The default is org.apache.tapestry5.corelib.SubmitMode#NORMAL; clicking the
button submits the form with validation. org.apache.tapestry5.corelib.SubmitMode#CANCEL indicates the client-side validation
should be omitted (though server-side validation still occurs). <br/> Allow null : false
<br/> Default prefix : literal
modefalseorg.apache.tapestry5.corelib.SubmitModeIf provided, the component renders an input tag with type "image". Otherwise "submit". <br/> Allow null : true
<br/> Default prefix : asset
imagefalseorg.apache.tapestry5.AssetThe list of values that will be made available to event handler method of this component when the form is
submitted. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;The name of the event that will be triggered if this component is the cause of the form submission. The default
is org.apache.tapestry5.EventConstants#SELECTED. <br/> Allow null : false
<br/> Default prefix : literal
eventfalsejava.lang.StringIf true (the default), then any notification sent by the component will be deferred until the end of the form
submission (this is usually desirable). In general, this can be left as the default except when the Submit
component is rendering inside a org.apache.tapestry5.corelib.components.Loop, in which case defer should be bound to false (otherwise, the
event context will always be the final value of the Loop). <br/> Allow null : true
<br/> Default prefix : prop
deferfalsebooleanIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanA 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.outputorg.apache.tapestry5.corelib.components.OutputJSPIf true, the default, then output is filtered, escaping any reserved characters. If false, the output is written
raw. <br/> Allow null : true
<br/> Default prefix : prop
filterfalsebooleanThe format to be applied to the object. <br/> Allow null : false
<br/> Default prefix : prop
formattruejava.text.FormatThe element name, derived from the component template. This can even be overridden manually if desired (for
example, to sometimes render a surrounding element and other times not). <br/> Allow null : true
<br/> Default prefix : prop
elementNamefalsejava.lang.StringThe value to be output (before formatting). If the formatted value is blank, no output is produced. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectA component used to collect a provided date from the user using a client-side JavaScript calendar. Non-JavaScript
clients can simply type into a text field.
One wierd aspect here is that, because client-side JavaScript formatting and parsing is so limited, we (currently)
use Ajax to send the user's input to the server for parsing (before raising the popup) and formatting (after closing
the popup). Weird and inefficient, but easier than writing client-side JavaScript for that purpose.
Tapestry's DateField component is a wrapper around WebFX DatePicker.datefieldorg.apache.tapestry5.corelib.components.DateFieldJSPUsed to override the component's message catalog. <br/> Allow null : true
<br/> Default prefix : prop
messagesfalseorg.apache.tapestry5.ioc.MessagesIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringThe object that will perform input validation (which occurs after translation). The translate binding prefix is
generally used to provide this object in a declarative fashion. <br/> Allow null : true
<br/> Default prefix : validate
validatefalseorg.apache.tapestry5.FieldValidatorNo description found <br/> Allow null : true
<br/> Default prefix : asset
iconfalseorg.apache.tapestry5.AssetThe value parameter of a DateField must be a java.util.Date. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.util.DateThe format used to format and parse dates. This is typically specified as a string which is coerced to a
DateFormat. You should be aware that using a date format with a two digit year is problematic: Java (not
Tapestry) may get confused about the century. <br/> Allow null : false
<br/> Default prefix : literal
formattruejava.text.DateFormatIf true, then the text field will be hidden, and only the icon for the date picker will be visible. The default
is false. <br/> Allow null : true
<br/> Default prefix : prop
hideTextFieldfalsebooleanA special form of the org.apache.tapestry5.corelib.components.Loop component that adds Ajax support to
handle adding new rows and removing existing rows dynamically. Expects that the values being iterated over are
entities that can be identified via a org.apache.tapestry5.ValueEncoder.
Works with org.apache.tapestry5.corelib.components.AddRowLink and
org.apache.tapestry5.corelib.components.RemoveRowLink components.
The addRow event will receive the context specified by the context parameter.
The removeRow event will receive the client-side value for the row being iterated.ajaxformlooporg.apache.tapestry5.corelib.components.AjaxFormLoopJSPThe context for the form loop (optional parameter). This list of values will be converted into strings and
included in the URI. The strings will be coerced back to whatever their values are and made available to event
handler methods. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;A block to render after the loop as the body of the org.apache.tapestry5.corelib.components.FormInjector.
This typically contains a org.apache.tapestry5.corelib.components.AddRowLink. <br/> Allow null : true
<br/> Default prefix : literal
addRowfalseorg.apache.tapestry5.BlockThe objects to iterate over (passed to the internal Loop component). <br/> Allow null : true
<br/> Default prefix : prop
sourcetruejava.lang.IterableName of a function on the client-side Tapestry.ElementEffect object that is invoked to make added content
visible. This is used with the org.apache.tapestry5.corelib.components.FormInjector component, when adding a new row to the loop. Leaving as
null uses the default function, "highlight". <br/> Allow null : true
<br/> Default prefix : literal
showfalsejava.lang.StringThe element to render for each iteration of the loop. The default comes from the template, or "div" if the
template did not specify an element. <br/> Allow null : true
<br/> Default prefix : literal
elementfalsejava.lang.StringRequired parameter used to convert server-side objects (provided from the source) into client-side ids and back.
A default encoder may be calculated from the type of property bound to the value parameter. <br/> Allow null : false
<br/> Default prefix : prop
encodertrueorg.apache.tapestry5.ValueEncoderThe current value from the source. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectAn HTML form, which will enclose other components to render out the various
types of fields.
A Form emits many notification events. When it renders, it fires a
org.apache.tapestry5.EventConstants#PREPARE_FOR_RENDER notification, followed by a
org.apache.tapestry5.EventConstants#PREPARE notification.
When the form is submitted, the component emits several notifications: first a
org.apache.tapestry5.EventConstants#PREPARE_FOR_SUBMIT, then a org.apache.tapestry5.EventConstants#PREPARE: these allow the page to update its
state as necessary to prepare for the form submission, then (after components enclosed by the form have operated), a
org.apache.tapestry5.EventConstants#VALIDATE event is emitted, to allow for cross-form validation. After that, either a
org.apache.tapestry5.EventConstants#SUCCESS OR org.apache.tapestry5.EventConstants#FAILURE event (depending on whether the
org.apache.tapestry5.ValidationTracker has recorded any errors). Lastly, a org.apache.tapestry5.EventConstants#SUBMIT event, for any listeners
that care only about form submission, regardless of success or failure.
For all of these notifications, the event context is derived from the context parameter. This
context is encoded into the form's action URI (the parameter is not read when the form is submitted, instead the
values encoded into the form are used).formorg.apache.tapestry5.corelib.components.FormJSPIf true (the default), then the JavaScript will be added to position the
cursor into the form. The field to
receive focus is the first rendered field that is in error, or required,
or present (in that order of priority). <br/> Allow null : true
<br/> Default prefix : prop
autofocusfalsebooleanIf true, then the Form's action will be secure (using an absolute URL with the HTTPs scheme) regardless
of whether the containing page itself is secure or not. This parameter does nothing
when (which is often
the case in development mode). This only affects how the Form's action attribute is rendered, there is
not (currently) a check that the form is actually submitted securely. <br/> Allow null : true
<br/> Default prefix : prop
securefalsebooleanThe object which will record user input and validation errors. The object
must be persistent between requests
(since the form submission and validation occurs in a component event
request and the subsequent render occurs
in a render request). The default is a persistent property of the Form
component and this is sufficient for
nearly all purposes (except when a Form is rendered inside a loop). <br/> Allow null : true
<br/> Default prefix : prop
trackerfalseorg.apache.tapestry5.ValidationTrackerBinding the zone parameter will cause the form submission to be handled
as an Ajax request that updates the
indicated zone. Often a Form will update the same zone that contains it. <br/> Allow null : true
<br/> Default prefix : literal
zonefalsejava.lang.StringPrefix value used when searching for validation messages and constraints.
The default is the Form component's
id. This is overridden by org.apache.tapestry5.corelib.components.BeanEditForm. <br/> Allow null : true
<br/> Default prefix : prop
validationIdfalsejava.lang.StringThe context for the link (optional parameter). This list of values will
be converted into strings and included in
the URI. The strings will be coerced back to whatever their values are
and made available to event handler
methods. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;Object to validate during the form submission process. The default is the Form component's container.
This parameter should only be used in combination with the Bean Validation Library. <br/> Allow null : true
<br/> Default prefix : prop
validatefalsejava.lang.ObjectControls when client validation occurs on the client, if at all. Defaults to org.apache.tapestry5.corelib.ClientValidation#BLUR. <br/> Allow null : false
<br/> Default prefix : literal
clientValidationfalseorg.apache.tapestry5.corelib.ClientValidationOutputs paragraph oriented text, typically collected via a org.apache.tapestry5.corelib.components.TextArea
component. The TextArea is split into lines, and each line it output inside its own p element.textoutputorg.apache.tapestry5.corelib.components.TextOutputJSPNo description found <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.StringBasic looping class; loops over a number of items (provided by its source parameter), rendering its body for each
one. When a Loop is inside a org.apache.tapestry5.corelib.components.Form, it records quite a bit of state into the Form to coordinate access
to the same (or equivalent) objects during the form submission as during the render. This is controlled by
the formState parameter (of type org.apache.tapestry5.corelib.LoopFormState) and can be 'none' (nothing stored into the form), 'values'
(which stores the individual values looped over, or via a org.apache.tapestry5.ValueEncoder, just the value's ids), and
'iteration' (which just stores indexes to the values within the source parameter, which means that the source
parameter will be accessed during the form submission).
For a non-volatile Loop inside the form, the Loop stores a series of commands that start and end
, and stores state for each value in the source parameter (either as full objects
when the encoder parameter is not bound, or as client-side objects when there is an encoder). For a Loop that doesn't
need to be aware of the enclosing Form (if any), the formState parameter should be bound to 'none'.
When the Loop is used inside a Form, it will generate an
org.apache.tapestry5.EventConstants#SYNCHRONIZE_VALUES event to inform its container what values were
submitted and in what order; this can allow the container to pre-load the values in a single batch form external
storage, if that is appropriate.looporg.apache.tapestry5.corelib.components.LoopJSPOptional value converter; if provided (or defaulted) and inside a form and not volatile, then each iterated value
is converted and stored into the form. A default for this is calculated from the type of the property bound to
the value parameter. <br/> Allow null : true
<br/> Default prefix : prop
encoderfalseorg.apache.tapestry5.ValueEncoderThe current value, set before the component renders its body. <br/> Allow null : true
<br/> Default prefix : prop
valuefalsejava.lang.ObjectThe index into the source items. <br/> Allow null : true
<br/> Default prefix : prop
indexfalseintDefines the collection of values for the loop to iterate over. If not specified, defaults to a property of the
container whose name matches the Loop cmponent's id. <br/> Allow null : true
<br/> Default prefix : prop
sourcetruejava.lang.IterableThe element to render. If not null, then the loop will render the indicated element around its body (on each pass
through the loop). The default is derived from the component template. <br/> Allow null : true
<br/> Default prefix : literal
elementfalsejava.lang.StringA Block to render instead of the loop when the source is empty. The default is to render nothing. <br/> Allow null : true
<br/> Default prefix : literal
emptyfalseorg.apache.tapestry5.BlockControls what information, if any, is encoded into an enclosing Form. The default value
is org.apache.tapestry5.corelib.LoopFormState#VALUES. This parameter
is only used if the component is enclosed by a Form. <br/> Allow null : false
<br/> Default prefix : literal
formStatefalseorg.apache.tapestry5.corelib.LoopFormStateStandard validation error presenter. Must be enclosed by a
org.apache.tapestry5.corelib.components.Form component. If errors are present, renders a
div element around a banner message and around an unnumbered list of
error messages. Renders nothing if the org.apache.tapestry5.ValidationTracker shows no
errors.errorsorg.apache.tapestry5.corelib.components.ErrorsJSPThe banner message displayed above the errors. The default value is "You must correct the
following errors before
you may continue.". <br/> Allow null : true
<br/> Default prefix : prop
bannerfalsejava.lang.StringThe CSS class for the div element rendered by the component. The default value is "t-error". <br/> Allow null : true
<br/> Default prefix : prop
classfalsejava.lang.StringA close relative of the org.apache.tapestry5.corelib.components.If component that inverts the meaning of its
test. This is easier than an If component with the negate parameter set to true.unlessorg.apache.tapestry5.corelib.components.UnlessJSPAn alternate org.apache.tapestry5.Block to render if org.apache.tapestry5.corelib.base.AbstractConditional#test() is false. The default, null, means
render nothing in that situation. <br/> Allow null : true
<br/> Default prefix : literal
elsefalseorg.apache.tapestry5.BlockIf true, then the body of the If component is rendered. If false, the body is omitted. <br/> Allow null : true
<br/> Default prefix : prop
testtruebooleanRenders out a series of rows within the table.
Inside a org.apache.tapestry5.corelib.components.Form, a series of row index numbers are stored into the form ( ). This is not ideal ... in a situation where the data set can shift between the
form render and the form submission, this can cause unexpected results, including applying changes to the wrong
objects.gridrowsorg.apache.tapestry5.corelib.components.GridRowsJSPChanges how state is recorded into the form to store the for each row (rather than the index), and restore the from the client value. <br/> Allow null : true
<br/> Default prefix : prop
encoderfalseorg.apache.tapestry5.ValueEncoderOptional output parameter (only set during rendering) that identifies the current row index. This is the index on
the page (i.e., always numbered from zero) as opposed to the row index inside the org.apache.tapestry5.grid.GridDataSource. <br/> Allow null : true
<br/> Default prefix : prop
rowIndexfalseintIf true, then the CSS class on each TD cell will be omitted, which can reduce the amount of output from
the component overall by a considerable amount. Leave this as false, the default, when you are leveraging the CSS
to customize the look and feel of particular columns. <br/> Allow null : true
<br/> Default prefix : prop
leanfalsebooleanParameter used to set the CSS class for each row (each tr element) within the tbody). This is not
cached, so it will be recomputed for each row. <br/> Allow null : true
<br/> Default prefix : prop
rowClassfalsejava.lang.StringNumber of rows displayed on each page. Long result sets are split across multiple pages. <br/> Allow null : true
<br/> Default prefix : prop
rowsPerPagetrueintOptional output parameter that stores the current column index. <br/> Allow null : true
<br/> Default prefix : prop
columnIndexfalseintThe current page number within the available pages (indexed from 1). <br/> Allow null : true
<br/> Default prefix : prop
currentPagetrueintThe current row being rendered, this is primarily an output parameter used to allow the Grid, and the Grid's
container, to know what object is being rendered. <br/> Allow null : true
<br/> Default prefix : prop
rowtruejava.lang.ObjectIf true and the component is enclosed by a Form, then the normal state saving logic is turned off. Defaults to
false, enabling state saving logic within Forms. This can be set to false when form elements within the Grid are
not related to the current row of the grid, or where another component (such as org.apache.tapestry5.corelib.components.Hidden) is used to maintain row state. <br/> Allow null : true
<br/> Default prefix : prop
volatilefalsebooleanObject that provides access to the bean and data models used to render the Grid. <br/> Allow null : true
<br/> Default prefix : prop
gridModelfalseorg.apache.tapestry5.grid.GridModelWhere to search for property override blocks. <br/> Allow null : false
<br/> Default prefix : prop
overridestrueorg.apache.tapestry5.PropertyOverridesA component that generates a user interface for editing the properties of a bean. This is the central component of
the org.apache.tapestry5.corelib.components.BeanEditForm, and utilizes a org.apache.tapestry5.corelib.components.PropertyEditor for much of its functionality. This component places
a org.apache.tapestry5.services.BeanEditContext into the environment.beaneditororg.apache.tapestry5.corelib.components.BeanEditorJSPWhere to search for local overrides of property editing blocks as block parameters. Further, the container of the
overrides is used as the source for overridden validation messages. This is normally the BeanEditor component
itself, but when the component is used within a BeanEditForm, it will be the BeanEditForm's resources that will
be searched. <br/> Allow null : false
<br/> Default prefix : prop
overridesfalseorg.apache.tapestry5.PropertyOverridesA comma-separated list of property names to be retained from the
org.apache.tapestry5.beaneditor.BeanModel (only used
when a default model is created automatically).
Only these properties will be retained, and the properties will also be reordered. The names are
case-insensitive. <br/> Allow null : true
<br/> Default prefix : literal
includefalsejava.lang.StringThe model that identifies the parameters to be edited, their order, and every other aspect. If not specified, a
default bean model will be created from the type of the object bound to the object parameter. The add, include,
exclude and reorder
parameters are only applied to a default model, not an explicitly provided one. <br/> Allow null : true
<br/> Default prefix : prop
modelfalseorg.apache.tapestry5.beaneditor.BeanModelA comma-separated list of property names indicating the order in which the properties should be presented. The
names are case insensitive. Any properties not indicated in the list will be appended to the end of the display
orde. Only used
when a default model is created automatically. <br/> Allow null : true
<br/> Default prefix : literal
reorderfalsejava.lang.StringA comma-separated list of property names to be added to the org.apache.tapestry5.beaneditor.BeanModel
(only used
when a default model is created automatically). <br/> Allow null : true
<br/> Default prefix : literal
addfalsejava.lang.StringA comma-separated list of property names to be removed from the org.apache.tapestry5.beaneditor.BeanModel
(only used
when a default model is created automatically).
The names are case-insensitive. <br/> Allow null : true
<br/> Default prefix : literal
excludefalsejava.lang.StringThe object to be edited by the BeanEditor. This will be read when the component renders and updated when the form
for the component is submitted. Typically, the container will listen for a "prepare" event, in order to ensure
that a non-null value is ready to be read or updated. <br/> Allow null : true
<br/> Default prefix : prop
objectfalsejava.lang.ObjectUsed inside an org.apache.tapestry5.corelib.components.AjaxFormLoop component to spur the addition of a new
row. Triggers a server-side event on the
AjaxFormLoop, which must return the newly added object, which will be rendered in the body of the AjaxFormLoop and
sent to the client web browser.addrowlinkorg.apache.tapestry5.corelib.components.AddRowLinkJSPGenerates a client-side hyperlink that submits the enclosing form. If the link is clicked in the browser, the
component will trigger an event ( by default) , just like org.apache.tapestry5.corelib.components.Submit
.linksubmitorg.apache.tapestry5.corelib.components.LinkSubmitJSPThe name of the event that will be triggered if this component is the cause of the form submission. The default
is "selected". <br/> Allow null : false
<br/> Default prefix : literal
eventfalsejava.lang.StringIf true (the default), then any notification sent by the component will be deferred until the end of the form
submission (this is usually desirable). In general, this can be left as the default except when the LinkSubmit
component is rendering inside a org.apache.tapestry5.corelib.components.Loop, in which case defer should be bound to false (otherwise, the
event context will always be the final value of the Loop). <br/> Allow null : true
<br/> Default prefix : prop
deferfalsebooleanDefines the mode, or client-side behavior, for the submit. The default is org.apache.tapestry5.corelib.SubmitMode#NORMAL; clicking the
button submits the form with validation. org.apache.tapestry5.corelib.SubmitMode#CANCEL indicates the client-side validation
should be omitted (though server-side validation still occurs). <br/> Allow null : false
<br/> Default prefix : literal
modefalseorg.apache.tapestry5.corelib.SubmitModeIf true, then no link (or accompanying JavaScript) is written (though the body still is). <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe list of values that will be made available to event handler method of this component when the form is
submitted. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;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". Elements can
be moved between the lists by clicking a button, or double clicking an option (and eventually, via drag and drop).
The items in the available list are kept ordered as per org.apache.tapestry5.SelectModel order. When items are moved from the
selected list to the available list, they items are inserted back into their proper positions.
The Palette may operate in normal or re-orderable mode, controlled by the reorder parameter.
In normal mode, the items in the selected list are kept in the same "natural" order as the items in the available
list.
In re-order mode, items moved to the selected list are simply added to the bottom of the list. In addition, two extra
buttons appear to move items up and down within the selected list.
Much of the look and feel is driven by CSS, the default Tapestry CSS is used to set up the columns, etc. By default,
the select element's widths are 200px, and it is common to override this to a specific value:
style
DIV.t-palette SELECT { width: 300px; }
/style
You'll want to ensure that both select in each column is the same width, otherwise the display will update
poorly as options are moved from one column to the other.
Option groups within the org.apache.tapestry5.SelectModel will be rendered, but are not supported by many browsers, and are not
fully handled on the client side.paletteorg.apache.tapestry5.corelib.components.PaletteJSPThe image to use for the move down button (the default is a downward pointing arrow). <br/> Allow null : true
<br/> Default prefix : prop
moveDownfalseorg.apache.tapestry5.AssetThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringNumber of rows to display. <br/> Allow null : true
<br/> Default prefix : prop
sizefalseintAllows the title text for the selected column (on the right) to be modified. As this is a Block, it can contain
conditionals and components. The default is the text "Available". <br/> Allow null : false
<br/> Default prefix : literal
selectedLabeltrueorg.apache.tapestry5.BlockThe image to use for the deselect button (the default is a left pointing arrow). <br/> Allow null : true
<br/> Default prefix : prop
deselectfalseorg.apache.tapestry5.AssetThe image to use for the select button (the default is a right pointing arrow). <br/> Allow null : true
<br/> Default prefix : prop
selectfalseorg.apache.tapestry5.AssetEncoder used to translate between server-side objects and client-side strings. <br/> Allow null : false
<br/> Default prefix : prop
encodertrueorg.apache.tapestry5.ValueEncoderThe image to use for the move up button (the default is an upward pointing arrow). <br/> Allow null : true
<br/> Default prefix : prop
moveUpfalseorg.apache.tapestry5.AssetIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanModel used to define the values and labels used when rendering. <br/> Allow null : false
<br/> Default prefix : prop
modeltrueorg.apache.tapestry5.SelectModelThe list of selected values from the org.apache.tapestry5.SelectModel. This will be updated when the form
is submitted. If the value for the parameter is null, a new list will be created, otherwise the existing list
will be cleared. If unbound, defaults to a property of the container matching this component's id. <br/> Allow null : true
<br/> Default prefix : prop
selectedtruejava.util.ListThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringAllows the title text for the available column (on the left) to be modified. As this is a Block, it can contain
conditionals and components. The default is the text "Available". <br/> Allow null : false
<br/> Default prefix : literal
availableLabeltrueorg.apache.tapestry5.BlockThe object that will perform input validation. The validate binding prefix is generally used to provide
this object in a declarative fashion. <br/> Allow null : true
<br/> Default prefix : validate
validatefalseorg.apache.tapestry5.FieldValidatorIf true, then additional buttons are provided on the client-side to allow for re-ordering of the values. <br/> Allow null : true
<br/> Default prefix : prop
reorderfalsebooleanUsed to record a page property as a value into the form. The value is
when rendered, then decoded when the form is
submitted,
and the value parameter updated.hiddenorg.apache.tapestry5.corelib.components.HiddenJSPValue encoder for the value, usually determined automatically from the type of the property bound to the value
parameter. <br/> Allow null : true
<br/> Default prefix : prop
encodertrueorg.apache.tapestry5.ValueEncoderThe value to read (when rendering) or update (when the form is submitted). <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectOutputs a single property value. Overrides for individual properties come from block parameters whose name matches
the . This component is rarely used on its own, but is a critical piece
of the org.apache.tapestry5.corelib.components.BeanDisplay component.propertydisplayorg.apache.tapestry5.corelib.components.PropertyDisplayJSPUsed to search for block parameter overrides (this is normally the enclosing Grid component's resources). <br/> Allow null : false
<br/> Default prefix : prop
overridestrueorg.apache.tapestry5.PropertyOverridesIdentifies the object being rendered. The component will extract a property from the object and render its value
(or delegate to a org.apache.tapestry5.Block that will do so). <br/> Allow null : true
<br/> Default prefix : prop
objecttruejava.lang.ObjectModel for property displayed by the cell. <br/> Allow null : false
<br/> Default prefix : prop
modeltrueorg.apache.tapestry5.beaneditor.PropertyModelSource for property display blocks. This defaults to the default implementation of org.apache.tapestry5.services.BeanBlockSource. <br/> Allow null : false
<br/> Default prefix : prop
beanBlockSourcetrueorg.apache.tapestry5.services.BeanBlockSourcePart of org.apache.tapestry5.corelib.components.Grid that renders the markup inside a single data cell. GridCell is used inside a pair of loops; the
outer loop for each row, the inner loop for each property of the row.gridcellorg.apache.tapestry5.corelib.components.GridCellJSPUsed to search for block parameter overrides (this is normally the enclosing Grid component's resources). <br/> Allow null : false
<br/> Default prefix : prop
overridestrueorg.apache.tapestry5.PropertyOverridesIdentifies the object being rendered. The component will extract a property from the object and render its value
(or delegate to a org.apache.tapestry5.Block that will do so). <br/> Allow null : true
<br/> Default prefix : prop
objecttruejava.lang.ObjectModel for property displayed by the cell. <br/> Allow null : false
<br/> Default prefix : prop
modeltrueorg.apache.tapestry5.beaneditor.PropertyModelSource for property display blocks. This defaults to the default implementation of org.apache.tapestry5.services.BeanBlockSource. <br/> Allow null : false
<br/> Default prefix : prop
beanBlockSourcetrueorg.apache.tapestry5.services.BeanBlockSourceConditionally renders its body. May render its tag and any informal parameters.iforg.apache.tapestry5.corelib.components.IfJSPAn alternate org.apache.tapestry5.Block to render if org.apache.tapestry5.corelib.base.AbstractConditional#test() is false. The default, null, means
render nothing in that situation. <br/> Allow null : true
<br/> Default prefix : literal
elsefalseorg.apache.tapestry5.BlockIf true, then the body of the If component is rendered. If false, the body is omitted. <br/> Allow null : true
<br/> Default prefix : prop
testtruebooleanOptional parameter to invert the test. If true, then the body is rendered when the test parameter is false (not
true). <br/> Allow null : true
<br/> Default prefix : prop
negatefalsebooleanUsed inside a org.apache.tapestry5.corelib.components.AjaxFormLoop to remove the current row from the loop.
This fires a server-side event (from the AjaxFormLoop component); the event context is the object to be removed. On
the client-side, the element for the row is hidden, then removed altogether.removerowlinkorg.apache.tapestry5.corelib.components.RemoveRowLinkJSPComponent that triggers an action on the server with a subsequent full page refresh.actionlinkorg.apache.tapestry5.corelib.components.ActionLinkJSPThe context for the link (optional parameter). This list of values will be converted into strings and included in
the URI. The strings will be coerced back to whatever their values are and made available to event handler
methods. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;Binding the zone parameter turns the link into a an Ajax control that causes the related zone to be updated. <br/> Allow null : true
<br/> Default prefix : literal
zonefalsejava.lang.StringIf true, then then no link element is rendered (and no informal parameters as well). The body is, however, still
rendered. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanAn anchor value to append to the generated URL (the hash separator will be added automatically). <br/> Allow null : true
<br/> Default prefix : literal
anchorfalsejava.lang.StringA close relative of org.apache.tapestry5.corelib.components.ActionLink except in two ways.
First, the event that it triggers is explicitly controlled, rather than always "action".
Second, the event is triggered in its container.
This allows slightly shorter URLs but also allows multiple components within the same container to generate identical
URLs for common actions.eventlinkorg.apache.tapestry5.corelib.components.EventLinkJSPThe context for the link (optional parameter). This list of values will be converted into strings and included in
the URI. The strings will be coerced back to whatever their values are and made available to event handler
methods. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;The name of the event to be triggered in the parent component. Defaults to the id of the component. An org.apache.tapestry5.corelib.components.ActionLink triggers an "action" event on itself, and EventLink component
triggers any arbitrary event on its container. <br/> Allow null : true
<br/> Default prefix : literal
eventfalsejava.lang.StringBinding the zone parameter turns the link into a an Ajax control that causes the related zone to be updated. <br/> Allow null : true
<br/> Default prefix : literal
zonefalsejava.lang.StringIf true, then then no link element is rendered (and no informal parameters as well). The body is, however, still
rendered. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanAn anchor value to append to the generated URL (the hash separator will be added automatically). <br/> Allow null : true
<br/> Default prefix : literal
anchorfalsejava.lang.StringSelect an item from a list of values, using an [X]HTML select element on the client side. An validation
decorations will go around the entire select element.
A core part of this component is the org.apache.tapestry5.ValueEncoder (the encoder parameter) that is used to convert between
server-side values and client-side strings. In many cases, a org.apache.tapestry5.ValueEncoder can be generated automatically from
the type of the value parameter. The org.apache.tapestry5.services.ValueEncoderSource service provides an encoder in these situations; it
can be overriden by binding the encoder parameter, or extended by contributing a org.apache.tapestry5.services.ValueEncoderFactory into the
service's configuration.selectorg.apache.tapestry5.corelib.components.SelectJSPThe value to read or update. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectThe model used to identify the option groups and options to be presented to the user. This can be generated
automatically for Enum types. <br/> Allow null : false
<br/> Default prefix : prop
modeltrueorg.apache.tapestry5.SelectModelIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringPerforms input validation on the value supplied by the user in the form submission. <br/> Allow null : true
<br/> Default prefix : validate
validatefalseorg.apache.tapestry5.FieldValidatorControls whether an additional blank option is provided. The blank option precedes all other options and is never
selected. The value for the blank option is always the empty string, the label may be the blank string; the
label is from the blankLabel parameter (and is often also the empty string). <br/> Allow null : true
<br/> Default prefix : literal
blankOptionfalseorg.apache.tapestry5.corelib.data.BlankOptionAllows a specific implementation of org.apache.tapestry5.ValueEncoder to be supplied. This is used to create client-side
string values for the different options. <br/> Allow null : true
<br/> Default prefix : prop
encoderfalseorg.apache.tapestry5.ValueEncoderThe label to use for the blank option, if rendered. If not specified, the container's message catalog is
searched for a key, id-blanklabel. <br/> Allow null : true
<br/> Default prefix : literal
blankLabelfalsejava.lang.StringBinding the zone parameter will cause any change of Select's value to be handled as an Ajax request that updates
the
indicated zone. The component will trigger the event org.apache.tapestry5.EventConstants#VALUE_CHANGED to inform its
container that Select's value has changed. <br/> Allow null : true
<br/> Default prefix : literal
zonefalsejava.lang.Stringradiogrouporg.apache.tapestry5.corelib.components.RadioGroupJSPThe object that will perform input validation. The validate binding prefix is generally used to provide this
object in a declarative fashion. <br/> Allow null : true
<br/> Default prefix : validate
validatefalseorg.apache.tapestry5.FieldValidatorThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringAllows a specific implementation of org.apache.tapestry5.ValueEncoder to be supplied. This is used to
create client-side string values for the different radio button values. <br/> Allow null : false
<br/> Default prefix : prop
encodertrueorg.apache.tapestry5.ValueEncoderThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe property read and updated by the group as a whole. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanA grid presents tabular data. It is a composite component, created in terms of several sub-components. The
sub-components are statically wired to the Grid, as it provides access to the data and other models that they need.
A Grid may operate inside a org.apache.tapestry5.corelib.components.Form. By overriding the cell renderers of
properties, the default output-only behavior can be changed to produce a complex form with individual control for
editing properties of each row. This is currently workable but less than ideal -- if the order of rows provided by
the org.apache.tapestry5.grid.GridDataSource changes between render and form submission, then there's the
possibility that data will be applied to the wrong server-side objects. In general, when using Grid and Form
together, you want to provide the Grid with a org.apache.tapestry5.ValueEncoder (via the encoder parameter).gridorg.apache.tapestry5.corelib.components.GridJSPThe source of data for the Grid to display. This will usually be a List or array but can also be an explicit
org.apache.tapestry5.grid.GridDataSource. For Lists and object arrays, a GridDataSource is created automatically as a wrapper
around the underlying List. <br/> Allow null : true
<br/> Default prefix : prop
sourcetrueorg.apache.tapestry5.grid.GridDataSourceCSS class for the table element. In addition, informal parameters to the Grid are rendered in the table
element. <br/> Allow null : true
<br/> Default prefix : literal
classfalsejava.lang.StringThe model used to handle sorting of the Grid. This is generally not specified, and the built-in model supports
only single column sorting. The sort constraints (the column that is sorted, and ascending vs. descending) is
stored as persistent fields of the Grid component. <br/> Allow null : true
<br/> Default prefix : prop
sortModelfalseorg.apache.tapestry5.grid.GridSortModelA comma-separated list of property names to be retained from the
org.apache.tapestry5.beaneditor.BeanModel.
Only these properties will be retained, and the properties will also be reordered. The names are
case-insensitive. This parameter is only used
when a default model is created automatically. <br/> Allow null : true
<br/> Default prefix : literal
includefalsejava.lang.StringA Block to render instead of the table (and pager, etc.) when the source is empty. The default is simply the text
"There is no data to display". This parameter is used to customize that message, possibly including components to
allow the user to create new objects. <br/> Allow null : true
<br/> Default prefix : literal
emptyfalseorg.apache.tapestry5.BlockA comma-separated list of property names indicating the order in which the properties should be presented. The
names are case insensitive. Any properties not indicated in the list will be appended to the end of the display
order. This parameter is only used
when a default model is created automatically. <br/> Allow null : true
<br/> Default prefix : literal
reorderfalsejava.lang.StringDefines where block and label overrides are obtained from. By default, the Grid component provides block
overrides (from its block parameters). <br/> Allow null : false
<br/> Default prefix : prop
overridesfalseorg.apache.tapestry5.PropertyOverridesA comma-separated list of property names to be removed from the org.apache.tapestry5.beaneditor.BeanModel
.
The names are case-insensitive. This parameter is only used
when a default model is created automatically. <br/> Allow null : true
<br/> Default prefix : literal
excludefalsejava.lang.StringThe model used to identify the properties to be presented and the order of presentation. The model may be
omitted, in which case a default model is generated from the first object in the data source (this implies that
the objects provided by the source are uniform). The model may be explicitly specified to override the default
behavior, say to reorder or rename columns or add additional columns. The add, include,
exclude and reorder
parameters are only applied to a default model, not an explicitly provided one. <br/> Allow null : true
<br/> Default prefix : prop
modelfalseorg.apache.tapestry5.beaneditor.BeanModelOptional output parmeter used to identify the index of the column being rendered. <br/> Allow null : true
<br/> Default prefix : prop
columnIndexfalseintDefines where the pager (used to navigate within the "pages" of results) should be displayed: "top", "bottom",
"both" or "none". <br/> Allow null : true
<br/> Default prefix : literal
pagerPositionfalseorg.apache.tapestry5.corelib.data.GridPagerPositionIf true, then the Grid will be wrapped in an element that acts like a
org.apache.tapestry5.corelib.components.Zone; all the paging and sorting links will refresh the zone,
repainting
the entire grid within it, but leaving the rest of the page (outside the zone) unchanged. <br/> Allow null : true
<br/> Default prefix : prop
inPlacefalsebooleanA comma-seperated list of property names to be added to the org.apache.tapestry5.beaneditor.BeanModel.
Cells for added columns will be blank unless a cell override is provided. This parameter is only used
when a default model is created automatically. <br/> Allow null : true
<br/> Default prefix : literal
addfalsejava.lang.StringThe number of rows of data displayed on each page. If there are more rows than will fit, the Grid will divide up
the rows into "pages" and (normally) provide a pager to allow the user to navigate within the overall result
set. <br/> Allow null : true
<br/> Default prefix : prop
rowsPerPagefalseintUsed to store the current object being rendered (for the current row). This is used when parameter blocks are
provided to override the default cell renderer for a particular column ... the components within the block can
use the property bound to the row parameter to know what they should render. <br/> Allow null : true
<br/> Default prefix : prop
rowfalsejava.lang.ObjectA version of org.apache.tapestry5.corelib.components.TextField, but rendered out as an input type="password" element. Further, the output
value for a PasswordField is always blank. When the value provided to the PasswordField is blank, it does not update
its property (care should be taken that the "required" validator not be used in that case).
Includes the size attribute, if a org.apache.tapestry5.beaneditor.Width annotation is present on
the property bound to the value parameter.passwordfieldorg.apache.tapestry5.corelib.components.PasswordFieldJSPIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringDefines how nulls on the server side, or sent from the client side, are treated. The selected strategy may
replace the nulls with some other value. The default strategy leaves nulls alone. Another built-in strategy,
zero, replaces nulls with the value 0. <br/> Allow null : true
<br/> Default prefix : nullfieldstrategy
nullsfalseorg.apache.tapestry5.NullFieldStrategyProvider of annotations used for some defaults. Annotation are usually provided in terms of the value parameter
(i.e., from the getter and/or setter bound to the value parameter). <br/> Allow null : true
<br/> Default prefix : prop
annotationProviderfalseorg.apache.tapestry5.ioc.AnnotationProviderThe object which will perform translation between server-side and client-side representations. If not specified,
a value will usually be generated based on the type of the value parameter. <br/> Allow null : false
<br/> Default prefix : translate
translatetrueorg.apache.tapestry5.FieldTranslatorThe value to be read and updated. This is not necessarily a string, a translator may be provided to convert
between client side and server side representations. If not bound, a default binding is made to a property of the
container matching the component's id. If no such property exists, then you will see a runtime exception due to
the unbound value parameter. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectThe object that will perform input validation (which occurs after translation). The validate binding prefix is
generally used to provide this object in a declarative fashion. <br/> Allow null : true
<br/> Default prefix : validate
validatefalseorg.apache.tapestry5.FieldValidatorA Zone is portion of the output page designed for easy dynamic updating via Ajax or other client-side effects. A
Zone renders out as a div element (or whatever is specified in the template) and may have content initially,
or may only get its content as a result of client side activity.
Often, Zones are initially invisible, in which case the visible parameter may be set to false (it defaults to true).
When a user clicks an org.apache.tapestry5.corelib.components.ActionLink whose zone parameter is set, the
corresponding client-side Tapestry.ZoneManager object is located. It will update the content of the Zone's
div and then invoke either a show method (if the div is not visible) or an update method (if the div is
visible). The show and update parameters are the names of functions attached to the Tapestry.ElementEffect
object. Likewise, a org.apache.tapestry5.corelib.components.Form component may also trigger an update of a
client-side Zone.
The server side event handler can return a org.apache.tapestry5.Block or a component to render as the new
content on the client side. Often, re-rendering the Zone's is useful. Multiple
client-side zones may be updated by returning a org.apache.tapestry5.ajax.MultiZoneUpdate.
Renders informal parameters, adding CSS class "t-zone" and possibly, "t-invisible".
You will often want to specify the id parameter of the Zone, in addition to it's Tapestry component id; this "locks
down" the client-side id, so the same value is used even in later partial renders of the page (essential if the Zone
is nested inside another Zone). When you specify the client-side id, it is used exactly as provided (meaning that you
are responsible for ensuring that there will not be an id conflict even in the face of multiple partial renders of
the page). Failure to provide an explicit id results in a new, and non-predictable, id being generated for each
partial render, which will often result in client-side failures to locate the element to update when the Zone is
triggered.
In some cases, you may want to know (on the server side) the client id of the zone that was updated; this is passed
as part of the Ajax request, as the org.apache.tapestry5.QueryParameterConstants#ZONE_ID parameter. An example use of this would
be to provide new content into a Zone that updates the same Zone, when the Zone's client-side id is dynamically
allocated (rather than statically defined). In most cases, however, the programmer is responsible for assigning a
specific client-side id, via the id parameter.
A Zone starts and stops a org.apache.tapestry5.services.Heartbeat when it renders (both normally, and when re-rendering).
After the client-side content is updated, a client-side event is fired on the zone's element. The constant
Tapestry.ZONE_UPDATED_EVENT can be used to listen to the event.zoneorg.apache.tapestry5.corelib.components.ZoneJSPIf bound, then the id attribute of the rendered element will be this exact value. If not bound, then a unique id
is generated for the element. <br/> Allow null : true
<br/> Default prefix : literal
idfalsejava.lang.StringIf true (the default) then the zone will render normally. If false, then the "t-invisible" CSS class is added,
which will make the zone initially invisible. <br/> Allow null : true
<br/> Default prefix : prop
visiblefalsebooleanName of a function on the client-side Tapestry.ElementEffect object that is invoked to make the Zone's
div visible before being updated. If not specified, then the basic "show" method is used. <br/> Allow null : true
<br/> Default prefix : literal
showfalsejava.lang.StringThe element name to render for the zone; this defaults to the element actually used in the template, or "div" if
no specific element was specified. <br/> Allow null : false
<br/> Default prefix : literal
elementNamefalsejava.lang.StringName of a function on the client-side Tapestry.ElementEffect object that is invoked after the Zone's content has
been updated. If not specified, then the basic "highlight" method is used, which performs a classic "yellow fade"
to indicate to the user that and update has taken place. <br/> Allow null : true
<br/> Default prefix : literal
updatefalsejava.lang.StringGenerates a label element for a particular field.
A Label will render its body, if it has one. However, in most cases it will not have a body, and will render its
as it's body. Remember, however, that it is the
field label that will be used in any error messages. The Label component allows for client- and server-side
validation error decorations.labelorg.apache.tapestry5.corelib.components.LabelJSPIf true, then the body of the label element (in the template) is ignored. This is used when a designer places a
value inside the label element for WYSIWYG purposes, but it should be replaced with a different
(probably, localized) value at runtime. The default is false, so a body will be used if present and the field's
label will only be used if the body is empty or blank. <br/> Allow null : true
<br/> Default prefix : prop
ignoreBodyfalsebooleanThe for parameter is used to identify the org.apache.tapestry5.Field linked to this label (it is named this way because it
results in the for attribute of the label element). <br/> Allow null : false
<br/> Default prefix : component
fortrueorg.apache.tapestry5.FieldA radio button (i.e., input type="radio"). Radio buttons must operate within a
org.apache.tapestry5.RadioContainer (normally, the org.apache.tapestry5.corelib.components.RadioGroup component).
If the value parameter is not bound, then the default value is a property of the container component whose name
matches the Radio component's id.radioorg.apache.tapestry5.corelib.components.RadioJSPIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe value associated with this radio button. This is used to determine which radio button will be selected when
the page is rendered, and also becomes the value assigned when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectRenders out the column headers for the grid, including links (where appropriate) to control column sorting.gridcolumnsorg.apache.tapestry5.corelib.components.GridColumnsJSPWhere to look for informal parameter Blocks used to override column headers. The default is to look for such
overrides in the GridColumns component itself, but this is usually overridden. <br/> Allow null : true
<br/> Default prefix : prop
overridesfalseorg.apache.tapestry5.PropertyOverridesIf not null, then each link is output as a link to update the specified zone. <br/> Allow null : true
<br/> Default prefix : prop
zonefalsejava.lang.StringOptional output parameter that stores the current column index. <br/> Allow null : true
<br/> Default prefix : prop
indexfalseintThe object that provides access to bean and data models, which is typically the enclosing Grid component. <br/> Allow null : true
<br/> Default prefix : prop
gridModelfalseorg.apache.tapestry5.grid.GridModelIf true, then the CSS class on each TH element will be omitted, which can reduce the amount of output
from the component overall by a considerable amount. Leave this as false, the default, when you are leveraging
the CSS to customize the look and feel of particular columns. <br/> Allow null : true
<br/> Default prefix : prop
leanfalsebooleanPresents validation errors of a single field. Must be enclosed by a
org.apache.tapestry5.corelib.components.Form component.errororg.apache.tapestry5.corelib.components.ErrorJSPThe for parameter is used to identify the org.apache.tapestry5.Field to present errors of. <br/> Allow null : false
<br/> Default prefix : component
fortrueorg.apache.tapestry5.FieldThe CSS class for the div element rendered by the component. The default value is "t-error-single". <br/> Allow null : true
<br/> Default prefix : prop
classfalsejava.lang.StringTextArea component corresponds to a textarea element. The value parameter is almost always bound to a string,
but this is not an absolute requirement.
Includes the cols attribute, if a org.apache.tapestry5.beaneditor.Width annotation is present on
the property bound to the value parameter.textareaorg.apache.tapestry5.corelib.components.TextAreaJSPIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). Further, a
disabled field ignores any value in the request when the form is submitted. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanThe user presentable label for the field. If not provided, a reasonable label is generated from the component's
id, first by looking for a message key named "id-label" (substituting the component's actual id), then by
converting the actual id to a presentable string (for example, "userId" to "User Id"). <br/> Allow null : true
<br/> Default prefix : literal
labelfalsejava.lang.StringThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple
times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the
clientId property. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringDefines how nulls on the server side, or sent from the client side, are treated. The selected strategy may
replace the nulls with some other value. The default strategy leaves nulls alone. Another built-in strategy,
zero, replaces nulls with the value 0. <br/> Allow null : true
<br/> Default prefix : nullfieldstrategy
nullsfalseorg.apache.tapestry5.NullFieldStrategyProvider of annotations used for some defaults. Annotation are usually provided in terms of the value parameter
(i.e., from the getter and/or setter bound to the value parameter). <br/> Allow null : true
<br/> Default prefix : prop
annotationProviderfalseorg.apache.tapestry5.ioc.AnnotationProviderThe object which will perform translation between server-side and client-side representations. If not specified,
a value will usually be generated based on the type of the value parameter. <br/> Allow null : false
<br/> Default prefix : translate
translatetrueorg.apache.tapestry5.FieldTranslatorThe value to be read and updated. This is not necessarily a string, a translator may be provided to convert
between client side and server side representations. If not bound, a default binding is made to a property of the
container matching the component's id. If no such property exists, then you will see a runtime exception due to
the unbound value parameter. <br/> Allow null : true
<br/> Default prefix : prop
valuetruejava.lang.ObjectThe object that will perform input validation (which occurs after translation). The validate binding prefix is
generally used to provide this object in a declarative fashion. <br/> Allow null : true
<br/> Default prefix : validate
validatefalseorg.apache.tapestry5.FieldValidatorRenders an arbitrary element including informal parameters.anyorg.apache.tapestry5.corelib.components.AnyJSPThe desired client id, which defaults to the components id. <br/> Allow null : true
<br/> Default prefix : literal
clientIdfalsejava.lang.StringNo description found <br/> Allow null : true
<br/> Default prefix : literal
elementfalsejava.lang.StringGenerates a render request link to some other page in the application. If an activation context is supplied (as the
context parameter), then the context values will be encoded into the URL. If no context is supplied, then the target
page itself will supply the context via a passivate event.
Pages are not required to have an activation context. When a page does have an activation context, the value
typically represents the identity of some object displayed or otherwise manipulated by the page.pagelinkorg.apache.tapestry5.corelib.components.PageLinkJSPIf true, then then no link element is rendered (and no informal parameters as well). The body is, however, still
rendered. <br/> Allow null : true
<br/> Default prefix : prop
disabledfalsebooleanAn anchor value to append to the generated URL (the hash separator will be added automatically). <br/> Allow null : true
<br/> Default prefix : literal
anchorfalsejava.lang.StringThe logical name of the page to link to. <br/> Allow null : false
<br/> Default prefix : literal
pagetruejava.lang.StringIf provided, this is the activation context for the target page (the information will be encoded into the URL).
If not provided, then the target page will provide its own activation context. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;A way to add new content to an existing Form. The FormInjector emulates its tag from the template (or uses a
div). When triggered, new content is obtained from the application and is injected before or after the
element.
On the client side, a new function, trigger(), is added to the element. Invoking this client-side function will
trigger the FormInjector; a request is sent to the server, new content is generated, and the new content is placed
before or after (per configuration) the existing FormInjector element.forminjectororg.apache.tapestry5.corelib.components.FormInjectorJSPName of a function on the client-side Tapestry.ElementEffect object that is invoked to make added content
visible. Leaving as null uses the default function, "highlight". <br/> Allow null : true
<br/> Default prefix : literal
showfalsejava.lang.StringThe context for the link (optional parameter). This list of values will be converted into strings and included in
the URI. The strings will be coerced back to whatever their values are and made available to event handler
methods. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;The element name to render, which is normally the element name used to represent the FormInjector component in
the template, or "div". <br/> Allow null : true
<br/> Default prefix : literal
elementfalsejava.lang.StringNo description found <br/> Allow null : true
<br/> Default prefix : literal
positionfalseorg.apache.tapestry5.corelib.data.InsertPositionIntegral part of the default org.apache.tapestry5.corelib.pages.ExceptionReport page used to break apart and
display the properties of the exception.exceptiondisplayorg.apache.tapestry5.corelib.components.ExceptionDisplayJSPException to report. <br/> Allow null : false
<br/> Default prefix : prop
exceptiontruejava.lang.ThrowableA FormFragment is a portion of a Form that may be selectively displayed. Form elements inside a FormFragment will
automatically bypass validation when the fragment is invisible. The trick is to also bypass server-side form
processing for such fields when the form is submitted; client-side logic "removes" the
form data for the fragment if it is invisible when the
form
is submitted; alternately, client-side logic can simply remove the form fragment element (including its visible and
hidden fields) to prevent server-side processing.
The client-side element will now listen to two new event defined by client-side constants:
Tapestry.CHANGE_VISIBILITY_EVENT
Change the visiblity as per the event memo's visibility property. When the visiblity changes, the correct
animation is executed.
Tapestry.HIDE_AND_REMOVE_EVENT
Hides the element, then removes it from the DOM entirely.
formfragmentorg.apache.tapestry5.corelib.components.FormFragmentJSPIf bound, then the id attribute of the rendered element will be this exact value. If not bound, then a unique id
is generated for the element. <br/> Allow null : true
<br/> Default prefix : literal
idfalsejava.lang.StringName of a function on the client-side Tapestry.ElementEffect object that is invoked to make the fragment visible.
If not specified, then the default "slidedown" function is used. <br/> Allow null : true
<br/> Default prefix : literal
showfalsejava.lang.StringDetermines if the fragment is initially visible or initially invisible (the default). This is only used when
rendering; when the form is submitted, the hidden field value is used to determine whether the elements within
the fragment should be processed (or ignored if still invisible). <br/> Allow null : true
<br/> Default prefix : prop
visiblefalsebooleanName of a function on the client-side Tapestry.ElementEffect object that is invoked when the fragment is to be
hidden. If not specified, the default "slideup" function is used. <br/> Allow null : true
<br/> Default prefix : literal
hidefalsejava.lang.StringThe element to render for each iteration of the loop. The default comes from the template, or "div" if the
template did not specific an element. <br/> Allow null : true
<br/> Default prefix : literal
elementfalsejava.lang.StringIf true, then the fragment submits the values from fields it contains even if the fragment is not
visible.
The default is to omit values from fields when the enclosing fragment is non visible. <br/> Allow null : true
<br/> Default prefix : prop
alwaysSubmitfalsebooleanA component 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. This
results in much faster page loads. You can
even nest these!
The component simply does not render its body on initial render. On the subsequent action event request, it fires a
org.apache.tapestry5.EventConstants#PROGRESSIVE_DISPLAY event to inform the container about the (optional)
event context. The event handler method may return a renderable object; if not then the component's body is rendered
as the partial markup response.progressivedisplayorg.apache.tapestry5.corelib.components.ProgressiveDisplayJSPName of a function on the client-side Tapestry.ElementEffect object that
is invoked after the elements's body
content has been updated. If not specified, then the basic "highlight"
method is used, which performs a classic
"yellow fade" to indicate to the user that and update has taken place. <br/> Allow null : true
<br/> Default prefix : literal
updatefalsejava.lang.StringThe initial content to display until the real content arrives. Defaults
to "Loading ..." and an Ajax activity
icon. <br/> Allow null : true
<br/> Default prefix : literal
initialfalseorg.apache.tapestry5.BlockIf provided, this is the event context, which will be provided via the
event. <br/> Allow null : true
<br/> Default prefix : prop
contextfalse[Ljava.lang.Object;A component that does not do any rendering of its own, but will delegate to some other object that can do rendering.
This other object may be a component or a org.apache.tapestry5.Block (among other things).
This component may also be used to create inline components. For each informal parameter the value will be stored as a
render variable. To create an inline component, create a block
and use Delegate multiple times in the template to render the block passing parameters to Delegate. In the block body
reference the render variables using the "var:" binding prefix and the name of the parameter.
Note that the default binding prefix for parameter values is "literal".delegateorg.apache.tapestry5.corelib.components.DelegateJSPThe object which will be rendered in place of the Delegate component. This is typically a specific component
instance, or a org.apache.tapestry5.Block. <br/> Allow null : true
<br/> Default prefix : prop
totruejava.lang.ObjectA component that creates an entire form editing the properties of a particular bean. Inspired by Trails and BeanForm (both
for Tapestry 4). Generates a simple UI for editing the properties of a JavaBean, with the flavor of UI for each
property (text field, checkbox, drop down list) determined from the property type (or by other means, such as an
annotation), and the order and validation for the properties determined from annotations on the property's getter and
setter methods.
You may add block parameters to the component; when the name matches (case insensitive) the name of a property, then
the corresponding Block is renderered, rather than any of the built in property editor blocks. This allows you to
override specific properties with your own customized UI, for cases where the default UI is insufficient, or no
built-in editor type is appropriate.
BeanEditForm contains a org.apache.tapestry5.corelib.components.Form component and will trigger all the
events of a Form.beaneditformorg.apache.tapestry5.corelib.components.BeanEditFormJSPA comma-separated list of property names indicating the order in which the properties should be presented. The
names are case insensitive. Any properties not indicated in the list will be appended to the end of the display
orde. Only used
when a default model is created automatically. <br/> Allow null : true
<br/> Default prefix : literal
reorderfalsejava.lang.StringA comma-separated list of property names to be removed from the org.apache.tapestry5.beaneditor.BeanModel
(only used
when a default model is created automatically).
The names are case-insensitive. <br/> Allow null : true
<br/> Default prefix : literal
excludefalsejava.lang.StringThe object to be edited. This will be read when the component renders and updated when the form for the component
is submitted. Typically, the container will listen for a "prepare" event, in order to ensure that a non-null
value is ready to be read or updated. Often, the BeanEditForm can create the object as needed (assuming a public,
no arguments constructor). The object property defaults to a property with the same name as the component id. <br/> Allow null : true
<br/> Default prefix : prop
objecttruejava.lang.ObjectThe text label for the submit button of the form, by default "Create/Update". <br/> Allow null : true
<br/> Default prefix : literal
submitLabelfalsejava.lang.StringIf set to true, then the form will include an additional button after the submit button labeled "Cancel".
The cancel button will submit the form, bypassing client-side validation. The BeanEditForm will fire a
org.apache.tapestry5.EventConstants#CANCELED event (before the form's org.apache.tapestry5.EventConstants#VALIDATE event). <br/> Allow null : true
<br/> Default prefix : prop
cancelfalsebooleanThe model that identifies the parameters to be edited, their order, and every other aspect. If not specified, a
default bean model will be created from the type of the object bound to the object parameter. The add, include,
exclude and reorder parameters are only applied to a default model, not an explicitly provided one. <br/> Allow null : true
<br/> Default prefix : prop
modelfalseorg.apache.tapestry5.beaneditor.BeanModelA comma-separated list of property names to be retained from the
org.apache.tapestry5.beaneditor.BeanModel (only used
when a default model is created automatically).
Only these properties will be retained, and the properties will also be reordered. The names are
case-insensitive. <br/> Allow null : true
<br/> Default prefix : literal
includefalsejava.lang.StringA comma-separated list of property names to be added to the org.apache.tapestry5.beaneditor.BeanModel
(only used
when a default model is created automatically). <br/> Allow null : true
<br/> Default prefix : literal
addfalsejava.lang.StringblockblockJSPcontainerorg.apache.tapestry5.corelib.components.SubmitNotifierJSPbodyorg.apache.tapestry5.corelib.components.SubmitNotifierJSP
