Creating your own converter for String - MyType conversion

If you have custom types that you want to represent using the built in field components, you can easily create your own converter to take care of converting between your own type and the native data type of the field.

A sample custom type, in this case a Name object with separate fields for first and last name.

Java

  1. public class Name {
  2.   private String firstName;
  3.   private String lastName;
  5.   public Name(String firstName, String lastName) {
  6.     this.firstName = firstName;
  7.     this.lastName = lastName;
  8.   }
  10.   public String getFirstName() {
  11.     return firstName;
  12.   }
  14.   public void setFirstName(String firstName) {
  15.     this.firstName = firstName;
  16.   }
  18.   public String getLastName() {
  19.     return lastName;
  20.   }
  22.   public void setLastName(String lastName) {
  23.     this.lastName = lastName;
  24.   }
  25. }

A converter for the name, assuming the parts are separated with a space and that there are only two parts of a name.

Java

  1. public class StringToNameConverter implements Converter<String, Name> {
  2.   public Name convertToModel(String text, Locale locale)
  3.       throws ConversionException {
  4.     if (text == null) {
  5.       return null;
  6.     }
  7.     String[] parts = text.split(" ");
  8.     if (parts.length != 2) {
  9.       throw new ConversionException("Can not convert text to a name: " + text);
  10.     }
  11.     return new Name(parts[0], parts[1]);
  12.   }
  14.   public String convertToPresentation(Name name, Locale locale)
  15.       throws ConversionException {
  16.     if (name == null) {
  17.       return null;
  18.     } else {
  19.       return name.getFirstName() + " " + name.getLastName();
  20.     }
  21.   }
  23.   public Class<Name> getModelType() {
  24.     return Name.class;
  25.   }
  27.   public Class<String> getPresentationType() {
  28.     return String.class;
  29.   }
  30. }

Hooking up the Name type and its Converter to a TextField can then be done like this

Java

  1. Name name = new Name("Rudolph", "Reindeer");
  3. final TextField textField = new TextField("Name");
  4. textField.setConverter(new StringToNameConverter());
  5. textField.setConvertedValue(name);
  7. addComponent(textField);
  8. addComponent(new Button("Submit value", new ClickListener() {
  9.   public void buttonClick(ClickEvent event) {
  10.     try {
  11.       Name name = (Name) textField.getConvertedValue();
  12.       Notification.show(
  13.               "First name: " + name.getFirstName() +
  14.               "<br />Last name: " + name.getLastName());
  15.     } catch (ConversionException e) {
  16.       Notification.show(e.getCause().getMessage());
  17.     }
  18.   }
  19. }));