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

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.swing.api;

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

import org.gvsig.tools.swing.api.evaluator.ComponentSwingManager;

import org.gvsig.tools.swing.api.reminder.DialogReminderManager;

import org.gvsig.tools.swing.api.task.TaskStatusSwingManager;

import org.gvsig.tools.swing.api.threadsafedialogs.ThreadSafeDialogsManager;

import org.gvsig.tools.swing.api.usability.UsabilitySwingManager;

import org.gvsig.tools.swing.api.windowmanager.WindowManager;

import org.gvsig.tools.swing.icontheme.IconThemeManager;

/**

 * {@link Locator} for the tools swing Library. It returns a reference to the

 * library's main

 * utilities.

 * 

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

 */

public class ToolsSwingLocator extends BaseLocator {

    private static final String LOCATOR_NAME = "Tools.swing.locator";

    public static final String USABILITY_SWING_MANAGER_NAME =

        "Tools.usability.swing.manager";

    public static final String USABILITY_SWING_MANAGER_DESCRIPTION =

        "Tools Usability Swing Manager";

    private static final String TASKSTATUS_SWING_MANAGER_NAME = "Tools.task.swing.manager";

    private static final String TASKSTATUS_SWING_MANAGER_DESCRIPTION = "Tools Task Swing Manager";

    private static final String WINDOW_MANAGER_NAME = "Tools.swing.windowmanager";

    private static final String WINDOW_MANAGER_DESCRIPTION = "Tools Window Manager";

    private static final String ICONTHEME_MANAGER_NAME = "Tools.swing.iconthememanager";

    private static final String ICONTHEME_MANAGER_DESCRIPTION = "Tools Icon Theme Manager";

    private static final String COMPONENT_SWING_MANAGER_NAME = "Tools.swing.componentmanager";

    private static final String COMPONENT_SWING_MANAGER_DESCRIPTION = "Tools Swing Component Manager";

    private static final String THREADSAFEDIALOGS_MANAGER_NAME = "Tools.swing.threadsafedialogs";

    private static final String THREADSAFEDIALOGS_MANAGER_DESCRIPTION = "Thread safe dialogs Manager";

    private static final String SWING_MANAGER_NAME = "Tools.swing.manager";

    private static final String SWING_MANAGER_DESCRIPTION = "Tools Swing Manager";

    public static final String PLUGINS_DIALOGREMINDER_MANAGER_NAME = "DialogReminderManager";

    private static final String PLUGINS_DIALOGREMINDER_MANAGER_DESCRIPTION = "DialogReminderManager";

    /**

     * Unique instance.

     */

    private static final ToolsSwingLocator instance = new ToolsSwingLocator();

    /**

     * Return the {@link Singleton} instance.

     * 

     * @return the {@link Singleton} instance

     */

    public static ToolsSwingLocator getInstance() {

        return instance;

    }

    /**

     * Return the {@link Locator}'s name

     * 

     * @return a String with the {@link Locator}'s name

     */

    @Override

    public String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Gets the instance of the {@link UsabilitySwingManager} registered.

     * 

     * @return {@link UsabilitySwingManager}

     */

    public static UsabilitySwingManager getUsabilitySwingManager() {

        return (UsabilitySwingManager) getInstance().get(

            USABILITY_SWING_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link UsabilitySwingManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link UsabilitySwingManager} interface

     */

    public static void registerUsabilitySwingManager(

        Class<? extends UsabilitySwingManager> clazz) {

        getInstance().register(USABILITY_SWING_MANAGER_NAME,

            USABILITY_SWING_MANAGER_DESCRIPTION, clazz);

    }

    /**

     * Gets the instance of the {@link TaskStatusSwingManager} registered.

     * 

     * @return {@link TaskStatusSwingManager}

     */

    public static TaskStatusSwingManager getTaskStatusSwingManager() {

        return (TaskStatusSwingManager) getInstance().get(

                        TASKSTATUS_SWING_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link TaskStatusSwingManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link TaskStatusSwingManager} interface

     */

    public static void registerTaskStatusSwingManager(

        Class<? extends TaskStatusSwingManager> clazz) {

        getInstance().register(TASKSTATUS_SWING_MANAGER_NAME,

                        TASKSTATUS_SWING_MANAGER_DESCRIPTION, clazz);

    }

    /**

     * Gets the instance of the {@link WindowManager} registered.

     * 

     * @return {@link WindowManager}

     */

    public static WindowManager getWindowManager() {

        return (WindowManager) getInstance().get(

                        WINDOW_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link WindowManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link WindowManager} interface

     */

    public static void registerWindowManager(

        Class<? extends WindowManager> clazz) {

        getInstance().register(WINDOW_MANAGER_NAME,

                        WINDOW_MANAGER_DESCRIPTION, clazz);

    }

    public static void registerDefaultWindowManager(Class clazz) {

            getInstance().registerDefault(WINDOW_MANAGER_NAME, 

                WINDOW_MANAGER_DESCRIPTION,

                clazz);

    }

    /**

     * Gets the instance of the {@link IconThemeManager} registered.

     * 

     * @return {@link IconThemeManager}

     */

    public static IconThemeManager getIconThemeManager() {

        return (IconThemeManager) getInstance().get(

                        ICONTHEME_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link IconThemeManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link IconThemeManager} interface

     */

    public static void registerIconThemeManager(

        Class<? extends IconThemeManager> clazz) {

        getInstance().register(ICONTHEME_MANAGER_NAME,

                        ICONTHEME_MANAGER_DESCRIPTION, clazz);

    }

    public static void registerDefaultIconThemeManager(Class clazz) {

            getInstance().registerDefault(ICONTHEME_MANAGER_NAME, 

                ICONTHEME_MANAGER_DESCRIPTION,

                clazz);

    }

    /**

     * Gets the instance of the {@link ComponentSwingManager} registered.

     * 

     * @return {@link ComponentSwingManager}

     */

    public static ComponentSwingManager getComponentSwingManager() {

        return (ComponentSwingManager) getInstance().get(

            COMPONENT_SWING_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link ComponentSwingManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link ComponentSwingManager} interface

     */

    public static void registerComponentSwingManager(

        Class<? extends ComponentSwingManager> clazz) {

        getInstance().register(

            COMPONENT_SWING_MANAGER_NAME,

            COMPONENT_SWING_MANAGER_DESCRIPTION, clazz);

    }

    /**

     * Gets the instance of the {@link ThreadSafeDialogsManager} registered.

     * 

     * @return {@link ThreadSafeDialogsManager}

     */

    public static ThreadSafeDialogsManager getThreadSafeDialogsManager() {

        return (ThreadSafeDialogsManager) getInstance().get(

                        THREADSAFEDIALOGS_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link ThreadSafeDialogsManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link ThreadSafeDialogsManager} interface

     */

    public static void registerThreadSafeDialogsManager(

        Class<? extends ThreadSafeDialogsManager> clazz) {

        getInstance().register(THREADSAFEDIALOGS_MANAGER_NAME,

                        THREADSAFEDIALOGS_MANAGER_DESCRIPTION, clazz);

    }

    public static void registerDefaultThreadSafeDialogsManager(Class clazz) {

            getInstance().registerDefault(THREADSAFEDIALOGS_MANAGER_NAME, 

                THREADSAFEDIALOGS_MANAGER_DESCRIPTION,

                clazz);

    }

    /**

     * Gets the instance of the {@link ToolsSwingManager} registered.

     * 

     * @return {@link ToolsSwingManager}

     */

    public static ToolsSwingManager getToolsSwingManager() {

        return (ToolsSwingManager) getInstance().get(

                        SWING_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link ToolsSwingManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link ToolsSwingManager} interface

     */

    public static void registerToolsSwingManager(

        Class<? extends ToolsSwingManager> clazz) {

        getInstance().register(SWING_MANAGER_NAME,

                        SWING_MANAGER_DESCRIPTION, clazz);

    }

        //Dialog reminder

    public static DialogReminderManager getDialogReminderManager() throws LocatorException {

        return (DialogReminderManager) getInstance().get(PLUGINS_DIALOGREMINDER_MANAGER_NAME);

    }

    public static void registerDialogReminderManager(Class clazz) {

        getInstance().register(PLUGINS_DIALOGREMINDER_MANAGER_NAME, PLUGINS_DIALOGREMINDER_MANAGER_DESCRIPTION,

                clazz);

    }

    public static void registerDefaultDialogReminderManager(Class clazz) {

            getInstance().registerDefault(PLUGINS_DIALOGREMINDER_MANAGER_NAME, PLUGINS_DIALOGREMINDER_MANAGER_DESCRIPTION,

        clazz);

    }

}