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.

 * 

 */

package org.gvsig.tools.swing.api;

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.swing.api.dynobject.DynObjectSwingManager;

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

/**

 * {@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 DYNOBJECT_SWING_MANAGER_NAME =

        "Tools.dynobject.swing.manager";

    public static final String DYNOBJECT_SWING_MANAGER_DESCRIPTION =

        "Tools DynObject Swing Manager";

    public static final String USABILITY_SWING_MANAGER_NAME =

        "Tools.usability.swing.manager";

    public static final String USABILITY_SWING_MANAGER_DESCRIPTION =

        "Tools Usability Swing Manager";

    /**

     * Unique instance.

     */

    private static final ToolsSwingLocator instance = new ToolsSwingLocator();

    /**

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

     * 

     * @return {@link DynObjectSwingManager}

     */

    public static DynObjectSwingManager getDynObjectSwingManager() {

        return (DynObjectSwingManager) getInstance().get(

            DYNOBJECT_SWING_MANAGER_NAME);

    }

    /**

     * Return the {@link Singleton} instance.

     * 

     * @return the {@link Singleton} instance

     */

    public static ToolsSwingLocator getInstance() {

        return instance;

    }

    /**

     * 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 DynObjectSwingManager}

     * interface.

     * 

     * @param clazz

     *            implementing the {@link DynObjectSwingManager} interface

     */

    public static void registerDynObjectSwingManager(

        Class<? extends DynObjectSwingManager> clazz) {

        getInstance().register(DYNOBJECT_SWING_MANAGER_NAME,

            DYNOBJECT_SWING_MANAGER_DESCRIPTION, clazz);

    }

    /**

     * 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);

    }

    /**

     * Return the {@link Locator}'s name

     * 

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

     */

    @Override

    public String getLocatorName() {

        return LOCATOR_NAME;

    }

}