net.sf.juife.swing.OkCancelDialog Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of juife-swing Show documentation
Show all versions of juife-swing Show documentation
juife - Swing User Interface Framework Extensions
/*
* juife - Java User Interface Framework Extensions
*
* Copyright (C) 2005-2007 Grigor Iliev
*
* This file is part of juife.
*
* juife is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation.
*
* juife 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with juife; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA
*/
package net.sf.juife.swing;
import java.awt.BorderLayout;
import java.awt.Container;
import java.awt.Dialog;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JPanel;
import static net.sf.juife.JuifeI18n.i18n;
/**
* This class can be used to simplify the creation of dialogs with 'OK' and 'Cancel' buttons.
* To create a dialog you only need to specify a Container that will be used as
* a main pane in the dialog and to implement the
* {@link EnhancedDialog#onOk} and {@link EnhancedDialog#onCancel} methods.
* The main pane can be set either by using one of
* the following constructors to create the dialog
*
* - {@link #OkCancelDialog(Frame owner, Container mainPane)}
*
- {@link #OkCancelDialog(Frame owner, String title, Container mainPane)}
*
- {@link #OkCancelDialog(Frame owner, String title, Container mainPane, boolean modal)}
*
- {@link #OkCancelDialog(Dialog owner, Container mainPane)}
*
- {@link #OkCancelDialog(Dialog owner, String title, Container mainPane)}
*
- {@link #OkCancelDialog(Dialog owner, String title, Container mainPane, boolean modal)}
*
* or by using the {@link #setMainPane} method.
*
* @author Grigor Iliev
*/
public abstract class OkCancelDialog extends EnhancedDialog {
private final JPanel pane = new JPanel(new BorderLayout());
protected final JButton btnOk = new JButton(i18n.getButtonLabel("ok"));
protected final JButton btnCancel = new JButton(i18n.getButtonLabel("cancel"));
/**
* Creates a modal dialog without a title and with the specified
* Frame as its owner.
* @param owner Specifies the Frame from which this dialog is displayed.
*/
public
OkCancelDialog(Frame owner) { this(owner, new Container()); }
/**
* Creates a modal dialog with the specified title and owner Frame.
* @param owner Specifies the Frame from which this dialog is displayed.
* @param title The text to be displayed in the dialog's title bar.
*/
public
OkCancelDialog(Frame owner, String title) { this(owner, title, new Container()); }
/**
* Creates a modal dialog without a title and with the specified owner and main pane.
* @param owner Specifies the Frame from which this dialog is displayed.
* @param mainPane A non-null Container instance that will be used
* as a main pane for this dialog.
* @throws IllegalArgumentException If mainPane is null.
*/
public
OkCancelDialog(Frame owner, Container mainPane) { this(owner, "", mainPane); }
/**
* Creates a modal dialog with the specified title, owner and main pane.
* @param owner Specifies the Frame from which this dialog is displayed.
* @param title The text to be displayed in the dialog's title bar.
* @param mainPane A non-null Container instance that will be used
* as a main pane for this dialog.
* @throws IllegalArgumentException If mainPane is null.
*/
public
OkCancelDialog(Frame owner, String title, Container mainPane) {
this(owner, title, mainPane, true);
}
/**
* Creates a modal or non-modal dialog with the specified title, owner and main pane.
* @param owner Specifies the Frame from which this dialog is displayed.
* @param title The text to be displayed in the dialog's title bar.
* @param mainPane A non-null Container instance that will be used
* as a main pane for this dialog.
* @param modal Specifies whether this dialog should be modal or not.
* @throws IllegalArgumentException If mainPane is null.
*/
public
OkCancelDialog(Frame owner, String title, Container mainPane, boolean modal) {
super(owner, title, modal);
initOkCancelDialog();
setMainPane(mainPane);
}
/**
* Creates a modal dialog without a title and with the specified
* Dialog as its owner.
* @param owner Specifies the Dialog from which this dialog is displayed.
*/
public
OkCancelDialog(Dialog owner) { this(owner, new Container()); }
/**
* Creates a modal dialog with the specified title and owner Dialog.
* @param owner Specifies the Dialog from which this dialog is displayed.
* @param title The text to be displayed in the dialog's title bar.
*/
public
OkCancelDialog(Dialog owner, String title) { this(owner, title, new Container()); }
/**
* Creates a modal dialog without a title and with the specified owner and main pane.
* @param owner Specifies the Dialog from which this dialog is displayed.
* @param mainPane A non-null Container instance that will be used
* as a main pane for this dialog.
* @throws IllegalArgumentException If mainPane is null.
*/
public
OkCancelDialog(Dialog owner, Container mainPane) { this(owner, "", mainPane); }
/**
* Creates a modal dialog with the specified title, owner and main pane.
* @param owner Specifies the Dialog from which this dialog is displayed.
* @param title The text to be displayed in the dialog's title bar.
* @param mainPane A non-null Container instance that will be used
* as a main pane for this dialog.
* @throws IllegalArgumentException If mainPane is null.
*/
public
OkCancelDialog(Dialog owner, String title, Container mainPane) {
this(owner, title, mainPane, true);
}
/**
* Creates a modal or non-modal dialog with the specified title, owner and main pane.
* @param owner Specifies the Dialog from which this dialog is displayed.
* @param title The text to be displayed in the dialog's title bar.
* @param mainPane A non-null Container instance that will be used
* as a main pane for this dialog.
* @param modal Specifies whether this dialog should be modal or not.
* @throws IllegalArgumentException If mainPane is null.
*/
public
OkCancelDialog(Dialog owner, String title, Container mainPane, boolean modal) {
super(owner, title, modal);
initOkCancelDialog();
setMainPane(mainPane);
}
/** Used for initial initialization of the dialog */
private void
initOkCancelDialog() {
pane.setBorder(BorderFactory.createEmptyBorder(12, 12, 12, 12));
add(pane, BorderLayout.CENTER);
// Set preferred size for Ok & Cancel buttons
Dimension d = JuifeUtils.getUnionSize(btnOk, btnCancel);
btnOk.setPreferredSize(d);
btnOk.setMaximumSize(d);
btnCancel.setPreferredSize(d);
btnCancel.setMaximumSize(d);
JPanel btnPane = new JPanel();
btnPane.setLayout(new BoxLayout(btnPane, BoxLayout.X_AXIS));
btnPane.add(Box.createGlue());
btnPane.add(btnOk);
btnPane.add(Box.createRigidArea(new Dimension(5, 0)));
btnPane.add(btnCancel);
btnPane.setBorder(BorderFactory.createEmptyBorder(17, 0, 0, 0));
pane.add(btnPane, BorderLayout.SOUTH);
pack();
setResizable(false);
setLocation(JuifeUtils.centerLocation(this, getOwner()));
btnCancel.addActionListener(new ActionListener() {
public void
actionPerformed(ActionEvent e) {
setCancelled(true);
onCancel();
}
});
btnOk.addActionListener(new ActionListener() {
public void
actionPerformed(ActionEvent e) {
setCancelled(false);
onOk();
}
});
}
/**
* Sets the main pane of this dialog and centers the dialog relatvely to its owner.
* @param mainPane A non-null Container instance that will be used
* as a main pane for this dialog.
* @throws IllegalArgumentException If mainPane is null.
*/
public void
setMainPane(Container mainPane) {
if(mainPane == null)
throw new IllegalArgumentException("mainPane must be non null");
pane.add(mainPane, BorderLayout.CENTER);
pack();
setLocation(JuifeUtils.centerLocation(this, getOwner()));
}
}