net.sf.housekeeper.swing.FoodItemEditorDialog.java Source code

Introduction

Here is the source code for net.sf.housekeeper.swing.FoodItemEditorDialog.java

Source

/*
 * This file is part of Housekeeper.
 * 
 * Housekeeper is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 * 
 * Housekeeper is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * Housekeeper; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA 02111-1307 USA
 * 
 * Copyright 2003-2004, The Housekeeper Project
 * http://housekeeper.sourceforge.net
 */

package net.sf.housekeeper.swing;

import java.awt.event.ActionEvent;

import javax.swing.AbstractAction;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JPanel;
import javax.swing.border.EmptyBorder;

import net.sf.housekeeper.domain.FoodItem;

import com.jgoodies.binding.PresentationModel;
import com.jgoodies.forms.builder.PanelBuilder;
import com.jgoodies.forms.factories.Borders;
import com.jgoodies.forms.factories.ButtonBarFactory;
import com.jgoodies.forms.layout.CellConstraints;
import com.jgoodies.forms.layout.FormLayout;

/**
 * A dialog for editing a FoodItem. Uses a StockItemEditorBuilder to build the
 * editor form and just adds buttons to accept or cancel the edit. These buttons
 * trigger a commit or flush in the underlying PresentationModel.
 * 
 * @author Adrian Gygax
 * @version $Revision$, $Date$
 */
public class FoodItemEditorDialog extends JDialog {

    /**
     * True if the users pressed the cancel button. False otherwise.
     */
    private boolean canceled;

    /**
     * Holds the edited item and vends ValueModels that adapt item properties.
     */
    private final PresentationModel presentationModel;

    /**
     * Created an editor dialog for the specified item.
     * 
     * @param item the item to be edited.
     */
    public FoodItemEditorDialog(final FoodItem item) {
        super(MainFrame.INSTANCE, "Item Editor", true);
        this.presentationModel = new PresentationModel(item);
        canceled = false;
    }

    /**
     * Closes the dialog: makes it invisible and disposes it, which in turn
     * releases all required OS resources.
     */
    public void close() {
        dispose();
    }

    /**
     * Checks and answers whether the dialog has been canceled.
     * 
     * @return true indicates that the dialog has been canceled
     */
    public boolean hasBeenCanceled() {
        return canceled;
    }

    /**
     * Opens the dialog.
     */
    public void open() {
        build();
        canceled = false;
        setVisible(true);
    }

    /**
     * Builds the dialog's content pane and locates it on the screen. The dialog
     * is then ready to be opened.
     */
    private void build() {
        setContentPane(buildContentPane());
        pack();
        setResizable(false);
        setLocationRelativeTo(MainFrame.INSTANCE);
    }

    /**
     * Builds a bar with OK and Cancel buttons.
     * 
     * @return The button bar.
     */
    private JComponent buildButtonBar() {
        JPanel bar = ButtonBarFactory.buildOKCancelBar(new JButton(new OKAction()),
                new JButton(new CancelAction()));
        bar.setBorder(Borders.BUTTON_BAR_GAP_BORDER);
        return bar;
    }

    /**
     * Build the pane consisting of an editor panel and a button bar.
     * 
     * @return the whole editor pane.
     */
    private JComponent buildContentPane() {
        FormLayout layout = new FormLayout("fill:pref", "fill:pref, pref");
        PanelBuilder builder = new PanelBuilder(layout);
        builder.getPanel().setBorder(new EmptyBorder(12, 10, 10, 10));
        CellConstraints cc = new CellConstraints();
        builder.add(buildEditorPanel(), cc.xy(1, 1));
        builder.add(buildButtonBar(), cc.xy(1, 2));
        return builder.getPanel();
    }

    /**
     * Builds a panel with a form for editing an item's properties.
     * 
     * @return a panel with a form for editing an item's properties.
     */
    private JComponent buildEditorPanel() {
        return new FoodItemEditorBuilder(presentationModel).build();
    }

    /**
     * Action for disarding any changes.
     */
    private class CancelAction extends AbstractAction {

        private CancelAction() {
            super("Cancel");
        }

        public void actionPerformed(ActionEvent e) {
            presentationModel.triggerFlush();
            canceled = true;
            close();
        }
    }

    /**
     * Action for accepting any changes.
     */
    private class OKAction extends AbstractAction {

        private OKAction() {
            super("OK");
        }

        public void actionPerformed(ActionEvent e) {
            presentationModel.triggerCommit();
            canceled = false;
            close();
        }
    }
}