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.Graphics2D;

import java.awt.print.PrinterJob;

import javax.swing.JPanel;

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

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

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

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

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

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

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

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.persistence.Persistent;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public abstract class LayoutPanel extends JPanel implements IDocumentWindow,

    ViewPortListener, Observer, Persistent {

    private static final long serialVersionUID = 5961147362842287273L;

    /**

     * Returns the LayoutContext.

     * 

     * @return LayoutContext.

     */

    public abstract LayoutContext getLayoutContext();

    /**

     * Returns LayoutControl.

     * 

     * @return LayoutControl.

     */

    public abstract LayoutControl getLayoutControl();

    /**

     * @return Returns the bShowIconTag.

     */

    public abstract boolean isShowIconTag();

    /**

     * @param modeDebug

     *            The bModeDebug to set.

     */

    public abstract void setShowIconTag(boolean modeDebug);

    /**

     * It opens a dialog to select pdf file where to save the Layout in this

     * format.

     */

    public abstract void layoutToPDF();

    /**

     * Opens a dialog where to pick a PDF-file to save the current Layout

     * suggesting a name for the file given by the first argument

     * 

     * @param suggestedName

     */

    public abstract void layoutToPDF(String suggestedName);

    /**

     * It opens a dialog to select ps file where to save the Layout in this

     * format.

     */

    public abstract void layoutToPS();

    /**

     * Opens a dialog where to pick a PS-file to save the current Layout

     * suggesting a name for the file given by the first argument

     * 

     * @param suggestedName

     */

    public abstract void layoutToPS(String suggestedName);

    /**

     * The dialogs are created here each time that are needed.

     * 

     * @param fframe

     *            Rectangle that represents the place that occupied the element

     *            added.

     * 

     * @return IFFrame Returns the FFrame added or null if the fframe has not

     *         been added.

     */

    public abstract IFFrameDialog createFFrameDialog(IFFrame fframe);

    /**

     * It obtains the rect?ngulo that represents the sheet with the

     * characteristics

     * that contains attributes and differentiating if is to visualize in screen

     * or

     * for print.

     * 

     */

    public abstract void obtainRect(boolean isPrint);

    /**

     * It shows the dialog of configuration of the Layout.

     */

    public abstract void showFConfig();

    /**

     * It shows the dialog of Layout?s properties.

     */

    public abstract boolean showFProperties();

    /**

     * It shows the dialog of printing of the Layout.

     * 

     * @param job

     *            PrinterJob

     */

    public abstract void showPrintDialog(PrinterJob job);

    public abstract void setLayoutManager(LayoutManager layoutManager);

    public abstract void drawLayoutPrint(Graphics2D g2);

}