CustomField

A form field whose presentation and logic can be customized

View larger

Close

Custom fields offer the possibility to create Vaadin form fields with customized presentation and logic.

Fields can be composed of standard or custom Vaadin components on the server side. The field logic can either be reused directly for the CustomField or partly overridden for customized behavior.

This also allows the creation of custom editors for sub-objects on forms, including nesting of forms in CustomFields within other forms.

Sample code

    public static class BooleanField extends CustomField {

        public BooleanField() {
            VerticalLayout layout = new VerticalLayout();

            layout.addComponent(new Label("Please click the button"));

            final Button button = new Button("Click me");
            button.addListener(new ClickListener() {
                public void buttonClick(ClickEvent event) {
                    Object value = getValue();
                    boolean newValue = true;
                    if ((value instanceof Boolean) && ((Boolean) value)) {
                        newValue = false;
                    }
                    setValue(newValue);
                    button.setCaption(newValue ? "On" : "Off");
                }
            });
            layout.addComponent(button);

            setCompositionRoot(layout);
        }

        @Override
        public Class<?> getType() {
            return Boolean.class;
        }
    }

Links

• Forum post
• Source code repository
• Online Demo

Compatibility