to.etc.domui.component.meta.impl

Class DisplayPropertyMetaModel

java.lang.Object

to.etc.domui.component.meta.impl.DisplayPropertyMetaModel

public class DisplayPropertyMetaModel
extends Object

Implementation for a Display Property metamodel. The Display Property data overrides the default metadata for a property in a given display context.

Author:

Frits Jalvingh Created on Aug 6, 2009

Constructor Summary

Constructors

Constructor and Description
DisplayPropertyMetaModel(ClassMetaModel cmm, MetaComboProperty p)
DisplayPropertyMetaModel(ClassMetaModel cmm, MetaDisplayProperty p)
DisplayPropertyMetaModel(PropertyMetaModel<?> pmm)

Method Summary

Modifier and Type	Method and Description
static List<DisplayPropertyMetaModel>	decode(ClassMetaModel cmm, MetaComboProperty[] mar) Convert a list of combobox display properties to their metamodel equivalents.
static List<DisplayPropertyMetaModel>	decode(ClassMetaModel cmm, MetaDisplayProperty[] mar) Converts a list of MetaDisplayProperty annotations into their metamodel equivalents.
<X,TT extends IConverter<X>> String	getAsString(Object root) Returns the attribute as a string value.
IConverter<?>	getConverter()
int	getDisplayLength()
String	getJoin() If this is joined display property, this returns the string to put between the joined values.
String	getLabel() If the label for this display property is overridden this returns the value (not the key) for the overridden label.
YesNoType	getNoWrap()
PropertyMetaModel<?>	getProperty()
String	getRenderHint()
SortableType	getSortable()
int	getSortIndex() The index (order) in which all sortable fields should be applied in an initial sort; -1 if there is no default sort.
void	setConverter(IConverter<?> converter)
void	setDisplayLength(int displayLength)
void	setJoin(String join)
void	setNoWrap(YesNoType noWrap)
void	setRenderHint(String renderHint)
void	setSortable(SortableType sortable)
void	setSortIndex(int sortIndex)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DisplayPropertyMetaModel

public DisplayPropertyMetaModel(@Nonnull
                                PropertyMetaModel<?> pmm)

DisplayPropertyMetaModel

public DisplayPropertyMetaModel(@Nonnull
                                ClassMetaModel cmm,
                                @Nonnull
                                MetaDisplayProperty p)

DisplayPropertyMetaModel

public DisplayPropertyMetaModel(@Nonnull
                                ClassMetaModel cmm,
                                @Nonnull
                                MetaComboProperty p)

Method Detail

decode

public static List<DisplayPropertyMetaModel> decode(ClassMetaModel cmm,
                                                    MetaDisplayProperty[] mar)

Converts a list of MetaDisplayProperty annotations into their metamodel equivalents.

Parameters:

cmm -

mar -

Returns:

decode

public static List<DisplayPropertyMetaModel> decode(ClassMetaModel cmm,
                                                    MetaComboProperty[] mar)

Convert a list of combobox display properties to their metamodel equivalents.

Parameters:

cmm -

mar -

Returns:

getJoin

public String getJoin()

If this is joined display property, this returns the string to put between the joined values. Returns null for unjoined properties.

Returns:

setJoin

public void setJoin(String join)

getLabel

public String getLabel()

If the label for this display property is overridden this returns the value (not the key) for the overridden label. If this display property does not override the label it returns null. When the key does not exist in the bundle this returns the key error string (???+key+???).

Returns:

getProperty

@Nonnull
public PropertyMetaModel<?> getProperty()

getAsString

public <X,TT extends IConverter<X>> String getAsString(Object root)
                                                throws Exception

Returns the attribute as a string value.

Parameters:

root -

Returns:

Throws:

Exception

getRenderHint

public String getRenderHint()

setRenderHint

public void setRenderHint(String renderHint)

toString

public String toString()

Overrides:

toString in class Object

getConverter

public IConverter<?> getConverter()

setConverter

public void setConverter(IConverter<?> converter)

getSortable

public SortableType getSortable()

setSortable

public void setSortable(SortableType sortable)

getDisplayLength

public int getDisplayLength()

setDisplayLength

public void setDisplayLength(int displayLength)

getSortIndex

public int getSortIndex()

The index (order) in which all sortable fields should be applied in an initial sort; -1 if there is no default sort.

Returns:

setSortIndex

public void setSortIndex(int sortIndex)

getNoWrap

@Nonnull
public YesNoType getNoWrap()

setNoWrap

public void setNoWrap(@Nonnull
                      YesNoType noWrap)