// $Id: ArgoDialog.java,v 1.13 2004/08/09 05:48:35 linus Exp $
// Copyright (c) 2003-2004 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.ui;

import java.awt.Frame;

import javax.swing.AbstractButton;

import org.argouml.i18n.Translator;
import org.argouml.swingext.Dialog;

/**
 * A dialog with localized buttons.
 *
 * @author Bob Tarling
 */
public class ArgoDialog extends Dialog {
    
    /**
     * Suffix to calculate the mnemonic key from the key.
     *
     * @deprecated by Linus Tolke as of 0.17.1. 
     *             Use the {@link #nameButton(AbstractButton, String)} call
     *             to do this translation. This will become private.
     */
    protected static final String MNEMONIC_KEY_SUFFIX = ".mnemonic";
    
    /**
     * @see Dialog#Dialog(Frame, String, boolean)
     *
     * Creates a new ArgoDialog with the default optionType.
     */
    public ArgoDialog(Frame owner, String title, boolean modal) {
        super(owner, title, modal);
    }

    /**
     * @see Dialog#Dialog(Frame, String, int, boolean)
     *
     * Creates a new ArgoDialog with the specified optionType.
     */
    public ArgoDialog(Frame owner,
		      String title, int optionType, boolean modal)
    {
        super(owner, title, optionType, modal);
    }
        
    /**
     * @see org.argouml.swingext.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));
            }
        }
    }
}