com.objex.progeny.anywhere.fields
Interface XRFField

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

XRFComputedField, XRFDateField, XRFDropdownField, XRFHyperlinkField, XRFIDSDataField, XRFIDSLookupTableField, XRFImageField, XRFNumberField, XRFSummaryField, XRFSystemField, XRFTableField, XRFTableSummaryField, XRFTextField, XRFYesNoField

public interface XRFField
extends java.io.Serializable

Method Summary

int	countSubFields()
XRFData	createFieldData(java.lang.Object value) Creates a FieldData object of the relevant type depending on the field type.
int	getDefaultWidth() get the default width for the field.
java.lang.String[]	getDropdownValues()
java.lang.Class	getFieldClass()
int	getFieldid()
java.lang.String	getFieldname()
XRFFieldType	getFieldtype()
java.lang.String	getImageURL()
XRFLookupTableInfo	getLookupTableInfo()
XRFField[]	getSubfields()
int	getTableid()
int	getUpdateColsCount()
boolean	isCalcField()
boolean	isComputed()
boolean	isSystemField()
boolean	isTable()
void	setDefaultWidth(int width) Set the default width for the field.
void	setDropdownValues(java.lang.String[] rhs)
void	setFieldid(int ai_fieldid)
void	setFieldname(java.lang.String as_fieldname)
void	setFieldtype(XRFFieldType aType)
void	setLookupTableInfo(XRFLookupTableInfo a_lookupTableInfo)
void	setSubfields(XRFField[] subfields)
void	setTableid(int ai_tableid)
java.lang.String	transform(java.lang.Object a_from) Where possible, transform the value a_from contained some place as the data for this field, into a string literal representation

Method Detail

getFieldtype

XRFFieldType getFieldtype()

setFieldtype

void setFieldtype(XRFFieldType aType)

getFieldname

java.lang.String getFieldname()

setFieldname

void setFieldname(java.lang.String as_fieldname)

getFieldid

int getFieldid()

setFieldid

void setFieldid(int ai_fieldid)

isSystemField

boolean isSystemField()

isCalcField

boolean isCalcField()

Returns:

TRUE if the field is not editable and is a calculated or computed field e.g. computed, table summary and summary fields

getFieldClass

java.lang.Class getFieldClass()

Returns:

The Class for all data objects carried by this field

transform

java.lang.String transform(java.lang.Object a_from)

Where possible, transform the value a_from contained some place as the data for this field, into a string literal representation

isComputed

boolean isComputed()

isTable

boolean isTable()

getImageURL

java.lang.String getImageURL()

getDropdownValues

java.lang.String[] getDropdownValues()

setDropdownValues

void setDropdownValues(java.lang.String[] rhs)

getLookupTableInfo

XRFLookupTableInfo getLookupTableInfo()

setLookupTableInfo

void setLookupTableInfo(XRFLookupTableInfo a_lookupTableInfo)

getSubfields

XRFField[] getSubfields()

setSubfields

void setSubfields(XRFField[] subfields)

countSubFields

int countSubFields()

getUpdateColsCount

int getUpdateColsCount()

Returns:

The number of actual database table columns that will need to be updated. E.g. the System field Position actually refers to two database columns in st_container (poscol and posrow). Running this method XRFField Position will return 2.

setDefaultWidth

void setDefaultWidth(int width)

Set the default width for the field. If fieldwidth is not set somewhere, this deafult will be used whenever a renderer for this field is rendered

getDefaultWidth

int getDefaultWidth()

get the default width for the field. If fieldwidth is not set somewhere, this deafult will be used whenever a renderer for this field is rendered

createFieldData

XRFData createFieldData(java.lang.Object value)

Creates a FieldData object of the relevant type depending on the field type. Must set the XRFData.setField(XRFField) property

Parameters:

value - The default data value

getTableid

int getTableid()

setTableid

void setTableid(int ai_tableid)