org.apache.tapestry5.corelib.components.BeanEditor

A component that generates a user interface for editing the properties of a bean. This is the central component of the BeanEditForm, and utilizes a PropertyEditor for much of its functionality. This component places a BeanEditContext into the environment.

[JavaDoc]

Component Parameters

NameTypeFlagsDefaultDefault PrefixDescription
addStringNOT Allow NullliteralA comma-separated list of property names to be added to the BeanModel.
excludeStringNOT Allow NullliteralA comma-separated list of property names to be removed from the BeanModel. The names are case-insensitive.
includeStringNOT Allow NullliteralA comma-separated list of property names to be retained from the BeanModel. Only these properties will be retained, and the properties will also be reordered. The names are case-insensitive.
modelBeanModelNOT Allow NullpropThe 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.
objectObjectNOT Allow NullpropThe 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.
overridesPropertyOverridesNOT Allow NullthispropWhere 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.
reorderStringNOT Allow NullliteralA 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.

Informal parameters: supported

See the BeanEditForm documentation for examples of how to use and customize this component. A further example is available in the documentation for the FormFragment component.


Back to index