|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.vaadin.data.util.AbstractProperty
com.vaadin.data.util.PropertyFormatter
public abstract class PropertyFormatter
Formatting proxy for a Property.
This class can be used to implement formatting for any type of Property datasources. The idea is to connect this as proxy between UI component and the original datasource.
For example
adds formatter for Double-typed property that extends
standard "1.0" notation with more zeroes.
textfield.setPropertyDataSource(new PropertyFormatter(property) {
public String format(Object value) {
return ((Double) value).toString() + "000000000";
}
public Object parse(String formattedValue) throws Exception {
return Double.parseDouble(formattedValue);
}
});
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.vaadin.data.util.AbstractProperty |
|---|
AbstractProperty.ReadOnlyStatusChangeEvent |
| Nested classes/interfaces inherited from interface com.vaadin.data.Property |
|---|
Property.ConversionException, Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer |
| Constructor Summary | |
|---|---|
protected |
PropertyFormatter()
Construct a new PropertyFormatter that is not connected to any
data source. |
|
PropertyFormatter(Property propertyDataSource)
Construct a new formatter that is connected to given data source. |
| Method Summary | |
|---|---|
abstract String |
format(Object value)
This method must be implemented to format the values received from DataSource. |
Property |
getPropertyDataSource()
Gets the current data source of the formatter, if any. |
Class |
getType()
Returns the type of the Property. |
Object |
getValue()
Get the formatted value. |
boolean |
isReadOnly()
Reflects the read-only status of the datasource. |
abstract Object |
parse(String formattedValue)
Parse string and convert it to format compatible with datasource. |
void |
readOnlyStatusChange(Property.ReadOnlyStatusChangeEvent event)
Listens for changes in the datasource. |
void |
setPropertyDataSource(Property newDataSource)
Sets the specified Property as the data source for the formatter. |
void |
setReadOnly(boolean newStatus)
Sets the Property's read-only mode to the specified status. |
void |
setValue(Object newValue)
Sets the value of the Property. |
String |
toString()
Get the formatted value. |
void |
valueChange(Property.ValueChangeEvent event)
Listens for changes in the datasource. |
| Methods inherited from class com.vaadin.data.util.AbstractProperty |
|---|
addListener, addListener, fireReadOnlyStatusChange, fireValueChange, getListeners, removeListener, removeListener |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
protected PropertyFormatter()
PropertyFormatter that is not connected to any
data source. Call setPropertyDataSource(Property) later on to
attach it to a property.
public PropertyFormatter(Property propertyDataSource)
format(Object) which can be a problem if the formatter has not
yet been initialized.
propertyDataSource - to connect this property to.| Method Detail |
|---|
public Property getPropertyDataSource()
getPropertyDataSource in interface Property.Viewernull if
none defined.public void setPropertyDataSource(Property newDataSource)
Remember that new data sources getValue() must return objects that are compatible with parse() and format() methods.
setPropertyDataSource in interface Property.ViewernewDataSource - the new data source Property.public Class getType()
PropertygetValue and
setValue must be compatible with this type: one must be able
to safely cast the value returned from getValue to the given
type and pass any variable assignable to this type as an argument to
setValue.
getType in interface Propertypublic Object getValue()
getValue in interface Propertypublic String toString()
toString in interface PropertytoString in class AbstractPropertypublic boolean isReadOnly()
isReadOnly in interface PropertyisReadOnly in class AbstractPropertytrue if the Property is in read-only mode,
false if it's notpublic abstract String format(Object value)
value - Value object got from the datasource. This is guaranteed to be
non-null and of the type compatible with getType() of the
datasource.
public abstract Object parse(String formattedValue)
throws Exception
formattedValue - This is guaranteed to be non-null string.
Exception - Any type of exception can be thrown to indicate that the
conversion was not succesful.public void setReadOnly(boolean newStatus)
setReadOnly in interface PropertysetReadOnly in class AbstractPropertynewStatus - the new read-only status of the Property.
public void setValue(Object newValue)
throws Property.ReadOnlyException,
Property.ConversionException
Property
Implementing this functionality is optional. If the functionality is
missing, one should declare the Property to be in read-only mode and
throw Property.ReadOnlyException in this function.
String in addition to the native type of the
Property (as given by the getType method). If the
String conversion fails or is unsupported, the method should
throw Property.ConversionException. The string conversion
should at least understand the format returned by the
toString method of the Property.
setValue in interface PropertynewValue - New value of the Property. This should be assignable to the
type returned by getType, but also String type should be
supported
Property.ReadOnlyException - if the object is in read-only mode
Property.ConversionException - if newValue can't be converted into the Property's native
type directly or through Stringpublic void valueChange(Property.ValueChangeEvent event)
valueChange in interface Property.ValueChangeListenerevent - value change event objectpublic void readOnlyStatusChange(Property.ReadOnlyStatusChangeEvent event)
readOnlyStatusChange in interface Property.ReadOnlyStatusChangeListenerevent - Read-only status change event object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||