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.project.documents.layout.gui;

import java.awt.BorderLayout;

import java.awt.Component;

import java.awt.Graphics2D;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.geom.AffineTransform;

import java.awt.geom.Rectangle2D;

import java.awt.print.PageFormat;

import java.awt.print.Printable;

import java.awt.print.PrinterException;

import java.awt.print.PrinterJob;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.io.File;

import javax.print.Doc;

import javax.print.DocFlavor;

import javax.print.DocPrintJob;

import javax.print.PrintException;

import javax.print.PrintService;

import javax.print.PrintServiceLookup;

import javax.print.ServiceUI;

import javax.print.SimpleDoc;

import javax.print.attribute.PrintRequestAttributeSet;

import javax.print.event.PrintJobAdapter;

import javax.print.event.PrintJobEvent;

import javax.print.event.PrintJobListener;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JSplitPane;

import javax.swing.filechooser.FileFilter;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.PluginsLocator;

import org.gvsig.andami.messages.NotificationManager;

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

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

import org.gvsig.app.ApplicationLocator;

import org.gvsig.app.gui.preferencespage.PreferenceKeys;

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.app.project.documents.layout.gui.dialogs.FConfigLayoutDialog;

import org.gvsig.app.project.documents.layout.toc.TocModelObserver;

import org.gvsig.app.project.documents.view.toc.gui.TOC;

import org.gvsig.fmap.mapcontext.MapContext;

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

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.observer.Observable;

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.gvsig.utils.XMLEntity;

/**

 * Graphic representation of the elements to print.

 * 

 * @author Vicente Caballero Navarro

 */

public class DefaultLayoutPanel extends LayoutPanel {

    private static final long serialVersionUID = 916830228032567624L;

    private static final int DEFAULT_HEIGHT = 450;

    private static final int DEFAULT_WIDTH = 700;

    public static final String PERSISTENCE_DEFINITION_NAME = "LayoutPanel";

    private static final String LAYOUTCONTEXT_OBJECT = "LayoutContext";

    private static final String LAYOUTDOCUMENT_OBJECT = "LayoutDocument";

    public static final String PDF_AND_PS_FILECHOOSER =

        "PDF_AND_PS_FILECHOOSER";

    public static File defaultPDFFolderPath;

    private MapProperties m_propertiesLayout = null;

    private PrintService[] m_cachePrintServices = null;

    private PrintService m_cachePrintService = null;

    private LayoutDocument layoutDocument = null;

    private Doc doc = null;

    private PrintRequestAttributeSet att = null;

    private WindowInfo m_viewInfo = null;

    /**

     * We use it when we are doing a layout and assigning tags.

     * It is put in debug when we do a VIEW_TAGS

     */

    private boolean bShowIconTag = false;

    private LayoutControl layoutControl = null;

    private LayoutContext layoutContext = null;

    private LayoutManager layoutManager = null;

        private JPanel leftPanel;

        private TOC toc = null;

        private JSplitPane splitPane;

        private int lastPanePos = 150;

        private Boolean b_isTocEnabled = null;

    /**

     * Creates a new Layout object.

     */

    public DefaultLayoutPanel() {

        DefaultLayoutControl defaultLayoutControl = new DefaultLayoutControl();

        this.layoutControl = defaultLayoutControl;

        defaultLayoutControl.initialize(this);       

        this.initComponents();

    }

    public void setDocument(Document document) {

        layoutDocument = (LayoutDocument) document;

        setLayoutContext(layoutDocument.getLayoutContext());

        this.setName(document.getName());

        layoutDocument.addPropertyChangeListener(new PropertyChangeListener() {

            public void propertyChange(PropertyChangeEvent evt) {

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

                    PluginServices

                        .getMDIManager()

                        .getWindowInfo(DefaultLayoutPanel.this)

                        .setTitle(

                            PluginServices.getText(this, "Mapa") + " : "

                                + (String) evt.getNewValue());

                }

            }

        });

        setToc();

    }

    /**

     * It initializes the components.

     */

    private void initComponents() {

            this.setLayout(new BorderLayout());

            if (isTocEnabled()) {

                    leftPanel = new JPanel(new BorderLayout());

                    splitPane = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT,

                                    leftPanel, layoutControl.getComponent());

                    splitPane.setResizeWeight(0.2);

                    splitPane.setOneTouchExpandable(true);

                    splitPane.setContinuousLayout(true);

                    setToc();

                    add(splitPane, BorderLayout.CENTER);

            }

            else {

                    add(layoutControl.getComponent(), BorderLayout.CENTER);

            }

        layoutControl.getComponent().setDoubleBuffered(true);

    }

    private boolean isTocEnabled() {

            if (b_isTocEnabled==null) {

                    XMLEntity entity = PluginsLocator.getManager().getPlugin(this).getPersistentXML();

                    if (entity.contains(PreferenceKeys.DEFAULT_SHOW_LAYOUT_TOC_KEY_NAME)) {

                            b_isTocEnabled = entity.getBooleanProperty(PreferenceKeys.DEFAULT_SHOW_LAYOUT_TOC_KEY_NAME);

                    }

                    else {

                            b_isTocEnabled = PreferenceKeys.FACTORY_DEFAULT_SHOW_LAYOUT_TOC;

                    }

            }

            return b_isTocEnabled;

    }

    protected void createToc() {

                if (toc==null) {

                        toc = new TOC();

                }

                toc.setMapContext(getLayoutContext().getTocModel());

                leftPanel.removeAll();

                leftPanel.add(toc);

    }

    protected void setToc() {

            if (isTocEnabled()) {

                    if (getLayoutContext()!=null) {

                            if (getLayoutContext().getTocModel()!=null) {

                                    createToc();

                            }

                            else if (toc!=null) {

                                    DefaultLayoutPanel.this.leftPanel.remove(toc);

                            }

                            this.getLayoutContext().addTocObserver(new TocModelObserver() {

                                    public void tocUpdated(Object observable,

                                                    TocModelChangedNotification notification) {

                                            if (TocModelChangedNotification.Type.ITEM_UPDATED==notification.getType()) {

                                                    if (DefaultLayoutPanel.this.toc!=null){

                                                            DefaultLayoutPanel.this.toc.repaint();

                                                    }

                                            }

                                            else if (TocModelChangedNotification.Type.MODEL_CHANGED==notification.getType()) {

                                                    if (DefaultLayoutPanel.this.toc!=null){

                                                            DefaultLayoutPanel.this.toc.refresh();

                                                    }

                                            }

                                            else if (TocModelChangedNotification.Type.MODEL_SET==notification.getType()) {

                                                    MapContext mapContext = notification.getModel();

                                                    if (mapContext!=null) {

                                                            createToc();

                                                    }

                                                    else if (DefaultLayoutPanel.this.toc!=null){

                                                            DefaultLayoutPanel.this.leftPanel.remove(DefaultLayoutPanel.this.toc);

                                                            DefaultLayoutPanel.this.leftPanel.repaint();

                                                    }

                                            }

                                    }

                            });

                    }

            }

    }

    /**

     * Open the dialog of Layout properties.

     * 

     * @param job

     *            PrinterJob

     */

    public void showPagePropertiesWindow(PrinterJob job) {

        PageFormat pf1;

        pf1 = layoutContext.getAttributes().getPageFormat();

        pf1 = job.pageDialog(pf1);

        layoutContext.getAttributes().setPageFormat(pf1);

        layoutControl.refresh();

    }

    public void obtainRect(boolean isPrint) {

            Rectangle2D r = layoutControl.getRect(); 

        layoutContext.getAttributes().obtainRect(isPrint,

            r, getWidth(), getHeight());

        layoutControl.setRect(r);

    }

    public void showFConfig() {

        FConfigLayoutDialog m_configLayout = new FConfigLayoutDialog(this);

        PluginServices.getMDIManager().addCentredWindow(m_configLayout);

    }

    public boolean showFProperties() {

        if (layoutDocument == null) {

            layoutDocument = new DefaultLayoutDocument();

            layoutDocument.setName(getName());

        }

        m_propertiesLayout = new MapProperties(layoutDocument);

        PluginServices.getMDIManager().addWindow(m_propertiesLayout);

        return m_propertiesLayout.isAccepted();

    }

    public void showPrintDialog(PrinterJob job) {

        if (job != null) {

            job.printDialog();

            try {

                job.setPrintable((Printable) PluginServices

                    .getExtension(org.gvsig.app.extension.Print.class));

                job.print();

            } catch (PrinterException e) {

                e.printStackTrace();

            }

        } else {

            // Actualizar attributes

            att = layoutContext.getAttributes().toPrintRequestAttributeSet();

            // ------------------ The Printing things --------------------- //

            DocFlavor flavor = DocFlavor.SERVICE_FORMATTED.PRINTABLE;

            // returns the set of printers that support printing a specific

            // document type (such as GIF)

            // with a specific set of attributes (such as two sided).

            // PrintRequestAttributeSet pras = new

            // HashPrintRequestAttributeSet();

            // interestingly, the printer dialog's default behavior has changed

            // with the new API: by default the dialog is not shown.

            // So we must use the ServiceUI class to create a print dialog

            // returns the default print service.

            if (m_cachePrintServices == null) {

                m_cachePrintServices =

                    PrintServiceLookup.lookupPrintServices(flavor, null);

            }

            PrintService defaultService = null;

            if (m_cachePrintService == null) {

                defaultService = PrintServiceLookup.lookupDefaultPrintService();

            }

            if ((defaultService == null) && (m_cachePrintService == null)) {

                JOptionPane.showMessageDialog((Component) PluginServices

                    .getMainFrame(), PluginServices.getText(this,

                    "ninguna_impresora_configurada"));

                return;

            }

            if (m_cachePrintService == null) {

                m_cachePrintService =

                    ServiceUI.printDialog(null, 200, 200, m_cachePrintServices,

                        defaultService, flavor, att);

            } else {

                m_cachePrintService =

                    ServiceUI.printDialog(null, 200, 200, m_cachePrintServices,

                        m_cachePrintService, flavor, att);

            }

            if (m_cachePrintService != null) {

                DocPrintJob jobNuevo = m_cachePrintService.createPrintJob();

                PrintJobListener pjlistener = new PrintJobAdapter() {

                    public void printDataTransferCompleted(PrintJobEvent e) {

                        // System.out.println("Fin de impresi?n");

                        layoutControl.fullRect();

                    }

                };

                jobNuevo.addPrintJobListener(pjlistener);

                Printable pb = null;

                Class repClass = null;

                try {

                     repClass = Class.forName(flavor.getRepresentationClassName());

                } catch (Throwable e) {

                    throw new IllegalArgumentException("unknown representation class");

                }

                Object printData = PluginServices.getExtension(org.gvsig.app.extension.Print.class);

                doc = new SimpleDoc(printData, flavor, null);

                try {

                    jobNuevo.print(doc, att);

                } catch (PrintException pe) {

                    NotificationManager.addError(pe);

                }

            }

        }

    }

    public IFFrameDialog createFFrameDialog(IFFrame fframe) {

        return layoutManager.createFFrameDialog(fframe, this);

    }

    /**

     * This method is used to get <strong>an initial</strong> ViewInfo object

     * for this Map. It is not intended to retrieve the ViewInfo object in a

     * later time. <strong>Use PluginServices.getMDIManager().getViewInfo(view)

     * to retrieve the ViewInfo object at any time after the creation of the

     * object.

     * 

     * @see com.iver.mdiApp.ui.MDIManager.IWindow#getWindowInfo()

     */

    public WindowInfo getWindowInfo() {

        if (m_viewInfo == null) {

            m_viewInfo =

                new WindowInfo(WindowInfo.ICONIFIABLE | WindowInfo.RESIZABLE

                    | WindowInfo.MAXIMIZABLE);

            m_viewInfo.setWidth(DEFAULT_WIDTH);

            m_viewInfo.setHeight(DEFAULT_HEIGHT);

            m_viewInfo.setTitle(PluginServices.getText(this, "Mapa") + " : "

                + layoutDocument.getName());

        }

        return m_viewInfo;

    }

    public LayoutContext getLayoutContext() {

        return layoutContext;

    }

    public LayoutControl getLayoutControl() {

        return layoutControl;

    }

    private boolean isInitConfigDialogEnabled() {

            XMLEntity entity = PluginsLocator.getManager().getPlugin(this).getPersistentXML();

            if (entity.contains(PreferenceKeys.DEFAULT_SHOW_INITIAL_CONFIG_DIALOG_KEY_NAME)) {

                    return entity.getBooleanProperty(PreferenceKeys.DEFAULT_SHOW_INITIAL_CONFIG_DIALOG_KEY_NAME);

            }

            else {

                    return PreferenceKeys.FACTORY_DEFAULT_SHOW_INITIAL_CONFIG_DIALOG_FOR_LAYOUT;

            }

    }

    protected void onInitialConfigCanceled() {

            if (layoutDocument!=null) {

                    ApplicationLocator.getManager().getUIManager().closeWindow(this);

                    ApplicationLocator.getProjectManager().getCurrentProject().removeDocument(layoutDocument);

            }

    }

    /**

     * @see com.iver.mdiApp.ui.MDIManager.IWindow#windowActivated()

     */

    public void windowActivated() {

                if (getLayoutContext()!=null && !getLayoutContext().hasDocBeenOpened()) {

                        getLayoutContext().setHasDocBeenOpened(true);

            if (isInitConfigDialogEnabled()) {

                    FConfigLayoutDialog configDialog = new FConfigLayoutDialog(this, true);

                    ApplicationLocator.getManager().getUIManager().addCentredWindow(configDialog);

                    configDialog.addCancelButtonActionListener(new ActionListener() {

                                        public void actionPerformed(ActionEvent e) {

                                                DefaultLayoutPanel.this.onInitialConfigCanceled();

                                        }

                    });

            }

            }

        layoutControl.refresh();

        PluginServices

            .getMainFrame()

            .getStatusBar()

            .setMessage(

                "units",

                PluginServices.getText(this, layoutContext.getAttributes()

                    .getNameUnit()));

        // ensure requestFocus is enabled

        if (!layoutControl.getComponent().isRequestFocusEnabled()) {

            layoutControl.getComponent().setRequestFocusEnabled(true);

        }

        // notify fframes

            IFFrame[] frames = layoutContext.getFFrames();

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

                    if (frames[i] instanceof LayoutPanelListener) {

                            ((LayoutPanelListener)frames[i]).windowActivated();

                    }

            }

        requestFocus();

        layoutControl.getComponent().requestFocus();

    }

    /**

     * @see com.iver.mdiApp.ui.MDIManager.SingletonWindow#getWindowModel()

     */

    public Object getWindowModel() {

        return layoutDocument;

    }

    public Document getDocument() {

        return layoutDocument;

    }

    /**

     * @see org.gvsig.andami.ui.mdiManager.IWindowListener#windowClosed()

     */

    public void windowClosed() {

            IFFrame[] frames = layoutContext.getFFrames();

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

                    if (frames[i] instanceof LayoutPanelListener) {

                            ((LayoutPanelListener)frames[i]).windowClosed();

                    }

            }

    }

    /**

     * @see org.gvsig.fmap.mapcontext.events.listeners.ViewPortListener#backColorChanged(org.gvsig.fmap.mapcontext.events.ColorEvent)

     */

    public void backColorChanged(ColorEvent e) {

        // refresh();

    }

    public void layoutToPDF(String suggestedName) {

        FileFilter pdfFilter =

            new GenericFileFilter("pdf", PluginServices.getText(this, "pdf"));

        JFileChooser jfc =

            new JFileChooser(PDF_AND_PS_FILECHOOSER, defaultPDFFolderPath);

        if (suggestedName != null) {

            jfc.setSelectedFile(new File(suggestedName));

        }

        jfc.addChoosableFileFilter(pdfFilter);

        jfc.setFileFilter(pdfFilter);

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

            File f = jfc.getSelectedFile();

            File faux = null;

            if (f.getName().endsWith(".pdf") || f.getName().endsWith(".PDF")) {

                faux = f;

            } else {

                faux = new File(f.getPath() + ".pdf");

            }

            layoutControl.getLayoutDraw().toPDF(faux);

        }

    }

    public void layoutToPS(String suggestedName) {

        FileFilter pdfFilter =

            new GenericFileFilter("ps", PluginServices.getText(this, "ps"));

        JFileChooser jfc =

            new JFileChooser(PDF_AND_PS_FILECHOOSER, defaultPDFFolderPath);

        if (suggestedName != null) {

            jfc.setSelectedFile(new File(suggestedName));

        }

        jfc.addChoosableFileFilter(pdfFilter);

        jfc.setFileFilter(pdfFilter);

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

            File f = jfc.getSelectedFile();

            File faux = null;

            if (f.getName().endsWith(".ps") || f.getName().endsWith(".PS")) {

                faux = f;

            } else {

                faux = new File(f.getPath() + ".ps");

            }

            layoutControl.getLayoutDraw().toPS(faux);

        }

    }

    public void layoutToPDF() {

        layoutToPDF(null);

    }

    public void layoutToPS() {

        layoutToPS(null);

    }

    public boolean isShowIconTag() {

        return bShowIconTag;

    }

    public void setShowIconTag(boolean modeDebug) {

        bShowIconTag = modeDebug;

    }

    public void update(Observable observable, Object notification) {

            this.layoutContext.updateFFrames();

            this.layoutControl.refresh();

    }

    public Object getWindowProfile() {

        return WindowInfo.EDITOR_PROFILE;

    }

    public void saveToState(PersistentState state) throws PersistenceException {

        state.set(LAYOUTCONTEXT_OBJECT, layoutContext);

        state.set(LAYOUTDOCUMENT_OBJECT, layoutDocument);

    }

    public void loadFromState(PersistentState state)

        throws PersistenceException {

        this.layoutContext = (LayoutContext) state.get(LAYOUTCONTEXT_OBJECT);

        this.setDocument((LayoutDocument) state.get(LAYOUTDOCUMENT_OBJECT));

    }

    public static void registerPersistent() {

        PersistenceManager manager = ToolsLocator.getPersistenceManager();

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

            DynStruct definition =

                manager.addDefinition(DefaultLayoutPanel.class,

                    PERSISTENCE_DEFINITION_NAME,

                    "Layout panel persistence definition", null, null);

            definition.addDynFieldObject(LAYOUTCONTEXT_OBJECT)

                .setClassOfValue(LayoutContext.class).setMandatory(true);

            definition.addDynFieldObject(LAYOUTDOCUMENT_OBJECT)

                .setClassOfValue(LayoutDocument.class).setMandatory(true);

        }

    }

    public WindowLayout getWindowLayout() {

        return null;

    }

    public void setWindowLayout(WindowLayout layout) {

    }

    private void setLayoutContext(LayoutContext theLayoutcontext) {

        this.layoutContext = theLayoutcontext;

        this.layoutControl.setLayoutContext(theLayoutcontext);

        layoutContext.getAttributes().calculateGridGapX(layoutControl.getRect());

        layoutContext.getAttributes().calculateGridGapY(layoutControl.getRect());

        layoutControl.setDefaultTool();

    }

    @Override

    public void setLayoutManager(LayoutManager layoutManager) {

        this.layoutManager = layoutManager;

    }

    /**

     * Method to print the Layout without modify the Affinetransform.

     *

     * @param g2 Geaphics2D

     */

    public void drawLayoutPrint(Graphics2D g2) {

        layoutControl.setCancelDrawing(false);

        double scale = 0;

        scale = layoutControl.getRect().height / layoutContext.getAttributes().m_sizePaper.getHeight() * 1;

        AffineTransform escalado = new AffineTransform();

        AffineTransform translacion = new AffineTransform();

        translacion.setToTranslation(layoutControl.getRect().getMinX(), layoutControl.getRect().getMinY());

        escalado.setToScale(scale, scale);

        layoutControl.getAT().setToIdentity();

        layoutControl.getAT().concatenate(translacion);

        layoutControl.getAT().concatenate(escalado);

        layoutContext.getAttributes().calculateGridGapX(layoutControl.getRect());

        layoutContext.getAttributes().calculateGridGapY(layoutControl.getRect());

        IFFrame[] fframes=layoutContext.getFFrames();

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

            fframes[i].print(

                g2,

                layoutControl.getAT(),

                null,

                layoutContext.getAttributes().toPrintAttributes());

        }

    }

        public void hideToc() {

                if (isTocEnabled()) {

                        lastPanePos = splitPane.getDividerLocation();

                        splitPane.setDividerLocation(0);

                }

        }

        public void showToc() {

                if (isTocEnabled()) {

                        splitPane.setDividerLocation(lastPanePos);

                }

        }

}