|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Documented @Retention(value=RUNTIME) public @interface MetaDisplayProperty
Used to define a property to show in a table, used to define the names and to override display properties for a single table.
Required Element Summary | |
---|---|
java.lang.String |
name
The name of the property to show. |
Optional Element Summary | |
---|---|
java.lang.Class<? extends IConverter<?>> |
converterClass
Define a Converter class to use to convert the value from the property to a string. |
java.lang.String |
defaultLabel
When set this overrides the default label as set by the property metadata. |
SortableType |
defaultSortable
When set, this defines this field as being a field that a table can show a "sort button" on. |
int |
displayLength
An indication of the display length to use for this field, in characters. |
java.lang.String |
join
When present, this will force a join of this property and the next one specified in the display property list, and the string specified here will be used as a "separator" between the two values. |
Element Detail |
---|
public abstract java.lang.String name
public abstract java.lang.String defaultLabel
public abstract SortableType defaultSortable
MetaObject.defaultSortColumn()
. The "default" in this name refers to the default order (ascending or
descending).
public abstract int displayLength
MetaProperty.length()
or any JPA Annotation like Column#length()
.
public abstract java.lang.Class<? extends IConverter<?>> converterClass
MetaProperty.converterClass()
setting or by the default conversions registered with the conversion factory.
public abstract java.lang.String join
When present, this will force a join of this property and the next one specified in the display property list, and the string specified here will be used as a "separator" between the two values. The join means that the two (or more) properties are joined together in a single table column, as a single string. A typical use case for instance is to create a single visible table column for something like Address, where the address is displayed as:
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |