info.informatica.ui
Interface DataControl

All Superinterfaces:
DataValue
All Known Implementing Classes:
FormCheckboxField, FormData, FormDateField, FormField, FormHiddenField, FormKeygenField, FormPasswordField, FormRadioField, FormSelectField, FormSelectMultiField, FormSubmit, FormTextAreaField, FormTextAreaInputField, FormTextField, MetaField, TextControl, TimeMark

public interface DataControl
extends DataValue

interface which adds format to data value.

Must be implemented by all data UI Controls.

Version:
1.01
Author:
amengual at informatica dot info

Method Summary
 ControlName getControlName()
          Returns the ID of this entity at User Interface.
 FieldName getFieldname()
          Returns the name of the database field associated to this entity.
 Object getFormat()
          Gets the format that applies to this UI element.
 void init(DataField de)
          Initializes the value of the field.
 void mapDataToUI(DataField de, Dataset ds, Map<String,Object> m)
           
 void setFieldname(FieldName name)
          Sets the name of the data field associated to this UI field.
 void setFormat(Object fmt)
          Sets the formatting object for this UI element.
 
Methods inherited from interface info.informatica.ui.DataValue
getValue, setValue
 

Method Detail

init

void init(DataField de)
          throws DataFieldException
Initializes the value of the field.

Throws:
DataFieldException

getControlName

ControlName getControlName()
Returns the ID of this entity at User Interface.


getFieldname

FieldName getFieldname()
Returns the name of the database field associated to this entity.


setFieldname

void setFieldname(FieldName name)
Sets the name of the data field associated to this UI field.


setFormat

void setFormat(Object fmt)
Sets the formatting object for this UI element.

It is allowed to thow an UnsupportedOperationException if the UI Control does not support formatting.

Parameters:
fmt - the Formatting object

getFormat

Object getFormat()
Gets the format that applies to this UI element.

Returns:
a formatting object for this element, or null if it has no format, or this object does not support formatting.

mapDataToUI

void mapDataToUI(DataField de,
                 Dataset ds,
                 Map<String,Object> m)
                 throws DatasetException
Throws:
DatasetException