to.etc.domui.component.meta

Annotation Type MetaComboProperty

@Retention(value=RUNTIME)
public @interface MetaComboProperty

Defines a display property for a combo control, to use in the MetaCombo annotation. It is functionally equivalent to MetaDisplayProperty but has less parameters.

Author:

Frits Jalvingh Created on Dec 20, 2010

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the property to show.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends IConverter<?>>	converterClass The converter to use to convert this property's value to a string.
String	join When set, this separator will be added between this property and the next one in the combo's property list, provided there is a next property value.
SortableType	sortable If this combo field should be used in an initial sort of the combobox's data this defines the sort direction.
int	sortIndex Defines the "place" of this field in a sort statement, if applicable.

Element Detail

name

public abstract String name

The name of the property to show. You can also specify a dotted path to some parent entity's property here. This will be replaced with a Property reference once the JDK 7 team gets off it's ass and starts to bloody define something useful 8-(

Returns:

converterClass

public abstract Class<? extends IConverter<?>> converterClass

The converter to use to convert this property's value to a string. Defaults to the actual property's converter when unset.

Returns:

Default:

to.etc.domui.converter.DummyConverter.class

join

public abstract String join

When set, this separator will be added between this property and the next one in the combo's property list, provided there is a next property value. It defaults to a single space.

Returns:

Default:

"$*$"

sortable

public abstract SortableType sortable

If this combo field should be used in an initial sort of the combobox's data this defines the sort direction. The field sortIndex() defines the position inside the sort.

Returns:

Default:

to.etc.domui.component.meta.SortableType.UNKNOWN

sortIndex

public abstract int sortIndex

Defines the "place" of this field in a sort statement, if applicable. This has meaning only if sortable() is set to some sort; in that case this indes defines the location of the field inside the sort.

Returns:

Default:

-1