Aplicación gvSIG con fines educativos

===============

gvSIG Educa

===============

---------------------

Vistas Portables

---------------------

Descripci?n

==============

Este directorio contiene los fuentes de la funcionalidad Vistas Portables.

Requisitos

==============

* Maven 2.6 or higher

* Java JDK 1.5 or higher

Para trabajar con eclipse

--------------------------

Ver `Gu?a del desarrollador en gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/>`_ y el fichero ``REAME-ECLIPSE.txt``

Contenido

==========

org.gvsig.educa.portableview.lib

---------------------------------

Fuentes de la funcionalidad. Estos proyectos contienen los procesos y l?gica principal sin dependencias de interface de usuario.

org.gvsig.educa.portableview.swing

-------------------------------------

Componentes de interface de usuario para gestionar los servicios que ofrece la librer??a.

org.gvsig.educa.portableview.main

-----------------------------------

Peque?a aplicaci?n que permite ejecutar las funcionalidades y realizar pruebas funcionales.

Ver `Ejecutar aplicaci?n de pruebas`_ para saber como arrancarla.

pom.xml

---------

Archivo de definici?n de proyecto Maven.

README.txt LEEME.txt

----------------------

Este fichero (en formato reStructureText, para mas informaci?n sobre este ver el `portal de gvSIG <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/guia-para-documentar/el-formato-restructuredtext>`_  en la `referencia de docUtils  <http://docutils.sourceforge.net/rst.html>`_)

Compilaci?n

================

Desde el shell

----------------

Ejecute este comando::

    org.gvsig.educa.portablewview$ mvn clean install

Desde eclipse

--------------

Ver `Trabajar con un proyecto de la gu?a de desarrollador en gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/trabajar-con-un-proyecto>`_

En algunos proyectos puede que sea necesario user el comando ``mvn eclipse:clean eclipse:eclipse`` e importar como *Standar/Import existing project...* en vez de cargar como *Maven Project*. Esto es debido a que, en algunas circunstancias, parece que el plugin de Maven del eclipse no prepara el *classpath* de forma correcta.

Empaquetado

===============

Esta funcionalidad no tiene ning?n proyecto pensado para empaquetar de forma independiente.

Versionado

--------------

Para cambiar el n?mero de versi?n de los plugins solo es necesario ajustar la etiqueta ``project/version`` del fichero *pom.xml*. Los subproyectos heredar?n el valor.

La pol??tica de versi?n es la est?ndar. Los cambios en los numeroso son:

* tercer n?mero: Arreglo de errores y mejoras menores. Sin cambios en el API.

* segundo n?mero: Arreglo de erroes y mejoras. Pueden haber cambios menores en el API. Los elementos marcados como *deprecated* en versiones anteriores pueden eliminarse. Sin cambios de arquitectura.

* primer n?mero: Cambios mayores.

Crear un tag

------------------

TODO: usar el plugin *release* de maven

Usar el comando *svn copy*. El proceso podr?a ser:

#. Comprobar que no hay cambios en la copia local::

   svn up ; svn status

#. Comprobar que los proyecto compilan y pasan todas las bater?as de test::

   mvn clean install

#. Actualizar el fichero *pom.xml* con la versi?n de tag (normalmente quitando el sufijo *-SNAPSHOT*)

#. Crear el directorio para el tag en el servidor::

   svn mkdir -m "Create {version} tag folder" https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.portablewview.app/tags/{version}

#. Subir la copia local al directorio del tag en el servidor::

   svn copy -m "Create {version} tag" * https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.portablewview.app/tags/{version}

#. Actualizar el *pom.xml* a la siguiente version (y a?adirle el sufijo *-SNAPSHOT*)

#. Subir los cambios del *pom.xml*::

   svn commit -m "Set new version {version}-SNAPSHOT" pom.xml

i18n

======

Los ficheros de internacionalizaci?n se pueden encontrar en los directorios:

+ */org.gvsig.educa.portableview.swing/org.gvsig.educa.portableview.swing.impl/src/main/resources/org/gvsig/educa/portableview/swing/impl/i18n*

+ *org.gvsig.educa.portableview.lib/org.gvsig.educa.portableview.lib.impl/src/main/resources/org/gvsig/educa/portableview/impl/i18n*

La internacionalizaci?n est? basada en el mecanismo est?ndar de los *resource bundle*. Para a?adir un nuevo idioma es necesario a?adir el fichero de propiedades en todos los directorio con el codigo de idioma adecuado.

Ejecutar aplicaci?n de pruebas

=================================

Desde el Shell

----------------

Despu?s del proceso de `Compilaci?n`_ , ejecute estos comandos::

    org.gvsig.educa.portablewview$ cd org.gvsig.educa.portablewview.main

    org.gvsig.educa.portablewview/org.gvsig.educa.portablewview.main$ mvn exec:java

Desde el eclipse

------------------

Seleccione el proyecto ``org.gvsig.educa.portableview.main`` en el *Project tree* de la *Java perspective*, haga click con el bot?n derecho y seleccione ``Run as.../Java application``. Seleccione la clase ``Main`` del propio proyecto.

Si tiene problemas al ejecutar, compruebe la nota de la secci?n `Compilaci?n`_ sobre la importaci?n del proyecto.

#Mon Jun 19 00:47:21 CEST 2023

buildNumber=242

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

  <dependencySets>

    <dependencySet>

      <useProjectArtifact>false</useProjectArtifact>

      <useTransitiveDependencies>false</useTransitiveDependencies>

      <outputDirectory>lib</outputDirectory>

      <includes>

		<include>org.gvsig:org.gvsig.educa.portableview.lib.api</include>

		<include>org.gvsig:org.gvsig.educa.portableview.lib.impl</include>

		<include>org.gvsig:org.gvsig.educa.portableview.lib.prov.installer</include>

		<include>org.gvsig:org.gvsig.educa.portableview.swing.api</include>

		<include>org.gvsig:org.gvsig.educa.portableview.swing.impl</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.educa.portableview.app.viewer;

import java.util.Arrays;

import java.util.Iterator;

import java.util.List;

import javax.swing.ImageIcon;

import org.gvsig.andami.PluginServices;

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

import org.gvsig.app.project.Project;

import org.gvsig.app.project.ProjectManager;

import org.gvsig.app.project.documents.AbstractDocument;

import org.gvsig.app.project.documents.AbstractDocumentManager;

import org.gvsig.app.project.documents.Document;

import org.gvsig.app.project.documents.gui.IDocumentWindow;

import org.gvsig.app.project.documents.gui.WindowLayout;

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

import org.gvsig.educa.portableview.PortableViewManager;

import org.gvsig.educa.portableview.app.viewer.ui.PortableViewDocumentProperties;

import org.gvsig.educa.portableview.app.viewer.ui.PortableViewDocumentViewer;

import org.gvsig.educa.portableview.app.viewer.ui.PortableViewSelector;

import org.gvsig.educa.portableview.map.PortableView;

import org.gvsig.educa.portableview.swing.PortableViewSwingLocator;

import org.gvsig.educa.portableview.swing.PortableViewSwingManager;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynObjectManager;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

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

/**

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class PortableViewDocumentManager extends AbstractDocumentManager {

    public static final String PERSISTENCE_PORTABLEVIEW_DOCUMENT_DEFINITION_NAME =

        "PortableViewDocument";

    public static String TYPENAME = "project.document.portableView";

    private DynStruct persistenceDefinition = null;

    private final PortableViewSwingManager tmSwingManager;

    private final PortableViewManager tmManager;

    /**

     * Registers in the points of extension the Factory with alias.

     *

     */

    public static void register() {

        PortableViewDocumentManager factory = new PortableViewDocumentManager();

        ProjectManager.getInstance().registerDocumentFactory(factory);

        registerIcons();

        PersistenceManager manager = ToolsLocator.getPersistenceManager();

        manager.registerFactory(factory);

        if (factory.persistenceDefinition == null) {

            DynObjectManager dynman = ToolsLocator.getDynObjectManager();

            factory.persistenceDefinition =

                dynman.createDynClass(PersistenceManager.PERSISTENCE_NAMESPACE,

                    PERSISTENCE_PORTABLEVIEW_DOCUMENT_DEFINITION_NAME,

                    "Portable view document Persistence definition");

            factory.persistenceDefinition.addDynFieldString("id").setMandatory(

                true);

            factory.persistenceDefinition.addDynFieldInt("version")

                .setMandatory(true);

            factory.persistenceDefinition.addDynFieldInt("buildNumber")

                .setMandatory(true);

            factory.persistenceDefinition.addDynFieldString("name")

                .setMandatory(true);

            factory.persistenceDefinition.addDynFieldString("comment")

                .setMandatory(false);

            factory.persistenceDefinition.addDynFieldObject("sourceView")

                .setMandatory(false).setClassOfValue(ViewDocument.class);

        }

    }

    /**

     *

     */

    private static void registerIcons() {

        PluginServices.getIconTheme().registerDefault(

            "document-portableview-icon",

            PortableViewDocumentManager.class.getClassLoader().getResource(

                "images/document-portableview-icon.png"));

        PluginServices.getIconTheme().registerDefault(

            "document-portableview-icon-sel",

            PortableViewDocumentManager.class.getClassLoader().getResource(

                "images/document-portableview-icon-sel.png"));

    }

    /**

     *

     */

    public PortableViewDocumentManager() {

        tmSwingManager = PortableViewSwingLocator.getSwingManager();

        tmManager = tmSwingManager.getManager();

    }

    @Override

    public ImageIcon getIcon() {

        if (!PluginServices.getIconTheme().exists("document-portableview-icon")) {

            registerIcons();

        }

        return PluginServices.getIconTheme().get("document-portableview-icon");

    }

    @Override

    public ImageIcon getIconSelected() {

        if (!PluginServices.getIconTheme().exists(

            "document-portableview-icon-sel")) {

            registerIcons();

        }

        return PluginServices.getIconTheme().get(

            "document-portableview-icon-sel");

    }

    @Override

    public String getTitle() {

        return tmSwingManager.getTranslation("Portable_View");

    }

    public String getTypeName() {

        return TYPENAME;

    }

    public AbstractDocument createDocument() {

        return new PortableViewDocument(this);

    }

    public PortableViewDocument createDocument(PortableView portableView) {

        return new PortableViewDocument(this, portableView);

    }

    @Override

    public AbstractDocument createDocumentByUser() {

        Iterator<? extends Document> iterator = createDocumentsByUser();

        if (iterator == null || !iterator.hasNext()) {

            return null;

        }

        return (AbstractDocument) iterator.next();

    }

    @Override

    public Iterator<? extends Document> createDocumentsByUser() {

        PortableViewSelector selector =

            new PortableViewSelector(this, tmManager.getInstalledMaps());

        tmSwingManager.getWindowManager().showWindow(selector,

            tmSwingManager.getTranslation("open_portable_view"), MODE.DIALOG);

        if (selector.getDocuments() == null

            || selector.getDocuments().isEmpty()) {

            return Arrays.asList(new Document[] {}).iterator();

        }

        return selector.getDocuments().iterator();

    }

    public IWindow getMainWindow(Document doc, WindowLayout layout) {

        IDocumentWindow portableViewPanel;

        portableViewPanel =

            (IDocumentWindow) PluginServices.getMDIManager()

                .getSingletonWindow(getMainWindowClass(), doc);

        if (portableViewPanel != null) {

            // The window document is already created, return it.

            return portableViewPanel;

        }

        portableViewPanel = this.createDocumentWindow(doc);

        if (layout != null && portableViewPanel != null) {

            portableViewPanel.setWindowLayout(layout);

        }

        return portableViewPanel;

    }

    public IWindow getPropertiesWindow(Document doc) {

        PortableViewDocumentProperties propertiesPanel =

            (PortableViewDocumentProperties) PluginServices.getMDIManager()

                .getSingletonWindow(PortableViewDocumentProperties.class, doc);

        if (propertiesPanel != null) {

            // The table window document is already created, return it.

            return propertiesPanel;

        }

        propertiesPanel =

            new PortableViewDocumentProperties((PortableViewDocument) doc);

        return propertiesPanel;

    }

    public Class<? extends IDocumentWindow> getMainWindowClass() {

        return PortableViewDocumentViewer.class;

    }

    public boolean manages(Object object) {

        return object instanceof PortableViewDocument;

    }

    public DynStruct getDefinition(String className) {

        // TODO review it

        if (this.persistenceDefinition.getName().equalsIgnoreCase(className)) {

            return this.persistenceDefinition;

        }

        if (this.persistenceDefinition.getFullName()

            .equalsIgnoreCase(className)) {

            return this.persistenceDefinition;

        }

        if (this.getDocumentClass().getName().equals(className)) {

            return this.persistenceDefinition;

        }

        return null;

    }

    @SuppressWarnings("rawtypes")

    @Override

    protected Class getDocumentClass() {

        return PortableViewDocument.class;

    }

    /**

     * Gets the first document which map is the specified

     *

     * @param curMap

     * @return

     */

    public PortableViewDocument getDocumentForMap(PortableView map) {

        if (map == null) {

            return null;

        }

        List<Document> docs = getProject().getDocuments(TYPENAME);

        for (Document document : docs) {

            if (((PortableViewDocument) document).isMap(map)) {

                return (PortableViewDocument) document;

            }

        }

        return null;

    }

    /**

     * Gets current project

     *

     * @return

     */

    private Project getProject() {

        return ProjectManager.getInstance().getCurrentProject();

    }

}

/* 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.educa.portableview.app.viewer.ui;

import java.awt.FlowLayout;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.GridLayout;

import java.awt.Insets;

import java.awt.event.ActionEvent;

import javax.swing.AbstractAction;

import javax.swing.BorderFactory;

import javax.swing.JButton;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JTextArea;

import javax.swing.JTextField;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.andami.PluginServices;

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

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

import org.gvsig.educa.portableview.app.viewer.PortableViewDocument;

import org.gvsig.educa.portableview.swing.PortableViewSwingLocator;

import org.gvsig.educa.portableview.swing.PortableViewSwingManager;

import org.gvsig.educa.portableview.swing.PortableViewWindowManager.MESSAGE_DIALOG_TYPE;

import org.gvsig.educa.portableview.swing.viewer.PortableViewInforamtionViewer;

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

import org.gvsig.tools.swing.api.ToolsSwingLocator;

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

/**

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class PortableViewDocumentProperties extends JPanel implements

    SingletonWindow {

    /**

     *

     */

    private static final long serialVersionUID = 8865766314251281948L;

    private static final int DEFAULT_HEIGHT = 450;

    private static final int DEFAULT_WIDTH = 700;

    private final PortableViewDocument model;

    private final PortableViewSwingManager tmSwingManager;

    private final UsabilitySwingManager usabManager;

    private WindowInfo windowInfo;

    private JTextField name;

    private PortableViewInforamtionViewer info;

    private JTextArea comments;

    private JButton acceptButton;

    private JButton cancelButton;

    private JTextField sourceViewName;

    /**

     * @param doc

     */

    public PortableViewDocumentProperties(PortableViewDocument doc) {

        super();

        model = doc;

        tmSwingManager = PortableViewSwingLocator.getSwingManager();

        usabManager = ToolsSwingLocator.getUsabilitySwingManager();

        initializeUI();

    }

    /**

     *

     */

    private void initializeUI() {

        setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));

        setLayout(new GridBagLayout());

        GridBagConstraints gbcBase = createBaseGridBagContraints();

        // add name

        JPanel namePanel = createNamePanel();

        add(namePanel, gbcBase.clone());

        // add ThMap info

        JPanel infoPanel = createInfoPanel();

        GridBagConstraints gbc = (GridBagConstraints) gbcBase.clone();

        gbc.fill = GridBagConstraints.BOTH;

        gbc.weighty = 1;

        add(infoPanel, gbc);

        // add comments

        JPanel commentPanel = createCommentsPanel();

        add(commentPanel, gbcBase.clone());

        // add command panel

        JPanel commandsPanel = createCommandPanel();

        add(commandsPanel, gbcBase.clone());

    }

    /**

     * @return

     */

    private GridBagConstraints createBaseGridBagContraints() {

        GridBagConstraints gbcBase = new GridBagConstraints();

        gbcBase.gridx = GridBagConstraints.RELATIVE;

        gbcBase.gridy = GridBagConstraints.RELATIVE;

        gbcBase.gridheight = 1;

        gbcBase.gridwidth = GridBagConstraints.REMAINDER;

        gbcBase.insets = new Insets(5, 5, 5, 5);

        gbcBase.fill = GridBagConstraints.HORIZONTAL;

        gbcBase.weightx = 1;

        gbcBase.weighty = 0;

        return gbcBase;

    }

    /**

     * @return

     */

    private JPanel createCommandPanel() {

        JPanel commandsPanel =

            new JPanel(new FlowLayout(FlowLayout.TRAILING, 10, 10));

        acceptButton =

            usabManager.createJButton(new AbstractAction(tmSwingManager

                .getTranslation("accept")) {

                /**

                     *

                     */

                private static final long serialVersionUID =

                    -1782481065769162438L;

                public void actionPerformed(ActionEvent e) {

                    accept();

                }

            });

        commandsPanel.add(acceptButton);

        cancelButton =

            usabManager.createJButton(new AbstractAction(tmSwingManager

                .getTranslation("cancel")) {

                /**

                     *

                     */

                private static final long serialVersionUID =

                    2955490218831066658L;

                public void actionPerformed(ActionEvent e) {

                    close();

                }

            });

        commandsPanel.add(cancelButton);

        return commandsPanel;

    }

    /**

     * @return

     */

    private JPanel createNamePanel() {

        GridBagLayoutPanel namePanel = new GridBagLayoutPanel();

        name = new JTextField(model.getName());

        namePanel.addComponent(tmSwingManager.getTranslation("name"), name);

        sourceViewName = new JTextField();

        sourceViewName.setEditable(false);

        if (model.getSourceView() != null) {

            sourceViewName.setText(model.getSourceView().getName());

            namePanel.addComponent(

                tmSwingManager.getTranslation("source_view"), sourceViewName);

        }

        return namePanel;

    }

    /**

     * @return

     */

    private JPanel createInfoPanel() {

        JPanel infoPanel = new JPanel(new GridLayout());

        info = tmSwingManager.newInformationViewer();

        info.loadMapInformation(model.getPortableView());

        infoPanel.add(new JScrollPane(info.getSwingComponent()));

        infoPanel.setBorder(BorderFactory.createTitledBorder(tmSwingManager

            .getTranslation("portable_view_information")));

        return infoPanel;

    }

    /**

     * @return

     */

    private JPanel createCommentsPanel() {

        GridBagLayoutPanel commentPanel = new GridBagLayoutPanel();

        comments = new JTextArea(model.getComment());

        JScrollPane commentsScroll = new JScrollPane(comments);

        commentPanel.addComponent(tmSwingManager.getTranslation("comments"),

            commentsScroll);

        return commentPanel;

    }

    private void accept() {

        if (StringUtils.isBlank(name.getText())) {

            tmSwingManager.getWindowManager().showMessageDialog(this,

                tmSwingManager.getTranslation("portable_view_properties"),

                tmSwingManager.getTranslation("name_is_required"),

                MESSAGE_DIALOG_TYPE.ERROR);

            return;

        }

        model.setName(name.getText());

        model.setComment(comments.getText());

        close();

    }

    public void close() {

        PluginServices.getMDIManager().closeWindow(this);

    }

    public WindowInfo getWindowInfo() {

        if (windowInfo == null) {

            windowInfo =

                new WindowInfo(WindowInfo.MAXIMIZABLE | WindowInfo.RESIZABLE);

            windowInfo.setTitle(tmSwingManager

                .getTranslation("portable_view_properties"));

            windowInfo.setWidth(DEFAULT_WIDTH);

            windowInfo.setHeight(DEFAULT_HEIGHT);

        }

        return windowInfo;

    }

    public Object getWindowProfile() {

        return WindowInfo.PROPERTIES_PROFILE;

    }

    public Object getWindowModel() {

        return model;

    }

}

/* 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.educa.portableview.app.viewer.ui;

import javax.swing.ImageIcon;

import org.gvsig.andami.PluginServices;

import org.gvsig.educa.portableview.swing.viewer.PortableViewTocImageProvider;

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

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

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

/**

 * Image provider for Portable View TOC items

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class TocImageProvider implements PortableViewTocImageProvider {

    public ImageIcon getImageIconForLayer(FLayer layer) {

        return PluginServices.getIconTheme().get(layer.getTocImageIcon());

    }

    public ImageIcon getSymbolPreview(ISymbol symbol, FLayer sourceLayer) {

        // Use default

        return null;

    }

    public ImageIcon getUnavailableIconForLayer(){

    	return PluginServices.getIconTheme().get("layer-unavialable");

    }

}

/* 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.educa.portableview.app.viewer.ui;

import java.awt.GridLayout;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.io.IOException;

import javax.help.UnsupportedOperationException;

import javax.swing.BorderFactory;

import javax.swing.JPanel;

import org.cresques.cts.IProjection;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.ui.mdiFrame.NewStatusBar;

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

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

import org.gvsig.app.project.documents.Document;

import org.gvsig.app.project.documents.gui.IDocumentWindow;

import org.gvsig.app.project.documents.gui.WindowLayout;

import org.gvsig.educa.portableview.app.viewer.PortableViewBasicMapControlExtension;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocument;

import org.gvsig.educa.portableview.map.CantLoadContextException;

import org.gvsig.educa.portableview.map.InvalidPortableViewFormatException;

import org.gvsig.educa.portableview.map.PortableView;

import org.gvsig.educa.portableview.map.PortableViewInformation;

import org.gvsig.educa.portableview.swing.PortableViewSwingLocator;

import org.gvsig.educa.portableview.swing.PortableViewSwingManager;

import org.gvsig.educa.portableview.swing.viewer.PortableViewViewer;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.fmap.mapcontext.events.ColorEvent;

import org.gvsig.fmap.mapcontext.events.ExtentEvent;

import org.gvsig.fmap.mapcontext.events.ProjectionEvent;

import org.gvsig.fmap.mapcontext.events.listeners.ViewPortListener;

import org.gvsig.fmap.mapcontrol.MapControl;

/**

 * Document Window to show PortableViews

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class PortableViewDocumentViewer extends JPanel implements

    IDocumentWindow, IWindowTransform, PropertyChangeListener {

    /**

     *

     */

    private static final long serialVersionUID = 6987853732480183690L;

    private static final int DEFAULT_HEIGHT = 450;

    private static final int DEFAULT_WIDTH = 700;

    private WindowInfo windowInfo;

    private final PortableViewDocument model;

    private boolean isPalette = false;

    private final PortableViewSwingManager tmSwingManager;

    private PortableViewViewer viewer;

    private String title;

    private ViewPortListener viewPortListener;

    /**

     * Default contructor

     *

     * @throws IOException

     * @throws CantLoadContextException

     * @throws InvalidPortableViewFormatException

     *

     */

    public PortableViewDocumentViewer(Document document)

        throws InvalidPortableViewFormatException, CantLoadContextException,

        IOException {

        super();

        model = (PortableViewDocument) document;

        tmSwingManager = PortableViewSwingLocator.getSwingManager();

        setBorder(BorderFactory.createEmptyBorder(3, 3, 3, 3));

        setLayout(new GridLayout(1, 1));

        model.addPropertyChangeListener(this);

        updateViewer();

        updateTitle();

    }

    /**

     * Gets the title for this window

     *

     * @return

     */

    public String getTitle() {

        return title;

    }

    /**

     * Update the panel title

     *

     */

    protected void updateTitle() {

        title =

            tmSwingManager.getTranslation("Portable_View").concat(": ")

                .concat(this.model.getName());

        if (windowInfo != null) {

            windowInfo.setTitle(title);

        }

    }

    /**

     * Update the view contained in the panel

     *

     * @throws InvalidPortableViewFormatException

     * @throws CantLoadContextException

     * @throws IOException

     */

    protected void updateViewer() throws InvalidPortableViewFormatException,

        CantLoadContextException, IOException {

        String toolId = null;

        // Remove previous viewer

        if (viewer != null) {

            // backup current tool

            toolId = viewer.getMapControl().getCurrentTool();

            remove(viewer.getSwingComponent());

            if (viewPortListener != null) {

                viewer.getMapControl().getViewPort()

                    .removeViewPortListener(viewPortListener);

            }

            viewer.dispose();

            viewer = null;

        }

        // create new viewer

        viewer = tmSwingManager.getViewer(model.getPortableView());

        add(viewer.getSwingComponent());

        final MapControl mapControl = viewer.getMapControl();

        // restore tool (if any)

        if (toolId != null) {

            mapControl.setTool(toolId);

        } else {

            mapControl.setTool(PortableViewBasicMapControlExtension.TOOL_PAN_ID);

        }

        if (mapControl.getViewPort() != null) {

            viewPortListener = new ViewPortListener() {

                public void extentChanged(ExtentEvent e) {

                    if (PluginServices.getMainFrame() != null) {

                        NewStatusBar statusBar =

                            PluginServices.getMainFrame().getStatusBar();

                        statusBar

                            .setControlValue("scale", String.valueOf(mapControl

                                .getMapContext().getScaleView()));

                        statusBar.setMessage("projection", mapControl

                            .getViewPort().getProjection().getAbrev());

                    }

                }

                public void backColorChanged(ColorEvent e) {

                    // Do nothing

                }

                public void projectionChanged(ProjectionEvent e) {

                    // Do nothing

                }

            };

            mapControl.getViewPort().addViewPortListener(viewPortListener);

        }

    }

    /**

     * @return the viewer

     */

    public PortableViewViewer getViewer() {

        return viewer;

    }

    /**

     * @return the viewer

     */

    public PortableView getPortableView() {

        return viewer.getPortableView();

    }

    /**

     * @return the viewer

     */

    public PortableViewInformation getPortableViewInformation() {

        return viewer.getPortableView().getInformation();

    }

    // IWindow interface

    public WindowInfo getWindowInfo() {

        if (windowInfo == null) {

            windowInfo =

                new WindowInfo(WindowInfo.ICONIFIABLE | WindowInfo.MAXIMIZABLE

                    | WindowInfo.RESIZABLE);

            windowInfo.setTitle(getTitle());

            windowInfo.setWidth(DEFAULT_WIDTH);

            windowInfo.setHeight(DEFAULT_HEIGHT);

        }

        return windowInfo;

    }

    // SingletonWindow interface

    public Object getWindowModel() {

        return this.model;

    }

    public void toPalette() {

        isPalette = true;

        windowInfo.toPalette(true);

        windowInfo.setClosed(false);

        PluginServices.getMDIManager().changeWindowInfo(this, getWindowInfo());

    }

    public void restore() {

        isPalette = false;

        windowInfo.toPalette(false);

        windowInfo.setClosed(false);

        PluginServices.getMDIManager().changeWindowInfo(this, getWindowInfo());

    }

    public boolean isPalette() {

        return isPalette;

    }

    public Object getWindowProfile() {

        return WindowInfo.EDITOR_PROFILE;

    }

    public void windowActivated() {

        NewStatusBar statusbar = PluginServices.getMainFrame().getStatusBar();

        MapContext mapContext = model.getMapContext();

        statusbar.setMessage("units",

            PluginServices.getText(this, mapContext.getDistanceName()));

        statusbar.setControlValue("scale",

            String.valueOf(mapContext.getScaleView()));

        IProjection proj = viewer.getMapControl().getViewPort().getProjection();

        if (proj != null) {

            statusbar.setMessage("projection", proj.getAbrev());

        } else {

            statusbar.setMessage("projection", "");

        }

    }

    public void windowClosed() {

    }

    public WindowLayout getWindowLayout() {

        return null;

    }

    public void setWindowLayout(WindowLayout layout) {

    }

    public void setDocument(Document document) {

        throw new UnsupportedOperationException();

    }

    public Document getDocument() {

        return model;

    }

    public PortableViewDocument getPortableViewDocument() {

        return model;

    }

    /**

     * Changes in source document

     *

     */

    public void propertyChange(PropertyChangeEvent evt) {

        if (evt.getPropertyName().equals("name")) {

            updateTitle();

        } else

            if (evt.getPropertyName().equals("portableView")) {

            }

    }

}

/* 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.educa.portableview.app.viewer.ui;

import java.awt.BorderLayout;

import java.awt.Dimension;

import java.awt.event.ActionEvent;

import java.awt.event.MouseAdapter;

import java.awt.event.MouseEvent;

import java.util.ArrayList;

import java.util.Collections;

import java.util.List;

import javax.swing.AbstractAction;

import javax.swing.BorderFactory;

import javax.swing.Box;

import javax.swing.BoxLayout;

import javax.swing.JButton;

import javax.swing.JList;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.ListSelectionModel;

import javax.swing.event.ListSelectionEvent;

import javax.swing.event.ListSelectionListener;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocument;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocumentManager;

import org.gvsig.educa.portableview.map.PortableView;

import org.gvsig.educa.portableview.swing.PortableViewSwingLocator;

import org.gvsig.educa.portableview.swing.PortableViewSwingManager;

import org.gvsig.educa.portableview.swing.viewer.PortableViewInforamtionViewer;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

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

/**

 * Open Portable View dialog

 * <p>

 * Allows user to select one o many Portable view to open

 * </p>

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class PortableViewSelector extends JPanel implements

		ListSelectionListener {

	/**

     *

     */

	private static final long serialVersionUID = 1L;

	@SuppressWarnings("unused")

	private static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory

			.getLogger(PortableViewSelector.class);

	private final PortableViewSwingManager swingManager;

	private final UsabilitySwingManager usabManager;

	private List<PortableView> maps;

	private final List<String> mapNames;

	private JPanel listPanel;

	private JList list;

	private JPanel informationPanel;

	private PortableViewInforamtionViewer information;

	private JPanel actionPanel;

	private JButton botOpen;

	private JButton botCancel;

	private PortableView lastSelected;

	private int lastSelectedIndex;

	private final PortableViewDocumentManager documentManager;

	private List<PortableViewDocument> documents;

	public PortableViewSelector(PortableViewDocumentManager documentManager,

			List<PortableView> installedMaps) {

		super();

		this.documentManager = documentManager;

		swingManager = PortableViewSwingLocator.getSwingManager();

		usabManager = ToolsSwingLocator.getUsabilitySwingManager();

		maps = installedMaps;

		mapNames = new ArrayList<String>(installedMaps.size());

		for (PortableView map : maps) {

			mapNames.add(map.getInformation().getName());

		}

		lastSelected = null;

		lastSelectedIndex = -1;

		initializeUI();

	}

	/**

	 * Initialize user interface

	 *

	 */

	private void initializeUI() {

		setLayout(new BorderLayout(10, 10));

		setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));

		setMaximumSize(new Dimension(300, 200));

		setPreferredSize(new Dimension(800, 600));

		list = new JList(mapNames.toArray());

		list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);

		list.addListSelectionListener(this);

		// Listen to click so it can change map information

		list.addMouseListener(new MouseAdapter() {

			@Override

			public void mouseClicked(MouseEvent e) {

				int itemClicked = -1;

				// check in visible list element which was clicked

				int firstVisibleIndex = list.getFirstVisibleIndex();

				if (firstVisibleIndex >= 0) {

					for (int index = firstVisibleIndex; index <= list

							.getLastVisibleIndex(); index++) {

						if (list.getCellBounds(index, index).contains(e.getX(),

								e.getY())) {

							itemClicked = index;

							break;

						}

					}

				}

				if (itemClicked > -1) {

					lastSelection(itemClicked);

				}

			}

		});

		list.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);

		listPanel = new JPanel();

		listPanel.setLayout(new BorderLayout(10, 10));

		listPanel.setBorder(BorderFactory.createTitledBorder(swingManager

				.getTranslation("portable_views_availables")));

		listPanel.add(new JScrollPane(list), BorderLayout.CENTER);

		add(listPanel, BorderLayout.WEST);

		informationPanel = new JPanel();

		informationPanel.setLayout(new BorderLayout(5, 5));

		informationPanel.setBorder(BorderFactory

				.createTitledBorder(swingManager

						.getTranslation("portable_view_information")));

		information = swingManager.newInformationViewer();

		informationPanel.add(information.getSwingComponent(),

				BorderLayout.CENTER);

		add(informationPanel, BorderLayout.CENTER);

		actionPanel = new JPanel();

		BoxLayout actionPanelLayout = new BoxLayout(actionPanel,

				BoxLayout.X_AXIS);

		actionPanel.setLayout(actionPanelLayout);

		actionPanel.add(Box.createHorizontalGlue());

		actionPanel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));

		botOpen = usabManager.createJButton(new AbstractAction(swingManager

				.getTranslation("open_portable_view")) {

			/**

             *

             */

			private static final long serialVersionUID = -3437007146684939225L;

			public void actionPerformed(ActionEvent e) {

				openSelecteds();

			}

		});

		botOpen.setEnabled(false);

		botCancel = usabManager.createJButton(new AbstractAction(swingManager

				.getTranslation("cancel")) {

			/**

             *

             */

			private static final long serialVersionUID = -2227776656041247582L;

			public void actionPerformed(ActionEvent e) {

				close();

			}

		});

		actionPanel.add(botOpen);

		actionPanel.add(Box.createHorizontalStrut(10));

		actionPanel.add(botCancel);

		actionPanel.add(Box.createHorizontalStrut(5));

		add(actionPanel, BorderLayout.SOUTH);

	}

	/**

	 * Opens selecteds portable view

	 */

	private void openSelecteds() {

		int[] selecteds = list.getSelectedIndices();

		List<PortableViewDocument> documents = new ArrayList<PortableViewDocument>(

				selecteds.length);

		PortableViewDocument document;

		PortableView map;

		for (int index : selecteds) {

			map = maps.get(index);

			// create a new document

			document = documentManager.createDocument(map);

			documents.add(document);

		}

		this.documents = Collections.unmodifiableList(documents);

		close();

	}

	/**

	 * Close this dialog

	 */

	private void close() {

		this.setVisible(false);

		maps = null;

		lastSelected = null;

	}

	/**

	 * Update UI with Portable list selection

	 */

	public void valueChanged(ListSelectionEvent e) {

		int index = list.getSelectedIndex();

		if (index == lastSelectedIndex) {

			return;

		}

		lastSelectedIndex = index;

		if (index < 0) {

			cleanInformation();

			botOpen.setEnabled(false);

			return;

		}

		botOpen.setEnabled(true);

	}

	/**

	 * Cleans information map panel

	 */

	private void cleanInformation() {

		if (information != null) {

			information.clean();

		}

	}

	/**

	 * Set last selected item

	 *

	 * @param index

	 */

	private void lastSelection(int index) {

		cleanInformation();

		lastSelected = maps.get(index);

		information.loadMapInformation(lastSelected);

	}

	/**

	 * Return user document (Portable map) selection

	 *

	 * @return the document

	 */

	public List<PortableViewDocument> getDocuments() {

		return documents;

	}

}

/* 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.educa.portableview.app.viewer.exception;

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

/**

 * Exception occurs when a project is opening and a Portable view registered on

 * it is not installed

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class PortableViewNotFoundException extends PersistenceException {

    /**

     *

     */

    private static final long serialVersionUID = 5394324158268756432L;

    private final static String MESSAGE_FORMAT =

        "Portable View not found installed: id:%(id) ver:%(version) bn:%(buildNumber)";

    private final static String MESSAGE_KEY =

        "_portable_view_not_found_installed";

    private final String id;

    private final int version;

    private final int buildNumber;