Application: gvSIG desktop » gvSIG tools: HyperLink

/* 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.hyperlink.app.extension;

import java.util.Map;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.andami.IconThemeHelper;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.plugins.Extension;

import org.gvsig.andami.ui.mdiManager.IWindow;

import org.gvsig.app.project.documents.view.ViewDocument;

import org.gvsig.app.project.documents.view.gui.IView;

import org.gvsig.app.project.documents.view.legend.gui.ThemeManagerWindow;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.fmap.mapcontext.layers.FLayers;

import org.gvsig.fmap.mapcontext.layers.LayersIterator;

import org.gvsig.fmap.mapcontext.layers.vectorial.FLyrVect;

import org.gvsig.fmap.mapcontrol.MapControl;

import org.gvsig.fmap.mapcontrol.tools.Behavior.PointBehavior;

import org.gvsig.hyperlink.app.extension.actions.ImgFormat;

import org.gvsig.hyperlink.app.extension.actions.PdfFormat;

import org.gvsig.hyperlink.app.extension.actions.SvgFormat;

import org.gvsig.hyperlink.app.extension.actions.TxtFormat;

import org.gvsig.hyperlink.app.extension.config.LayerLinkConfig;

import org.gvsig.hyperlink.app.extension.config.LinkConfig;

import org.gvsig.hyperlink.app.extension.config.gui.ConfigTab;

import org.gvsig.hyperlink.app.extension.layers.ManagerRegistry;

import org.gvsig.hyperlink.app.extension.layers.VectLayerManager;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.extensionpoint.ExtensionPoint;

import org.gvsig.tools.extensionpoint.ExtensionPointManager;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.util.Caller;

import org.gvsig.tools.util.impl.DefaultCaller;

/**

 * Andami extension to show Hyperlink in the application.

 * 

 * @author gvSIG Team

 * @version $Id$

 */

public class HyperlinkExtension extends Extension {

    private static final Logger LOG = LoggerFactory

        .getLogger(HyperlinkExtension.class);

    ManagerRegistry layerManager;

    public static final String LAYERPROPERTYNAME = "org.gvsig.hyperlink.config";

    public static final String TOOLNAME = "org.gvsig.hyperlink.tool";

    public static final String ACTIONSEXTENSIONPOINT = "HyperLinkAction";

    private static final int LEGACY_IMAGE_TYPE = 0;

    private static final int LEGACY_HTML_TYPE = 1;

    private static final int LEGACY_PDF_TYPE = 2;

    private static final int LEGACY_SVG_TYPE = 3;

    /**

     * @see com.iver.andami.plugins.IExtension#execute(java.lang.String)

     */

    public void execute(String s) {

        IView view = (IView) PluginServices.getMDIManager().getActiveWindow();

        MapControl mapCtrl = view.getMapControl();

        LOG.debug("Comand : " + s);

        if (s.compareTo("view-show-hyperlink") == 0) {

            initTool(view);

            mapCtrl.setTool(TOOLNAME);

        }

    }

    /**

     * Inits the tool for the provided view.

     * 

     * @param view

     */

    public void initTool(IView view) {

        MapControl mapCtrl = view.getMapControl();

        if (view.getMapControl().getNamesMapTools().get(TOOLNAME) == null) {

            mapCtrl.addBehavior(TOOLNAME,

                new PointBehavior(new LinkListener(mapCtrl, layerManager)));

            loadLegacyConfig(view);

        }

    }

    public void loadLegacyConfig(IView view) {

        LayersIterator iterator =

            new LayersIterator(view.getMapControl().getMapContext().getLayers());

        while (iterator.hasNext()) {

            FLayer layer = iterator.nextLayer();

            loadLegacyConfig(layer);

        }

    }

    /**

     * Returns a LayerLinkConfig object if an old-style or new-style hyperlink

     * was found and configured,

     * or null otherwise.

     * 

     * @param layer

     */

    public LayerLinkConfig loadLegacyConfig(FLayer layer) {

        LayerLinkConfig layerConfig =

            (LayerLinkConfig) layer.getProperty(LAYERPROPERTYNAME);

        if (layerConfig != null) { // don't apply compatibility if the layer

                                   // already has new 1.9.0 configuration

            return layerConfig;

        }

        Object fName = layer.getProperty("legacy.hyperlink.selectedField");

        if (fName != null && fName instanceof String) {

            Map properties = layer.getExtendedProperties();

            properties.remove("legacy.hyperlink.selectedField");

            // remove it from layer to don't keep legacy properties for ever

            // in the project

            String fieldName = (String) fName;

            Object extObj = layer.getProperty("legacy.hyperlink.extension");

            String extension = null;

            if (extObj != null && extObj instanceof String) {

                properties.remove("legacy.hyperlink.extension");

                // remove it from layer to don't keep legacy properties for ever

                // in the project

                extension = (String) extObj;

            }

            Object typeObj = layer.getProperty("legacy.hyperlink.type");

            int type = -1;

            if (typeObj != null && typeObj instanceof Integer) {

                properties.remove("legacy.hyperlink.type"); 

                // remove it from layer to don't keep legacy properties for ever

                // in the project

                type = ((Integer) typeObj).intValue();

            }

            LayerLinkConfig config = new LayerLinkConfig();

            config.setEnabled(true);

            config.addLink(getLegacyActionCode(type), fieldName, extension);

            layer.setProperty(LAYERPROPERTYNAME, config);

            return config;

        }

        return null;

    }

    private String getLegacyActionCode(int type) {

        switch (type) {

        case LEGACY_IMAGE_TYPE:

            return ImgFormat.actionCode;

        case LEGACY_PDF_TYPE:

            return PdfFormat.actionCode;

        case LEGACY_SVG_TYPE:

            return SvgFormat.actionCode;

        case LEGACY_HTML_TYPE:

        default:

            return TxtFormat.actionCode;

        }

    }

    /**

     * @see com.iver.mdiApp.plugins.IExtension#isVisible()

     */

    public boolean isVisible() {

        IWindow f = PluginServices.getMDIManager().getActiveWindow();

        if (f == null) {

            return false;

        }

        if (f instanceof IView) {

            MapContext mapa = ((IView) f).getViewDocument().getMapContext();

            return mapa.getLayers().getLayersCount() > 0;

        } else {

            return false;

        }

    }

    /**

     * @see com.iver.andami.plugins.IExtension#isEnabled()

     */

    public boolean isEnabled() {

        IWindow window = PluginServices.getMDIManager().getActiveWindow();

        if (window == null) {

            return false;

        }

        if (window instanceof IView) {

            IView view = (IView) window;

            ViewDocument viewDocument = view.getViewDocument();

            if (viewDocument != null

                && viewDocument.getMapContext() != null

                && viewDocument.getMapContext().getLayers().getVisibles().length > 0) {

                    FLayers lyrs = viewDocument.getMapContext().getLayers();

                    FLayer[] lyrsSelected = lyrs.getActives();

                    for (int i = 0; i < lyrsSelected.length; i++) {

                            Object obj = lyrsSelected[i].getProperty(HyperlinkExtension.LAYERPROPERTYNAME);

                                        if(obj != null)

                                                return true;

                                }

            } 

        }

        return false;

    }

    public void postInitialize() {

        Caller caller = new DefaultCaller();

        caller.add(new LinkConfig.RegisterPersistence());

        caller.add(new LayerLinkConfig.RegisterPersistence());

        if( !caller.call() ) {

            throw new LibraryException(HyperlinkExtension.class, caller.getExceptions());

        }

        registerLayers();

        registerActions();

        registerConfigPanel();

    }

    private void registerLayers() {

        layerManager = new ManagerRegistry();

        layerManager.put(FLyrVect.class, VectLayerManager.class);

    }

    public ManagerRegistry getLayerManager() {

        return layerManager;

    }

    private void registerActions() {

        ExtensionPointManager epm = ToolsLocator.getExtensionPointManager();

        ExtensionPoint ep =

            epm.add(ACTIONSEXTENSIONPOINT,

                "Registers Actions that are able to manage specific format types.");

        ep.append(TxtFormat.actionCode, "", TxtFormat.class);

        ep.append(ImgFormat.actionCode, "", ImgFormat.class);

        ep.append(PdfFormat.actionCode, "", PdfFormat.class);

        ep.append(SvgFormat.actionCode, "", SvgFormat.class);

    }

    private void registerConfigPanel() {

        // pages

        ThemeManagerWindow.addPage(ConfigTab.class);

        ThemeManagerWindow.setTabEnabledForLayer(ConfigTab.class,

            FLyrVect.class,

            true);

    }

    public void initialize() {

        IconThemeHelper.registerIcon("action",

            "view-show-hyperlink", this);

        IconThemeHelper.registerIcon("cursor",

            "cursor-view-show-hyperlink", this);

    }

}