/* $Id: ArgoDialog.java 17887 2010-01-12 21:17:18Z linus $
*****************************************************************************
* Copyright (c) 2009 Contributors - see below
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* mvw
*****************************************************************************
*
* Some portions of this file was previously release using the BSD License:
*/
// Copyright (c) 2003-2007 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
package org.argouml.util;
import java.awt.Frame;
import javax.swing.AbstractButton;
import org.argouml.i18n.Translator;
import org.tigris.swidgets.Dialog;
/**
* A dialog with localized buttons. <p>
*
* This class needs to initialized with
* a pointer to the Frame
* that shall be used for showing the Dialog.
*
* @author Bob Tarling
*/
public class ArgoDialog extends Dialog {
private static Frame frame;
/**
* Suffix to calculate the mnemonic key from the key.
*/
private static final String MNEMONIC_KEY_SUFFIX = ".mnemonic";
/**
* @param f The frame to set.
*/
public static void setFrame(Frame f) {
ArgoDialog.frame = f;
}
/**
* Creates a new ArgoDialog with the default optionType.
*
* @param title The title String for the dialog.
* @param modal <code>true</code> if the dialog is modal.
* @see Dialog#Dialog(Frame, String, boolean)
*/
public ArgoDialog(String title, boolean modal) {
super(frame, title, modal);
init();
}
/**
* Creates a new ArgoDialog with the specified optionType.
*
* @param title The title String for the dialog.
* @param optionType Defines which buttons will be available in the dialog.
* @param modal <code>true</code> if the dialog is modal.
* @see Dialog#Dialog(Frame, String, int, boolean)
*/
public ArgoDialog(String title, int optionType, boolean modal) {
super(frame, title, optionType, modal);
init();
}
/*
* @see org.tigris.swidgets.Dialog#nameButtons()
*/
protected void nameButtons() {
nameButton(getOkButton(), "button.ok");
nameButton(getCancelButton(), "button.cancel");
nameButton(getCloseButton(), "button.close");
nameButton(getYesButton(), "button.yes");
nameButton(getNoButton(), "button.no");
nameButton(getHelpButton(), "button.help");
}
/**
* Allocates names for a button.
*
* @param button The button to give names.
* @param key The key used to localize the button.
*/
protected void nameButton(AbstractButton button, String key) {
if (button != null) {
button.setText(Translator.localize(key));
String mnemonic =
Translator.localize(key + MNEMONIC_KEY_SUFFIX);
if (mnemonic != null && mnemonic.length() > 0) {
button.setMnemonic(mnemonic.charAt(0));
}
}
}
private void init() {
UIUtils.loadCommonKeyMap(this);
}
}