org.melati.poem

Interface FieldAttributes<T>

All Known Implementing Classes:

BaseFieldAttributes, Column, ExtraColumn, Field

public interface FieldAttributes<T>

An interface which defines attributes of all Fields.

Author:

WilliamC At paneris.org

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getDisplayName()
int	getHeight()
boolean	getIndexed()
String	getName()
String	getRenderInfo()
PoemType<T>	getType()
boolean	getUserCreateable()
boolean	getUserEditable()
int	getWidth()

Method Detail

getName

String getName()

Returns:

the machine name of the field

getDisplayName

String getDisplayName()

Returns:

the human readable name of the field

getDescription

String getDescription()

Returns:

the longer description of the field

getType

PoemType<T> getType()

Returns:

the PoemType of the field

getIndexed

boolean getIndexed()

Returns:

whether the field is indexed

getUserEditable

boolean getUserEditable()

Returns:

whether a user may change the field value

getUserCreateable

boolean getUserCreateable()

Returns:

whether a user may create a field

getWidth

int getWidth()

Returns:

the width of widget required to display this field

getHeight

int getHeight()

Returns:

the height of widget to display this field

getRenderInfo

String getRenderInfo()

Returns:

the name of a special widget templet to display this field