com.vaadin.spring.roo.addon.AutomaticEntityForm-template Maven / Gradle / Ivy

Go to download
package __ABSTRACT_ENTITY_VIEW_PACKAGE__;

import java.util.Collection;
import java.util.Collections;

import com.vaadin.addon.beanvalidation.BeanValidationForm;
import com.vaadin.data.Item;
import com.vaadin.event.ShortcutAction.KeyCode;
import com.vaadin.terminal.ThemeResource;
import com.vaadin.terminal.UserError;
import com.vaadin.ui.Button;
import com.vaadin.ui.Button.ClickListener;
import com.vaadin.ui.CssLayout;
import com.vaadin.ui.CustomComponent;
import com.vaadin.ui.HorizontalLayout;
import com.vaadin.ui.Panel;
import com.vaadin.ui.themes.BaseTheme;
import com.vaadin.ui.themes.Reindeer;

public class AutomaticEntityForm extends CustomComponent implements EntityEditor {

    private Button deleteButton;
    private Button cancelButton;
    private Button saveButton;

    private Panel formPanel;
    private BeanValidationForm form;

    public AutomaticEntityForm(Class entityClass) {
        form = new BeanValidationForm(entityClass);

        // form editor layout
        CssLayout wrapper = new CssLayout();
        wrapper.setMargin(true);
        wrapper.setWidth("100%");
        formPanel = new Panel();
        formPanel.setIcon(new ThemeResource("img/edit-icon.png"));
        formPanel.addComponent(getForm());
        wrapper.addComponent(formPanel);

        setCompositionRoot(wrapper);

        // immediate validation but no changes to the underlying entity
        getForm().setImmediate(true);
        getForm().setWriteThrough(false);

        createFormFooter();

        // make saving the form the default action on Enter keypress
        getSaveButton().setClickShortcut(KeyCode.ENTER);
    }

    public void addSaveActionListener(ClickListener listener) {
        getSaveButton().addListener(listener);
    }

    public void addCancelActionListener(ClickListener listener) {
        getCancelButton().addListener(listener);
    }

    public void addDeleteActionListener(ClickListener listener) {
        getDeleteButton().addListener(listener);
    }

    public void setSaveAllowed(boolean canSave) {
        getSaveButton().setVisible(canSave);
        getCancelButton().setVisible(canSave);
        getSaveButton().setEnabled(canSave);
        getCancelButton().setEnabled(canSave);

        // do not change the enabled state of the delete button
        getForm().getLayout().setEnabled(canSave);
    }

    public void setDeleteAllowed(boolean canDelete) {
        getDeleteButton().setVisible(canDelete);
        getDeleteButton().setEnabled(canDelete);
    }

    public void commit() {
        getForm().commit();
    }

    public void setItemDataSource(Item item) {
        if (null != item) {
            getForm().setItemDataSource(item, getItemPropertyIds(item));
        } else {
            getForm().setItemDataSource(null);
        }

        // may reuse form and button, so clear any old error messages
        getSaveButton().setComponentError(null);
        getForm().setComponentError(null);

        // don't show validation errors before user tries to commit the form
        getForm().setValidationVisible(false);
    }

    /**
     * Return item property IDs to show on the form.
     * 
     * This method can be overridden to hide specific properties or to customize
     * the order of the fields.
     * 
     * @param item
     * @return Collection of property identifiers for the item
     */
    protected Collection getItemPropertyIds(Item item) {
        if (null == item) {
            return Collections.emptyList();
        }
        return item.getItemPropertyIds();
    }

    public Item getItemDataSource() {
        return getForm().getItemDataSource();
    }

    public void setCommitErrorMessage(String message) {
    }

    protected BeanValidationForm getForm() {
        return form;
    }

    protected Button getSaveButton() {
        if (saveButton == null) {
            saveButton = new Button("Save");
            saveButton.setStyleName(Reindeer.BUTTON_DEFAULT);
        }
        return saveButton;
    }

    protected Button getCancelButton() {
        if (cancelButton == null) {
            cancelButton = new Button("Cancel");
        }
        return cancelButton;
    }

    protected Button getDeleteButton() {
        if (deleteButton == null) {
            deleteButton = new Button("Delete");
            deleteButton.setStyleName(BaseTheme.BUTTON_LINK);
        }
        return deleteButton;
    }

    protected void createFormFooter() {
        HorizontalLayout footer = new HorizontalLayout();
        footer.setSpacing(true);
        getForm().setFooter(footer);

        footer.addComponent(getSaveButton());
        footer.addComponent(getCancelButton());
        footer.addComponent(getDeleteButton());
    }

    @Override
    public void setCaption(String caption) {
        formPanel.setCaption(caption);
    }

    @Override
    public void focus() {
        getForm().focus();
    }

    public void refresh() {
    	// nothing to do
    }

    public boolean isModified() {
        return getForm().isModified();
    }

}