Application: gvSIG desktop » gvSIG tools: HyperLink

<?xml version="1.0" encoding="ISO-8859-1"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <artifactId>org.gvsig.hyperlink.app.extension</artifactId>

  <packaging>jar</packaging>

  <name>${project.artifactId}</name>

  <parent>

    <groupId>org.gvsig</groupId>

    <artifactId>org.gvsig.hyperlink.app</artifactId>

    <version>1.0.156</version>

  </parent>

  <dependencies>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.andami</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.i18n</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.tools.lib</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.fmap.control</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.fmap.mapcontext.api</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.fmap.geometry.api</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.app.mainplugin</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.fmap.dal.api</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.projection.api</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.utils</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.metadata.lib.basic.api</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.ui</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.slf4j</groupId>

      <artifactId>slf4j-api</artifactId>

      <scope>compile</scope>

    </dependency>

    <!-- External libraries -->

    <dependency>

      <groupId>org.jpedal</groupId>

      <artifactId>jpedal_lgpl</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>com.sun</groupId>

      <artifactId>jimi</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.apache.xmlgraphics</groupId>

      <artifactId>batik-gvt</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.apache.xmlgraphics</groupId>

      <artifactId>batik-bridge</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>org.apache.xmlgraphics</groupId>

      <artifactId>batik-script</artifactId>

      <scope>compile</scope>

    </dependency>

    <dependency>

      <groupId>xml-apis</groupId>

      <artifactId>xml-apis-ext</artifactId>

      <scope>compile</scope>

    </dependency>

  </dependencies>

  <build>

    <plugins>

      <plugin>

        <!-- Set java compatibility -->

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-compiler-plugin</artifactId>

        <configuration>

          <source>1.6</source>

          <target>1.6</target>

          <encoding>ISO-8859-1</encoding>

        </configuration>

      </plugin>

<!--

      <plugin>

        <groupId>org.codehaus.mojo</groupId>

        <artifactId>animal-sniffer-maven-plugin</artifactId>

        <executions>

          <execution>

            <id>check-java-api</id>

            <phase>package</phase>

            <goals>

              <goal>check</goal>

            </goals>

            <configuration>

              <skip>false</skip>

              <signature>

                <groupId>org.codehaus.mojo.signature</groupId>

                <artifactId>java16</artifactId>

                <version>1.0</version>

              </signature>

            </configuration>

          </execution>

        </executions>

      </plugin>

-->

    </plugins>

  </build>

  <properties>

    <gvsig.package.info.name>Tools: Hyperlink</gvsig.package.info.name>

    <gvsig.package.info.state>testing</gvsig.package.info.state>

    <gvsig.package.info.categories>View</gvsig.package.info.categories>

    <gvsig.package.info.official>true</gvsig.package.info.official>

    <gvsig.package.info.dependencies>required: org.gvsig.app.mainplugin -ge 2</gvsig.package.info.dependencies>

    <gvsig.package.info.poolURL>https://devel.gvsig.org/download/projects/gvsig-hyperlink/pool</gvsig.package.info.poolURL>

    <gvsig.package.info.javaVM>j1_6</gvsig.package.info.javaVM>

  </properties>

</project>

#Fri Dec 10 01:59:30 CET 2021

buildNumber=2243

<assembly>

  <id>gvsig-plugin-package</id>

  <formats>

    <format>zip</format>

  </formats>

  <baseDirectory>${project.artifactId}</baseDirectory>

  <includeBaseDirectory>true</includeBaseDirectory>

  <files>

    <file>

      <source>target/${project.artifactId}-${project.version}.jar</source>

      <outputDirectory>lib</outputDirectory>

    </file>

    <file>

      <source>target/package.info</source>

    </file>

  </files>

  <fileSets>

    <fileSet>

      <directory>src/main/resources-plugin</directory>

      <outputDirectory>.</outputDirectory>

    </fileSet>

  </fileSets>

<!-- org.gvsig.app.mainplugin provides these libraries

  <dependencySets>

    <dependencySet>

      <useProjectArtifact>false</useProjectArtifact>

      <useTransitiveDependencies>false</useTransitiveDependencies>

      <outputDirectory>lib</outputDirectory>

      <includes>

            <include>org.jpedal:jpedal_lgpl</include>

            <include>com.sun:jimi</include>

            <include>org.apache.xmlgraphics:batik-gvt</include>

            <include>org.apache.xmlgraphics:batik-bridge</include>

            <include>org.apache.xmlgraphics:batik-script</include>

            <include>xml-apis:xml-apis-ext</include>

      </includes>

    </dependencySet>

  </dependencySets>

-->

</assembly>

/* 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.ExternTxtFormat;

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

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(ExternTxtFormat.actionCode, "", ExternTxtFormat.class);

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

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

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

        ep.append(FolderFormat.actionCode, "", FolderFormat.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);

    }

}

/* 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.awt.Cursor;

import java.awt.Image;

import java.awt.Point;

import java.awt.Toolkit;

import java.awt.geom.Point2D;

import java.net.URI;

import org.gvsig.andami.IconThemeHelper;

import org.gvsig.andami.PluginServices;

import org.gvsig.app.project.documents.view.toolListeners.InfoListener;

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

import org.gvsig.fmap.mapcontrol.MapControl;

import org.gvsig.fmap.mapcontrol.tools.BehaviorException;

import org.gvsig.fmap.mapcontrol.tools.Events.PointEvent;

import org.gvsig.fmap.mapcontrol.tools.Listeners.PointListener;

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

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

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

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

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.extensionpoint.ExtensionPoint;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Listener that implements PointListener to show the information of the

 * HyperLink of the layer,

 * if the actual layer allows it. When the user selects the tool and make one

 * clic with

 * the mouse throws an event to create Panels with the information of the

 * associated HyperLink

 * to the layer. Creates one panel for URI provided, to load the information.

 * 

 * @author Vicente Caballero Navarro

 * @author Cesar Martinez Izqueirdo

 * 

 */

public class LinkListener implements PointListener {

    private static Logger logger = LoggerFactory.getLogger(InfoListener.class);

    private Cursor cur = null;

    private MapControl mapCtrl;

    private ManagerRegistry registry;

//    private Image imageCursor = null;

    public static final int TYPELINKIMAGE = 0;

    public static final int TYPELINKTEXT = 1;

    public ExtensionPoint formatManagers;

    /**

     * Creates a new LinkListener

     * 

     * @param mc

     *            mapControl

     */

    public LinkListener(MapControl mc, ManagerRegistry registry) {

        this.mapCtrl = mc;

        this.registry = registry;

        formatManagers =

            ToolsLocator.getExtensionPointManager()

                .get(HyperlinkExtension.ACTIONSEXTENSIONPOINT);

        initialize();

    }

    private void initialize() {

        cur = Toolkit.getDefaultToolkit().createCustomCursor(this.getImageCursor(),

                    new Point(16, 16),

                    "Hyperlink");

    }

    /**

     * Creates one LinkPanel for URI provided. Gets the active layers and

     * invokes getLink

     * with the catched point and the allowed tolerance if these layers allows

     * HyperLinks.

     * getLink provides an array of URIs, this method is invoked for all active

     * layers.

     * 

     * @param event

     *            PointEvent

     * @throws BehaviorException

     * 

     * @see com.iver.cit.gvsig.fmap.tools.Listeners.PointListener#point(com.iver.cit.gvsig.fmap.tools.Events.PointEvent)

     */

    @Override

    public void point(PointEvent event) throws BehaviorException {

        Point2D pReal =

            mapCtrl.getMapContext().getViewPort().toMapPoint(event.getPoint());

        FLayer[] sel = mapCtrl.getMapContext().getLayers().getVisibles();

        LinkTarget[] links = null;

        LinkConfig linkConfig;

        ILinkLayerManager layerManager;

        ILinkActionManager actionManager;

        for (int layerCount = 0; layerCount < sel.length; layerCount++) {

            FLayer theLayer = sel[layerCount];

            if (!registry.hasManager(theLayer)) {

                continue;

            }

            try {

                layerManager = registry.get(theLayer);

                if (theLayer.getProperty(HyperlinkExtension.LAYERPROPERTYNAME) != null

                    && theLayer.getProperty(HyperlinkExtension.LAYERPROPERTYNAME) instanceof LayerLinkConfig) {

                    LayerLinkConfig layerLink =

                        (LayerLinkConfig) theLayer.getProperty(HyperlinkExtension.LAYERPROPERTYNAME);

                    if (layerLink.isEnabled() && layerLink.linkCount() > 0) { 

                        // there is

                                                                              // some

                                                                              // link

                                                                              // configured

                                                                              // for

                                                                              // this

                                                                              // layer

                        double tol = mapCtrl.getViewPort().toMapDistance(3);

                        for (int actionCount = 0; actionCount < layerLink.linkCount(); actionCount++) {

                            linkConfig = layerLink.getLink(actionCount);

                            links =

                                layerManager.getLink(pReal,

                                    tol,

                                    linkConfig.getFieldName(),

                                    linkConfig.getExtension());

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

                                if (links[i] != null) {

                                    actionManager =

                                        (ILinkActionManager) formatManagers.get(linkConfig.getActionCode())

                                            .getExtension()

                                            .newInstance();

                                    if (actionManager == null) {

                                        logger.warn("Hyperlink error -- invalid action code: "

                                            + linkConfig.getActionCode());

                                        continue;

                                    }

                                    if (actionManager.hasPanel()) {

                                        ShowPanel lpanel =

                                            new ShowPanel(actionManager.createPanel(links[i]));

                                        // show the panel

                                        PluginServices.getMDIManager()

                                            .addWindow(lpanel);

                                    } else { // delegate in the format manager

                                             // to show the file

                                        actionManager.showDocument(links[i]);

                                    }

                                }

                            }

                        }

                    }

                }

            } catch (ClassNotFoundException e) {

                throw new BehaviorException("Hyperlink: There is no manager for this layer type",

                    e);

            } catch (InstantiationException e) {

                logger.error("Hyperlink error: " + e.getMessage(), e);

            } catch (IllegalAccessException e) {

                logger.error("Hyperlink error: " + e.getMessage(), e);

            } catch (IncompatibleLayerException e) {

                throw new BehaviorException("Hyperlink: There is no manager for this layer type",

                    e);

            }

        }

    }

    /**

     * @see com.iver.cit.gvsig.fmap.tools.Listeners.ToolListener#getCursor()

     */

    public Cursor getCursor() {

        return cur;

    }

    /**

     * @see com.iver.cit.gvsig.fmap.tools.Listeners.ToolListener#cancelDrawing()

     */

    @Override

    public boolean cancelDrawing() {

        return false;

    }

    @Override

    public void pointDoubleClick(PointEvent event) throws BehaviorException {

        // TODO Auto-generated method stub

    }

    @Override

    public Image getImageCursor() {

    	return IconThemeHelper.getImage("cursor-view-show-hyperlink");

    }

}

/*

 * To change this license header, choose License Headers in Project Properties.

 * To change this template file, choose Tools | Templates

 * and open the template in the editor.

 */

package org.gvsig.hyperlink.app.extension;

import java.net.URL;

/**

 *

 * @author osc

 */

public interface LinkTarget {

    public URL getURL();

    public void setURL(URL url);

    public Object getFromProfile();

    public String getProfileName();

}

/* 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.config;

import java.util.ArrayList;

import java.util.List;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.Persistent;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.util.Callable;

public class LayerLinkConfig implements Persistent {

    protected List<LinkConfig> linkList;

    protected boolean enabled;

    public static final String LAYERLINKCONFIG_PERSISTENCE_DEFINITION_NAME = "LayerLinkConfig";

    public LayerLinkConfig() {

        linkList = new ArrayList<LinkConfig>();

    }

    public void addLink(LinkConfig config) {

        linkList.add(config);

    }

    public void addLink(int position, LinkConfig config) {

        linkList.add(position, config);

    }

    public void addLink(String actionCode, String fieldName) {

        linkList.add(new LinkConfig(actionCode, fieldName));

    }

    public void addLink(String actionCode, String fieldName, String extension) {

        linkList.add(new LinkConfig(actionCode, fieldName, extension));

    }

    public LinkConfig removeLink(int linkIndex) {

        try {

            return linkList.remove(linkIndex);

        } catch (IndexOutOfBoundsException ex) {

            return null;

        }

    }

    public LinkConfig getLink(int index) {

        return linkList.get(index);

    }

    public int linkCount() {

        return linkList.size();

    }

    public String getClassName() {

        return this.getClass().getName();

    }

    public boolean isEnabled() {

        return enabled;

    }

    public void setEnabled(boolean enabled) {

        this.enabled = enabled;

    }

    public void saveToState(PersistentState state) throws PersistenceException {

        state.set("enabled", this.enabled);

        state.set("linkList", this.linkList);

    }

    @SuppressWarnings("unchecked")

    public void loadFromState(PersistentState state) throws PersistenceException {

        this.enabled = state.getBoolean("enabled");

        this.linkList = new ArrayList<LinkConfig>();

        this.linkList.addAll(state.getList("linkList"));

    }

    public static class RegisterPersistence implements Callable {

        public Object call() throws Exception {

            PersistenceManager manager = ToolsLocator.getPersistenceManager();

            if( manager.getDefinition(LAYERLINKCONFIG_PERSISTENCE_DEFINITION_NAME)==null ) {

                DynStruct definition = manager.addDefinition(

                        LayerLinkConfig.class,

                        LAYERLINKCONFIG_PERSISTENCE_DEFINITION_NAME,

                        LAYERLINKCONFIG_PERSISTENCE_DEFINITION_NAME+" Persistence definition",

                        null, 

                        null

                );

                definition.addDynFieldBoolean("enabled").setMandatory(true);

                definition.addDynFieldList("linkList").setMandatory(false).setClassOfItems(LinkConfig.class);

            }

            return Boolean.TRUE;

        }

    }

}

/* 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.config;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.Persistent;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.util.Callable;

public class LinkConfig implements Persistent {

    private String fieldName;

    private String extension = "";

    private String actionCode;

    public static final String LINKCONFIG_PERSISTENCE_DEFINITION_NAME = "LinkConfig";

    public LinkConfig() {

    }

    public LinkConfig(String actionCode, String fieldName) {

        this.actionCode = actionCode;

        this.fieldName = fieldName;

    }

    public LinkConfig(String actionCode, String fieldName, String extension) {

        this.actionCode = actionCode;

        this.fieldName = fieldName;

        this.extension = extension;

    }

    public String getFieldName() {

        return fieldName;

    }

    public String getActionCode() {

        return actionCode;

    }

    public void setFieldName(String fieldName) {

        this.fieldName = fieldName;

    }

    public void setActionCode(String actionCode) {

        this.actionCode = actionCode;

    }

    public void setExtension(String extension) {

        this.extension = extension;

    }

    public String getExtension() {

        return extension;

    }

    public String getClassName() {

        return this.getClass().getName();

    }

    public void saveToState(PersistentState state) throws PersistenceException {

        state.set("fieldName", this.fieldName);

        state.set("extension", this.extension);

        state.set("actionCode", this.actionCode);

    }

    public void loadFromState(PersistentState state) throws PersistenceException {

        this.fieldName = state.getString("fieldName");

        this.extension = state.getString("extension");

        this.actionCode = state.getString("actionCode");

    }

    public static class RegisterPersistence implements Callable {

        public Object call() throws Exception {

            PersistenceManager manager = ToolsLocator.getPersistenceManager();

            if( manager.getDefinition(LINKCONFIG_PERSISTENCE_DEFINITION_NAME)==null ) {

                DynStruct definition = manager.addDefinition(

                        LinkConfig.class,

                        LINKCONFIG_PERSISTENCE_DEFINITION_NAME,

                        LINKCONFIG_PERSISTENCE_DEFINITION_NAME+" Persistence definition",

                        null, 

                        null

                );

                definition.addDynFieldString("fieldName").setMandatory(true);

                definition.addDynFieldString("extension").setMandatory(false);

                definition.addDynFieldString("actionCode").setMandatory(true);

            }

            return Boolean.TRUE;

        }

    }

}

/* 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.config.gui;

import java.awt.BorderLayout;

import java.awt.Dimension;

import javax.swing.BorderFactory;

import javax.swing.JComboBox;

import javax.swing.JLabel;

import javax.swing.JPanel;

import javax.swing.JTextField;

import javax.swing.border.BevelBorder;

import org.gvsig.andami.PluginServices;

import org.gvsig.gui.beans.swing.GridBagLayoutPanel;

public class LinkRow extends JPanel {

    JPanel pnlFieldAndExtension = null;

    JPanel pnlHyperLinkAction = null;

    JLabel lblLinkExtension = null;

    JLabel lblLinkField = null;

    JLabel lblDefaultAction = null;

    JTextField txtLinkExtension = null;

    JComboBox cmbLinkField = null;

    JComboBox cmbLinkType = null;

    public LinkRow() {

        super();

        initialize();

    }

    private void initialize() {

        GridBagLayoutPanel aux = new GridBagLayoutPanel();

        aux.setBorder(BorderFactory.createBevelBorder(BevelBorder.LOWERED));

        aux.addComponent(getPnlFieldAndExtension(), getPnlHyperLinkAction());

        this.setLayout(new BorderLayout());

        this.add(aux, BorderLayout.CENTER);

    }

    public String getSelectedField() {

        return (String) getCmbLinkField().getSelectedItem();

    }

    public void setFields(String[] fields) {

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

            getCmbLinkField().addItem(fields[i]);

        }

    }

    public void setSelectedField(String field) {

        getCmbLinkField().setSelectedItem(field);

    }

    public int getSelectedAction() {

        return getCmbLinkType().getSelectedIndex();

    }

    public String getSelectedActionName() {

        return (String) getCmbLinkType().getSelectedItem();

    }

    public void setActions(String[] actions) {

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

            getCmbLinkType().addItem(actions[i]);

        }

    }

    public void setSelectedAction(String action) {

        getCmbLinkType().setSelectedItem(action);

    }

    public void setSelectedAction(int action) {

        getCmbLinkType().setSelectedIndex(action);

    }

    public String getExtension() {

        return getTxtLinkExtension().getText();

    }

    public void setExtension(String extension) {

        getTxtLinkExtension().setText(extension);

    }

    private JPanel getPnlFieldAndExtension() {

        if (pnlFieldAndExtension == null) {

            lblLinkExtension = new JLabel();

            lblLinkExtension.setText(" \t \t"

                + PluginServices.getText(this, "Extension"));

            lblLinkField = new JLabel();

            lblLinkField.setText(PluginServices.getText(this, "Campo"));

            pnlFieldAndExtension = new JPanel();

            pnlFieldAndExtension.add(lblLinkField, null);

            pnlFieldAndExtension.add(getCmbLinkField(), null);

            pnlFieldAndExtension.add(lblLinkExtension, null);

            pnlFieldAndExtension.add(getTxtLinkExtension(), null);

        }

        return pnlFieldAndExtension;

    }

    /**

     * This method initializes jPanel8. This panel contains the ComboBox to

     * select

     * the action, (type of HyperLink)

     * 

     * @return javax.swing.JPanel

     */

    private JPanel getPnlHyperLinkAction() {

        if (pnlHyperLinkAction == null) {

            lblDefaultAction = new JLabel();

            lblDefaultAction.setText(PluginServices.getText(this, "Action")

                + "  ");

            pnlHyperLinkAction = new JPanel();

            pnlHyperLinkAction.add(lblDefaultAction, null);

            pnlHyperLinkAction.add(getCmbLinkType(), null);

        }

        return pnlHyperLinkAction;

    }

    /**

     * This method initializes jComboBox

     * 

     * @return javax.swing.JComboBox

     */

    private JComboBox getCmbLinkField() {

        if (cmbLinkField == null) {

            cmbLinkField = new JComboBox();

        }

        return cmbLinkField;

    }

    /**

     * This method initializes jTextField

     * 

     * @return javax.swing.JTextField

     */

    private JTextField getTxtLinkExtension() {

        if (txtLinkExtension == null) {

            txtLinkExtension = new JTextField();

            txtLinkExtension.setPreferredSize(new Dimension(40, 20));

        }

        return txtLinkExtension;

    }

    /**

     * This method initializes jComboBox1

     * 

     * @return javax.swing.JComboBox

     */

    private JComboBox getCmbLinkType() {

        if (cmbLinkType == null) {

            cmbLinkType = new JComboBox();

        }

        return cmbLinkType;

    }

    public void setEnabled(boolean enabled) {

        super.setEnabled(enabled);

        getTxtLinkExtension().setEnabled(enabled);

        getCmbLinkField().setEnabled(enabled);

        getCmbLinkType().setEnabled(enabled);

        lblLinkField.setEnabled(enabled);

        lblDefaultAction.setEnabled(enabled);

        lblLinkExtension.setEnabled(enabled);

    }

}

/* 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.config.gui;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.ItemEvent;

import java.awt.event.ItemListener;

import java.util.ArrayList;

import javax.swing.BorderFactory;

import javax.swing.JButton;

import javax.swing.JCheckBox;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.border.EtchedBorder;

import javax.swing.border.TitledBorder;

import org.gvsig.andami.PluginServices;

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

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

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

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

import org.gvsig.fmap.mapcontext.layers.operations.SingleLayer;

import org.gvsig.hyperlink.app.extension.AbstractActionManager;

import org.gvsig.hyperlink.app.extension.HyperlinkExtension;

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

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

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

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

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.extensionpoint.ExtensionPoint;

public class ConfigTab extends AbstractThemeManagerPage implements IWindow,

    ActionListener, ItemListener {

    FLayer layer;

    ArrayList rows = new ArrayList();

    JPanel rowList = null;

    GridBagLayout listLayout = null;

    private String[] actionCodes = null;

    private String[] actionNames = null;

    WindowInfo _windowInfo = null;

    JButton jbt_accept = null, jbt_cancel = null;

    JPanel emptyRow;

    JCheckBox jcb_enabled = null;

    JPanel borderPanel = null;

    JButton jbt_addAction = null, jbt_removeAction = null;

    public ConfigTab() {

        super();

        initialize();

    }

    private void initialize() {

        this.setLayout(new GridBagLayout());

        Insets insets = new Insets(8, 8, 8, 8);

        GridBagConstraints constraints = new GridBagConstraints();

        constraints.gridx = 0;

        constraints.gridy = 0;

        constraints.weightx = 1.0;

        constraints.fill = GridBagConstraints.NONE;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.NORTHWEST;

        this.add(getEnabledCheckBox(), constraints);

        borderPanel = new JPanel(new GridBagLayout());

        borderPanel.setBorder(BorderFactory.createTitledBorder(BorderFactory.createEtchedBorder(EtchedBorder.LOWERED),

            PluginServices.getText(this, "Actions"),

            TitledBorder.DEFAULT_JUSTIFICATION,

            TitledBorder.DEFAULT_POSITION,

            null,

            null));

        insets = new Insets(8, 8, 8, 8);

        constraints = new GridBagConstraints();

        constraints.gridx = 0;

        constraints.gridy = 0;

        constraints.weightx = 1.0;

        constraints.fill = GridBagConstraints.NONE;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.NORTHWEST;

        borderPanel.add(getAddRemoveActionsPanel(), constraints);

        listLayout = new GridBagLayout();

        rowList = new JPanel(listLayout);

        constraints.gridx = 0;

        constraints.gridy = 0;

        constraints.weightx = 1.0;

        constraints.weighty = 1.0;

        constraints.fill = GridBagConstraints.NONE;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.SOUTH;

        emptyRow = new JPanel();

        rowList.add(emptyRow, constraints);

        JScrollPane scrolledList = new JScrollPane();

        scrolledList.setBorder(null);

        scrolledList.setViewportView(rowList);

        constraints.gridx = 0;

        constraints.gridy = 1;

        constraints.weightx = 1.0;

        constraints.weighty = 1.0;

        constraints.fill = GridBagConstraints.BOTH;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.CENTER;

        borderPanel.add(scrolledList, constraints);

        constraints.gridx = 0;

        constraints.gridy = 1;

        constraints.weightx = 1.0;

        constraints.weighty = 1.0;

        constraints.fill = GridBagConstraints.BOTH;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.NORTHWEST;

        this.add(borderPanel, constraints);

        // initAcceptCancelButtons(); uncomment this if you want to use this

        // window outside the ThemeManager

    }

    private void initAcceptCancelButtons() {

        JPanel acceptCancelButtons = new JPanel(new GridBagLayout());

        Insets insets = new Insets(14, 4, 8, 8);

        GridBagConstraints constraints = new GridBagConstraints();

        constraints.gridx = 0;

        constraints.gridy = 0;

        constraints.weightx = 1.0;

        constraints.fill = GridBagConstraints.NONE;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.EAST;

        acceptCancelButtons.add(getAcceptButton(), constraints);

        constraints.gridx = 1;

        constraints.gridy = 0;

        constraints.weightx = 0.0;

        constraints.fill = GridBagConstraints.NONE;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.EAST;

        acceptCancelButtons.add(getCancelButton(), constraints);

        constraints.gridx = 0;

        constraints.gridy = 2;

        constraints.weightx = 0.0;

        constraints.fill = GridBagConstraints.NONE;

        constraints.insets = insets;

        constraints.anchor = GridBagConstraints.SOUTHEAST;

        this.add(acceptCancelButtons, constraints);

    }

    private String[] getActionNames() {

        if (actionNames == null) {

            ExtensionPoint actions =

                ToolsLocator.getExtensionPointManager()

                    .get(HyperlinkExtension.ACTIONSEXTENSIONPOINT);

            String[] actionArray = new String[actions.getCount()];

            String[] codes = getActionCodes();

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

                try {

                    AbstractActionManager aam =

                        (AbstractActionManager) actions.get(codes[i])

                            .getExtension()

                            .newInstance();

                    actionArray[i] = aam.getName();

                } catch (InstantiationException e) {

                    // TODO Auto-generated catch block

                    e.printStackTrace();

                } catch (IllegalAccessException e) {

                    // TODO Auto-generated catch block

                    e.printStackTrace();

                }

            }

            actionNames = actionArray;

        }

        return actionNames;

    }

    private String[] getActionCodes() {

        if (actionCodes == null) {

            ExtensionPoint actions =

                ToolsLocator.getExtensionPointManager()

                    .get(HyperlinkExtension.ACTIONSEXTENSIONPOINT);

            String[] actionArray = new String[actions.getCount()];

            actionArray = (String[]) actions.getNames().toArray(actionArray);

            actionCodes = actionArray;

        }

        return actionCodes;

    }

    private String[] getCandidateFields() {

        HyperlinkExtension ext =

            (HyperlinkExtension) PluginServices.getExtension(HyperlinkExtension.class);

        ManagerRegistry registry = ext.getLayerManager();

        try {

            ILinkLayerManager manager;

            manager = registry.get(layer);

            manager.setLayer(layer);

            return manager.getFieldCandidates();

        } catch (InstantiationException e) {

            PluginServices.getLogger()

                .warn("Hyperlink: error getting candidate fields", e);

        } catch (IllegalAccessException e) {

            PluginServices.getLogger()

                .warn("Hyperlink: error getting candidate fields", e);

        } catch (ClassNotFoundException e) {

            PluginServices.getLogger()

                .warn("Hyperlink: error getting candidate fields", e);

        } catch (IncompatibleLayerException e) {

            PluginServices.getLogger()

                .warn("Hyperlink: error getting candidate fields", e);

        } catch (NullPointerException e) {

            PluginServices.getLogger().warn("Hyperlink: error getting manager", e);

        }

        return new String[0];

    }

    public void acceptAction() {

        applyAction();

    }

    public void applyAction() {

        LayerLinkConfig config = new LayerLinkConfig();

        for (int i = 0; i < rows.size(); i++) {

            LinkRow row = (LinkRow) rows.get(i);

            if (row.getSelectedField() != null

                && row.getSelectedAction() != -1) {

                config.addLink(getActionCodes()[row.getSelectedAction()],

                    row.getSelectedField(),

                    row.getExtension());

            }

        }

        config.setEnabled(getEnabledCheckBox().isSelected());

        layer.setProperty(HyperlinkExtension.LAYERPROPERTYNAME, config);

    }

    public void cancelAction() {

    }

    public String getName() {

        return PluginServices.getText(this, "Hyperlink");

    }

    public void setModel(FLayer layer) {

        this.layer = layer;

        if( layer!=null && !layer.isAvailable() ) {

            setLinkEnabled(false);

            getEnabledCheckBox().setEnabled(false);

            return;

        }

        synchronized (rows) {

            HyperlinkExtension ext =

                (HyperlinkExtension) PluginServices.getExtension(HyperlinkExtension.class);

            LayerLinkConfig layerConfig = ext.loadLegacyConfig(layer);

            for (int i = rows.size() - 1; i >= 0; i--) { // clean rows