PropertyTranslator

What PropertyFormatter does for TextFields, PropertyTranslator does for Selects

PropertyTranslator is close relative to PropertyFormatter. As where property formatter only works with string based fields (like TextField), PropertyTranslator can be used with any field.

The most apparent use case is with Selects, when identifiers in container datasource and the value in the property datasource don't match.

Note, that PropertyTranslator is very similar to a helper class called PropertyConverter in CustomField add-on. If you already have CustomField in your project, you should use that instead.

Note, that setting property translator for a field in FormFieldFactory is practical since 6.7.3. Form then sets the property to existing property if it implements Property.Viewer interface as the PropertyTranslator does.

Sample code

select.setPropertyDataSource(new PropertyTranslator(beanItemProperty) {
				
				@Override
				public Object translateToDatasource(Object formattedValue) throws Exception {
					// ID -> Entity
					EntityItem<WorkoutType> item = containerDataSource.getItem(formattedValue);
					return item.getEntity();
				}
				
				@Override
				public Object translateFromDatasource(Object value) {
					// Entity -> ID
					WorkoutType wt = (WorkoutType) value;
					return wt == null ? null : wt.getId();
				}
			});

Links

• Source Code

Compatibility