Application: gvSIG desktop » gvSIG Document Layout

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

import java.awt.Component;

import java.beans.PropertyVetoException;

import java.io.File;

import java.io.FileInputStream;

import java.io.IOException;

import java.util.Iterator;

import java.util.prefs.Preferences;

import javax.swing.JOptionPane;

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.andami.ui.mdiManager.MDIManager;

import org.gvsig.app.ApplicationLocator;

import org.gvsig.app.ApplicationManager;

import org.gvsig.app.project.Project;

import org.gvsig.app.project.ProjectManager;

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

import org.gvsig.app.project.documents.layout.DefaultLayoutManager;

import org.gvsig.app.project.documents.layout.LayoutDocument;

import org.gvsig.app.project.documents.layout.LayoutManager;

import org.gvsig.app.project.documents.layout.contextmenu.gui.BeforeLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.BehindLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.CancelLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.CopyLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.CutLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.PasteLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.PositionLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.PropertyLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.RefreshLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.SelectAllLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.SimplifyLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.contextmenu.gui.TerminateLayoutMenuEntry;

import org.gvsig.app.project.documents.layout.fframes.FFrame;

import org.gvsig.app.project.documents.layout.fframes.FFrameBasicFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameGraphics;

import org.gvsig.app.project.documents.layout.fframes.FFrameGraphicsFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameGrid;

import org.gvsig.app.project.documents.layout.fframes.FFrameGridFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameGroup;

import org.gvsig.app.project.documents.layout.fframes.FFrameGroupFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameLegend;

import org.gvsig.app.project.documents.layout.fframes.FFrameLegendFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameNorth;

import org.gvsig.app.project.documents.layout.fframes.FFrameNorthFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameOverView;

import org.gvsig.app.project.documents.layout.fframes.FFrameOverViewFactory;

import org.gvsig.app.project.documents.layout.fframes.FFramePicture;

import org.gvsig.app.project.documents.layout.fframes.FFramePictureFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameScaleBar;

import org.gvsig.app.project.documents.layout.fframes.FFrameScaleBarFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameSymbol;

import org.gvsig.app.project.documents.layout.fframes.FFrameSymbolFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameTable;

import org.gvsig.app.project.documents.layout.fframes.FFrameTableFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameText;

import org.gvsig.app.project.documents.layout.fframes.FFrameTextFactory;

import org.gvsig.app.project.documents.layout.fframes.FFrameView;

import org.gvsig.app.project.documents.layout.fframes.FFrameViewFactory;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameBoxDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameGraphicsDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameGridDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameGroupDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameLegendDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameNorthDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameOverViewDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFramePictureDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameScaleBarDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameTextDialog;

import org.gvsig.app.project.documents.layout.fframes.gui.dialogs.FFrameViewDialog;

import org.gvsig.app.project.documents.layout.gui.LayoutPanel;

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

import org.gvsig.i18n.Messages;

import org.gvsig.layout.mapbox.MapBoxUtils;

import org.gvsig.layout.mapbox.panel.menu.AddColumnMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.AddRowMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.CombineCellsMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.InsertColumnMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.InsertRowMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.RemoveCellsMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.RemoveColumnMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.RemoveRowMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.SplitCellsHorizontallyMapBoxMenuEntry;

import org.gvsig.layout.mapbox.panel.menu.SplitCellsVerticallyMapBoxMenuEntry;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.extensionpoint.ExtensionPointManager;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.PersistentState;

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

import org.gvsig.utils.GenericFileFilter;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Extension que proporciona controles para crear proyectos nuevos, abrirlos y

 * guardarlos. Adem?s los tipos de tabla que soporta el proyecto son a?adidos en

 * esta clase.

 * 

 * @author gvSIG team

 */

public class LayoutMainExtension extends Extension {

    private static final Logger logger = LoggerFactory

            .getLogger(FFrameView.class);

    private String templatesPath;

    public static final String LAYOUT_TEMPLATE_FILECHOOSER_ID = "LAYOUT_TEMPLATE_FILECHOOSER_ID";

    private void registerIcons() {

        IconThemeHelper.registerIcon("action",

                "application-layout-template-open", this);

        IconThemeHelper.registerIcon("action",

                "application-layout-new", this);

    }

    @Override

    public void initialize() {

        registerIcons();

    }

    @Override

    public void postInitialize() {

        super.postInitialize();

        initializeDocumentActionsExtensionPoint();

        registerDocuments();

        registerFFrames();

        registerContextMenuOptions();

    }

    @Override

    public void execute(String actionCommand) {

        if ("application-layout-template-open".equals(actionCommand)) {

            openLayout();

        } else if ("application-layout-new".equals(actionCommand)) { 

            newLayout();   

        }

    }

    private void newLayout() {

        ApplicationManager application = ApplicationLocator.getManager();

        ProjectManager projectManager = ApplicationLocator.getProjectManager();

        I18nManager i18nManager = ToolsLocator.getI18nManager();

        Project project = projectManager.getCurrentProject();

        Iterator<? extends Document> documents =

            projectManager.createDocumentsByUser(LayoutManager.TYPENAME);

        for (; (documents != null) && (documents.hasNext());) {

            try {

                Document document = documents.next();

                project.addDocument(document);

                IWindow window = document.getFactory().getMainWindow(document);

                if (window == null) {

                    application.messageDialog(

                            i18nManager.getTranslation("error_opening_the_document"), 

                            i18nManager.getTranslation("warning"), 

                            JOptionPane.WARNING_MESSAGE

                    );

                    continue;

                }

                application.getUIManager().addWindow(

                    window,

                    MDIManager.ALIGN_FIRST_LINE_END_CASCADE

                );

                try {

                    application.getUIManager().setMaximum(window, true);

                } catch (PropertyVetoException e) {

                    logger.info("Can't maximize layout.", e);

                }

            } catch (Exception e) {

                logger.warn("Problems creating a Layout document.",e);

            }

        }        

    }

    private void openLayout() {

        LayoutPanel layout = null;

        if (templatesPath == null) {

            Preferences prefs = Preferences.userRoot().node("gvsig.foldering");

            templatesPath = prefs.get("TemplatesFolder", null);

        }

        JFileChooser jfc = new JFileChooser(LAYOUT_TEMPLATE_FILECHOOSER_ID,

                templatesPath);

        GenericFileFilter layoutMainExtensionFilter = new GenericFileFilter(

                LayoutManager.TEMPLATE_FILE_POINTEXT,

                Messages.getText("_Layout_template") + " (*"

                        + LayoutManager.TEMPLATE_FILE_POINTEXT + ")");

        jfc.addChoosableFileFilter(layoutMainExtensionFilter);

        jfc.setFileFilter(layoutMainExtensionFilter);

        if (jfc.showOpenDialog((Component) PluginServices.getMainFrame()) == JFileChooser.APPROVE_OPTION) {

            File file = jfc.getSelectedFile();

            try {

                if (!file.exists()) {

                    /*

                     * The user has written a file name instead of clicking on

                     * one and it does not exist

                     */

                    File auxfile = new File(file.getPath()

                            + LayoutManager.TEMPLATE_FILE_POINTEXT);

                    if (!auxfile.exists()) {

                        /*

                         * Not even this one exists: error

                         */

                        throw new IOException("File does not exist: "

                                + file.getName());

                    }

                    else {

                        file = auxfile;

                    }

                }

                File xmlFile = new File(file.getAbsolutePath());

                FileInputStream is = new FileInputStream(xmlFile);

                PersistenceManager persistenceManager = ToolsLocator

                        .getPersistenceManager();

                PersistentState persistentState = persistenceManager

                        .loadState(is);

                layout = (LayoutPanel) persistenceManager

                        .create(persistentState);

            }

            catch (Exception e) {

                String tit = Messages.getText("_Layout_template");

                String msg;

                if (e instanceof PersistenceException) {

                    msg = Messages.getText("_Bad_format_in_layout_template");

                }

                else {

                    msg = Messages.getText("_Cant_load_layout_template");

                }

                msg = msg + ": " + file.getPath();

                msg = msg + "\n" + e.getMessage();

                logger.warn(msg, e);

                JOptionPane.showMessageDialog(ApplicationLocator.getManager()

                        .getRootComponent(), msg, tit,

                        JOptionPane.ERROR_MESSAGE);

            }

            if (layout == null) {

                return;

            }

            LayoutDocument layoutDocument = (LayoutDocument) layout

                    .getDocument();

            /*

             * (LayoutDocument) ProjectManager.getInstance().createDocument(

             * DefaultLayoutManager.TYPENAME, file.getName());

             */

            Project p = ApplicationLocator.getManager().getProjectManager()

                    .getCurrentProject();

            p.addDocument(layoutDocument);

            layout.getLayoutControl().setTool("layoutselect");

            LayoutManager lm = (LayoutManager) layoutDocument.getFactory();

            layout.setLayoutManager(lm);

            PluginServices.getMDIManager().addWindow(layout);

        }

    }

    private void registerDocuments() {

        DefaultLayoutManager.register();

    }

    private void registerFFrames() {

        DefaultLayoutManager layoutManager = (DefaultLayoutManager) ProjectManager

                .getInstance()

                .getDocumentManager(DefaultLayoutManager.TYPENAME);

        // Register Frames

        layoutManager.registerFrameFactory(new FFrameBasicFactory());

        layoutManager.registerFrameFactory(new FFrameGraphicsFactory());

        layoutManager.registerFrameFactory(new FFrameGroupFactory());

        layoutManager.registerFrameFactory(new FFrameLegendFactory());

        layoutManager.registerFrameFactory(new FFrameNorthFactory());

        layoutManager.registerFrameFactory(new FFrameOverViewFactory());

        layoutManager.registerFrameFactory(new FFramePictureFactory());

        layoutManager.registerFrameFactory(new FFrameScaleBarFactory());

        layoutManager.registerFrameFactory(new FFrameSymbolFactory());

        layoutManager.registerFrameFactory(new FFrameTableFactory());

        layoutManager.registerFrameFactory(new FFrameTextFactory());

        layoutManager.registerFrameFactory(new FFrameViewFactory());

        layoutManager.registerFrameFactory(new FFrameGridFactory());

        // Register FFrameDialogs forms

        layoutManager.registerFFrameDialog(

                FFrameGraphics.PERSISTENCE_DEFINITION_NAME,

                FFrameGraphicsDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameSymbol.PERSISTENCE_DEFINITION_NAME,

                FFrameGraphicsDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameGroup.PERSISTENCE_DEFINITION_NAME,

                FFrameGroupDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameTable.PERSISTENCE_DEFINITION_NAME, FFrameBoxDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameLegend.PERSISTENCE_DEFINITION_NAME,

                FFrameLegendDialog.class);

        layoutManager.registerFFrameDialog(

                FFramePicture.PERSISTENCE_DEFINITION_NAME,

                FFramePictureDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameNorth.PERSISTENCE_DEFINITION_NAME,

                FFrameNorthDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameScaleBar.PERSISTENCE_DEFINITION_NAME,

                FFrameScaleBarDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameText.PERSISTENCE_DEFINITION_NAME, FFrameTextDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameView.PERSISTENCE_DEFINITION_NAME, FFrameViewDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameOverView.PERSISTENCE_DEFINITION_NAME,

                FFrameOverViewDialog.class);

        layoutManager.registerFFrameDialog(

                FFrameGrid.PERSISTENCE_DEFINITION_NAME, FFrameGridDialog.class);

        MapBoxUtils.register(layoutManager);

        FFrame.initializeIcons();

        FFrameTable.initializeIcons();

    }

    private void registerContextMenuOptions() {

        LayoutManager layoutManager = (LayoutManager) ProjectManager

                .getInstance().getDocumentManager("project.document.layout");

        layoutManager.registerLayoutMenuAction("Terminate",

                TerminateLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Cancel",

                CancelLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Copy",

                CopyLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Cut", CutLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Paste",

                PasteLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Simplify",

                SimplifyLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Property",

                PropertyLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("SelectAll",

                SelectAllLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Behind",

                BehindLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Before",

                BeforeLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Position",

                PositionLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("Refresh",

                RefreshLayoutMenuEntry.class);

        layoutManager.registerLayoutMenuAction("CombineCells",

                CombineCellsMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("SplitCellsVertically",

                SplitCellsVerticallyMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("SplitCellsHorizontally",

                SplitCellsHorizontallyMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("InsertColumnMapBoxMenuEntry",

                InsertColumnMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("AddColumnMapBoxMenuEntry",

                AddColumnMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("InsertRowMapBoxMenuEntry",

                InsertRowMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("AddRowMapBoxMenuEntry",

                AddRowMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("RemoveColumnMapBoxMenuEntry",

                RemoveColumnMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("RemoveRowMapBoxMenuEntry",

                RemoveRowMapBoxMenuEntry.class);

        layoutManager.registerLayoutMenuAction("RemoveCellsMapBoxMenuEntry",

                RemoveCellsMapBoxMenuEntry.class);

    }

    private void initializeDocumentActionsExtensionPoint() {

        ExtensionPointManager epMan = ToolsLocator.getExtensionPointManager();

        epMan.add(

                "DocumentActions_Map",

                "Context menu options of the map document list"

                        + " in the project window "

                        + "(register instances of "

                        + "org.gvsig.app.project.AbstractDocumentContextMenuAction)");

    }

    @Override

    public boolean isEnabled() {

        return true;

    }

    @Override

    public boolean isVisible() {

        return true;

    }

}