org.apache.ace.webui.vaadin.GenericAddWindow.java Source code

Introduction

Here is the source code for org.apache.ace.webui.vaadin.GenericAddWindow.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.ace.webui.vaadin;

import com.vaadin.event.FieldEvents.TextChangeEvent;
import com.vaadin.event.FieldEvents.TextChangeListener;
import com.vaadin.event.ShortcutAction.KeyCode;
import com.vaadin.ui.AbstractTextField.TextChangeEventMode;
import com.vaadin.ui.Alignment;
import com.vaadin.ui.Button;
import com.vaadin.ui.Button.ClickEvent;
import com.vaadin.ui.HorizontalLayout;
import com.vaadin.ui.TextField;
import com.vaadin.ui.VerticalLayout;
import com.vaadin.ui.Window;
import com.vaadin.ui.themes.Reindeer;

public abstract class GenericAddWindow extends Window {

    protected final TextField m_name;
    protected final TextField m_description;

    public GenericAddWindow(String caption) {
        setModal(true);
        setWidth("15em");
        setCaption(caption);

        m_name = new TextField("Name");
        m_name.setNullSettingAllowed(false);
        m_name.setRequired(true);
        m_name.setImmediate(true);
        m_name.setWidth("100%");

        m_description = new TextField("Description");
        m_name.setNullSettingAllowed(true);
        m_description.setRequired(false);
        m_description.setImmediate(true);
        m_description.setWidth("100%");

        initDialog();
    }

    /**
     * Shows this dialog on screen.
     * 
     * @param window
     *            the parent window to show this dialog on, cannot be <code>null</code>.
     */
    public void show(final Window window) {
        if (getParent() != null) {
            // window is already showing
            window.showNotification("Window is already open");
        } else {
            // Open the subwindow by adding it to the parent window
            window.addWindow(this);
        }
        setRelevantFocus();
    }

    /**
     * Called when the {@link #onOk(String, String)} method failed with an exception.
     * 
     * @param e
     *            the exception to handle, never <code>null</code>.
     */
    protected abstract void handleError(Exception e);

    /**
     * Initializes this dialog by placing all components on it.
     */
    protected void initDialog() {
        VerticalLayout fields = new VerticalLayout();
        fields.setSpacing(true);
        fields.addComponent(m_name);
        fields.addComponent(m_description);

        final Button okButton = new Button("Ok", new Button.ClickListener() {
            public void buttonClick(ClickEvent event) {
                try {
                    onOk((String) m_name.getValue(), (String) m_description.getValue());
                    close();
                } catch (Exception e) {
                    handleError(e);
                }
            }
        });
        okButton.setEnabled(false);
        // Allow enter to be used to close this dialog with enter directly...
        okButton.setClickShortcut(KeyCode.ENTER);
        okButton.addStyleName(Reindeer.BUTTON_DEFAULT);

        Button cancelButton = new Button("Cancel", new Button.ClickListener() {
            public void buttonClick(ClickEvent event) {
                close();
            }
        });
        cancelButton.setClickShortcut(KeyCode.ESCAPE);

        m_name.addListener(new TextChangeListener() {
            @Override
            public void textChange(TextChangeEvent event) {
                String text = event.getText();
                okButton.setEnabled((text != null) && !"".equals(text.trim()));
            }
        });
        m_name.setTextChangeTimeout(250);
        m_name.setTextChangeEventMode(TextChangeEventMode.TIMEOUT);

        HorizontalLayout buttonBar = new HorizontalLayout();
        buttonBar.setSpacing(true);
        buttonBar.addComponent(okButton);
        buttonBar.addComponent(cancelButton);

        VerticalLayout layout = (VerticalLayout) getContent();
        layout.setMargin(true);
        layout.setSpacing(true);
        layout.addComponent(fields);
        layout.addComponent(buttonBar);

        // The components added to the window are actually added to the window's
        // layout; you can use either. Alignments are set using the layout
        layout.setComponentAlignment(buttonBar, Alignment.BOTTOM_RIGHT);

        // Allow direct typing...
        m_name.focus();
    }

    /**
     * Called when the user acknowledges this window by pressing Ok.
     * 
     * @param name
     *            the value of the name field;
     * @param description
     *            the value of the description field.
     * @throws Exception
     *             in case the creation failed.
     */
    protected abstract void onOk(String name, String description) throws Exception;

    /**
     * Sets the focus to the name field.
     */
    private void setRelevantFocus() {
        m_name.focus();
    }
}