com.sencha.gxt.widget.core.client.form

Class ConverterEditorAdapter<T,U,E extends <any>>

java.lang.Object

com.sencha.gxt.widget.core.client.form.ConverterEditorAdapter<T,U,E>

Type Parameters:

T - original sub-property type, referred to as the model type by the Converter

U - type editable by E, referred to as the field type by the Converter

E - editor type used to display, modify U

public class ConverterEditorAdapter<T,U,E extends <any>>
extends Object

Adapter to allow an Editor to have a subeditor that acts on a Converter-modified instance of the data.

As an example, consider an Order object that has a property vendorId, which holds the id property of a Vendor object. But to draw the field, the full Vendor must be used in a ComboBox<Vendor>:

 public class Order {
   public String getVendorId() { ... }
 }
 public class Vendor {
   public String getName() { ... }
   public String getId() { ... }
 }
 interface VendorProperties extends ValueProvider<Vendor> {
   ModelKeyProvider<Vendor> id();
   LabelProvider<Vendor> name();
 }
 public class OrderEditor implements Editor<Order> {

   // Won't work as a subeditor, since we can't refer to the String vendorId as a Vendor
   //ComboBox<Vendor> vendorId;

   // Instead, we create a way to map from String -> Vendor
   public static class VendorIdConverter implements Converter<String, Vendor> {
     private final Store<Vendor> store;
     public VendorIdConverter(Store<Vendor> store) {
       this.store = store;
     }
     public String convertFieldValue(Vendor object) {
       return object.getId();
     }
     public Vendor convertModelValue(String object) {
       return store.findModelWithKey(object);
     }
   }

   // We create a ComboBox to display, but tell the editor to ignore it
    @Ignore
   ComboBox<Vendor> vendor;

   // And we wire the vendorId property to the vendor ComboBox, using the Converter
   // This is an editor, so it must be public, protected, or default
   ConverterEditorAdapter<String, Vendor, ComboBox<Vendor>> vendorId;

   public OrderEditor() {
     VendorProperties props = GWT.create(VendorProperties.class);

     ListStore<Vendor> vendorList = new ListStore<Vendor>(props.id());
     //possible vendors should be added to this list, might be an RPC call?
     vendorList.add(...);

     //this will make the combo box draw the vendor name - easier to read than the id
     vendor = new ComboBox<Vendor>(props.name());

     //and finally, actually wire them together
     vendorId = new ConverterEditorAdapter<String, Vendor, ComboBox<Vendor>>
         (vendor, new VendorIdConverter(vendorList));
   }
 }
 

Constructor Summary

Constructors

Constructor and Description
ConverterEditorAdapter(E editor, Converter<T,U> converter) Creates a new editor adapter using the given converter to translate values to and from what can be used by the given editor.

Method Summary

Modifier and Type	Method and Description
E	createEditorForTraversal()
void	flush()
Converter<T,U>	getConverter()
String	getPathElement(E subEditor)
T	getValue()
void	onPropertyChange(String... paths)
void	setDelegate(<any> delegate)
void	setEditorChain(<any> chain)
void	setValue(T value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConverterEditorAdapter

public ConverterEditorAdapter(E editor,
                              Converter<T,U> converter)

Creates a new editor adapter using the given converter to translate values to and from what can be used by the given editor.

Parameters:

editor - the editor

converter - the converter

Method Detail

flush

public void flush()

onPropertyChange

public void onPropertyChange(String... paths)

setDelegate

public void setDelegate(<any> delegate)

setValue

public void setValue(T value)

getValue

public T getValue()

createEditorForTraversal

public E createEditorForTraversal()

getPathElement

public String getPathElement(E subEditor)

setEditorChain

public void setEditorChain(<any> chain)

getConverter

public Converter<T,U> getConverter()

Returns:

the converter instance used by this editor adapter to modify values