Application: gvSIG desktop » Library: org.gvsig.tools

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program 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.

 * 

 * This program 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 this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {}  {{Task}}

 */

package org.gvsig.tools.swing.api.usability;

import java.awt.Component;

import java.awt.event.FocusListener;

import java.util.Locale;

import javax.swing.Action;

import javax.swing.Icon;

import javax.swing.JButton;

import javax.swing.JSpinner;

import javax.swing.JTextArea;

import org.gvsig.tools.dynobject.DynField;

/**

 * Creates common Swing components which take into account usability guides

 * defined for the gvSIG project.

 * 

 * @author 2010- C?sar Ordi?ana - gvSIG team

 */

public interface UsabilitySwingManager {

    /**

     * Creates a button with no set text or icon.

     * 

     * @return a button.

     */

    JButton createJButton();

    /**

     * Creates a button where properties are taken from the {@link Action}

     * supplied.

     * 

     * @param action

     *            the {@link Action} used to specify the new button.

     * 

     */

    JButton createJButton(Action action);

    /**

     * Creates a button with an icon.

     * 

     * @param icon

     *            the Icon image to display on the button.

     * 

     * @return a button.

     */

    JButton createJButton(Icon icon);

    /**

     * Creates a button with text.

     * 

     * @param text

     *            the text of the button.

     * 

     * @return a button.

     */

    JButton createJButton(String text);

    /**

     * Creates a button with initial text and icon.

     * 

     * @param text

     *            the text of the button.

     * @param icon

     *            the Icon image to display on the button.

     * 

     * @return a button.

     */

    JButton createJButton(String text, Icon icon);

    /**

     * Creates a tool button with text.

     * 

     * @param text

     *            the text of the tool button.

     * 

     * @return a tool button.

     */

    JButton createJToolButton(String text);

    /**

     * Creates a text area.

     * 

     * @param text

     *            the text component

     *             

     * @return a tool button.

     */

    JTextArea createJTextArea(String text);

    /**

     * Creates a text area with a default maximum width.

     * 

     * @param text

     *            the text component

     * @param text

     *            the text component

     *             

     * @return a tool button.

     */

    JTextArea createJTextArea(String text, int filledMaximumWidth);

    /**

     * Creates a spinner component that allows null values. It distinguishes between

     *   number, date and floating point models based on their dataType.

     * 

     * @param text

     *            the text component

     * @param value

     *            the initial value  

     * 

     * @param value

     *            the maximum filling size  

     *                  

     * @return a spinner GUI component.

     */

    JSpinner createJNullSpinner(int dataType, Object value, int filledMaximumWidth);

    /**

     * Creates a spinner component that allows null values. It distinguishes between

     *   number, date and floating point models based on their dataType.

     * 

     * @param int

     *            the data type of dynobjectmanager.

     * @param value

     *            the initial value        

     * @return a spinner GUI component.

     */

    JSpinner createJNullSpinner(int dataType, Object value);

    DynFieldEditor createNullSpinnerEditor(FocusListener listener, DynField dynField, Locale locale);

        /**

         * Creates a JBlank panel

         * 

         * @param width

         * @param height

         * @return

         */

        Component createJBlank(int width, int height);

}