org.apache.tapestry5.services

Interface BeanBlockSource

All Known Implementing Classes:

BeanBlockSourceImpl

@UsesConfiguration(value=BeanBlockContribution.class)
public interface BeanBlockSource

A source of Blocks used to display the properties of a bean (used by the Grid component), or to edit the properties of a bean (used by the BeanEditForm component). Contributions to this service (a configuration of BeanBlockContributions) define what properties may be editted. Blocks are accessed in terms of a data type a string that identifies the type of data to be editted, such as "string", "date", "boolean", etc. Tapestry contributes a number of default data types and corresponding edit and display blocks. The BeanBlockOverrideSource service allows these to be overridden.

See Also:

DataTypeAnalyzer, TapestryModule.provideDefaultBeanBlocks(org.apache.tapestry5.ioc.Configuration)

Method Summary

Modifier and Type	Method and Description
Block	getDisplayBlock(String datatype) Returns a block which can be used to render output for the given data type.
Block	getEditBlock(String datatype) Returns a block which can be used to render an editor for the given data type, in the form of a field label and input field.
boolean	hasDisplayBlock(String datatype) Checks to see if there is a display block for the indicated data type.

Method Detail

getEditBlock

Block getEditBlock(String datatype)

Returns a block which can be used to render an editor for the given data type, in the form of a field label and input field.

Parameters:

datatype - logical name for the type of data to be displayed

Returns:

the Block

Throws:

RuntimeException - if no appropriate block is available

getDisplayBlock

Block getDisplayBlock(String datatype)

Returns a block which can be used to render output for the given data type.

Parameters:

datatype - logical name for the type of data to be displayed

Returns:

the Block

Throws:

RuntimeException - if no appropriate block is available

hasDisplayBlock

boolean hasDisplayBlock(String datatype)

Checks to see if there is a display block for the indicated data type.

Parameters:

datatype - to check for

Returns:

true if a block is available