Application: gvSIG desktop » gvSIG Document Layout

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

    <modelVersion>4.0.0</modelVersion>

    <artifactId>org.gvsig.app.document.layout2.app</artifactId>

    <packaging>pom</packaging>

    <version>2.0.242</version>

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

    <description>This plugin adds creation/management of layout (map) documents.</description>

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.desktop</artifactId>

        <version>2.0.378</version>

    </parent>

	<url>https://devel.gvsig.org/redmine/projects/gvsig-app-document-layout</url>

    <scm>

        <connection>scm:svn:https://devel.gvsig.org/svn/gvsig-app-document-layout/tags/org.gvsig.app.document.layout2.app-2.0.242</connection>

        <developerConnection>scm:svn:https://devel.gvsig.org/svn/gvsig-app-document-layout/tags/org.gvsig.app.document.layout2.app-2.0.242</developerConnection>

        <url>https://devel.gvsig.org/redmine/projects/gvsig-app-document-layout/repository/show/tags/org.gvsig.app.document.layout2.app-2.0.242</url>

    </scm>

    <repositories>

      <repository>

        <id>gvsig-public-http-repository</id>

        <name>gvSIG maven public HTTP repository</name>

        <url>http://devel.gvsig.org/m2repo/j2se</url>

        <releases>

          <enabled>true</enabled>

          <updatePolicy>daily</updatePolicy>

          <checksumPolicy>warn</checksumPolicy>

        </releases>

        <snapshots>

          <enabled>true</enabled>

          <updatePolicy>daily</updatePolicy>

          <checksumPolicy>warn</checksumPolicy>

        </snapshots>

      </repository>

    </repositories>

	<build>

		<plugins>

			<plugin>

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

				<artifactId>maven-release-plugin</artifactId>

				<configuration>

					<tagBase>https://devel.gvsig.org/svn/gvsig-app-document-layout/tags</tagBase>

				</configuration>

			</plugin>

		</plugins>

	</build>

    <dependencyManagement>

         <dependencies>

            <!--

            Versions of child projects

            -->

            <dependency>

                <groupId>org.gvsig</groupId>

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

                <version>2.0.242</version>

            </dependency>

        </dependencies>

    </dependencyManagement>

	<modules>

		<module>org.gvsig.app.document.layout2.app.mainplugin</module>

	</modules>

</project>

Put into this folder the resources needed by your test classes.

This folder is added to the Tests classpath, so you can load any resources 

through the ClassLoader.

By default, in this folder you can find an example of log4j configuration,

prepared to log messages through the console, so logging works when you

run your tests classes.

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

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]\n  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	org.gvsig.tools packages.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig.tools">

		<priority value="DEBUG" />

	</category>

	<category name="org.gvsig.app.document.layout">

		<priority value="DEBUG" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

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

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

import java.awt.geom.AffineTransform;

import java.lang.reflect.Array;

import java.text.NumberFormat;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Comparator;

import java.util.Iterator;

import java.util.List;

import javax.swing.ImageIcon;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.PluginsLocator;

import org.gvsig.andami.messages.NotificationManager;

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

import org.gvsig.app.ApplicationLocator;

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

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.actions.CopyDocumentAction;

import org.gvsig.app.project.documents.actions.CutDocumentAction;

import org.gvsig.app.project.documents.actions.PasteDocumentAction;

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.extensionpoint.ExtensionPoint;

import org.gvsig.tools.extensionpoint.ExtensionPoint.Extension;

import org.gvsig.tools.extensionpoint.ExtensionPointManager;

import org.gvsig.tools.persistence.PersistenceManager;

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

import org.gvsig.utils.XMLEntity;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Factory of maps.

 * 

 * @author Vicente Caballero Navarro

 */

public class DefaultLayoutManager extends AbstractDocumentManager implements

    LayoutManager {

    static final Logger LOG = LoggerFactory

        .getLogger(DefaultLayoutManager.class);

    static final String KEY_LAYOUT_FFRAMEDIALOG =

        "app.project.documents.layout.fframes.gui";

    static final String KEY_LAYOUT_FFRAME =

        "app.project.documents.layout.fframes";

    public static final String PERSISTENCE_LAYOUT_DOCUMENT_DEFINITION_NAME =

        "LayoutDocument";

    private static final String LAYOUT_CONTEXT_MENUS = "Layout_ContextMenus";

    ExtensionPointManager extensionPoints = ToolsLocator

        .getExtensionPointManager();

    private Boolean defaultShowGrid = null;

    private Boolean defaultAdjustToGrid = null;

    private Boolean defaultShowRulers = null;

    private DynStruct persistenceDefinition;

    /**

     * Returns image of button.

     * 

     * @return Image button.

     */

    public ImageIcon getIcon() {

    	return ToolsSwingLocator.getIconThemeManager().getCurrent().get("document-map-icon");

    }

    /**

     * Returns image of selected button.

     * 

     * @return Image button.

     */

    public ImageIcon getIconSelected() {

        return ToolsSwingLocator.getIconThemeManager().getCurrent().get("document-map-icon-sel");

    }

    /**

     * Returns the name of registration in the point of extension.

     * 

     * @return Name of registration

     */

    public String getTypeName() {

        return TYPENAME;

    }

    /**

     * Returns the name of ProjectDocument.

     * 

     * @return Name of ProjectDocument.

     */

    public String getTitle() {

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

    }

    public AbstractDocument createDocument() {

        return new DefaultLayoutDocument(this);

    }

    public Class getMainWindowClass() {

        return LayoutPanelImpl.class;

    }

    public IWindow getMainWindow(Document doc, WindowLayout layout) {

        LayoutPanel layoutPanel = (LayoutPanel) super.getMainWindow(doc, layout);

        if (layoutPanel == null) {

            layoutPanel = (LayoutPanel) this.createDocumentWindow(doc);

            if (layout != null) {

                layoutPanel.setWindowLayout(layout);

                layoutPanel.setLayoutManager(this);

                layoutPanel.getLayoutControl().fullRect();

                layoutPanel.getWindowInfo().setTitle(

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

                        + layoutPanel.getName());

            }

        }

        ((AbstractDocument) doc).raiseEventCreateWindow(layoutPanel);

        return layoutPanel;

    }

    public IFFrameDialog createFFrameDialog(IFFrame fframe,

        LayoutPanel layoutPanel, AffineTransform affineTransform) {

        ExtensionPoint ep = extensionPoints.add(KEY_LAYOUT_FFRAMEDIALOG);

        try {

            Object[] args = new Object[2];

            args[0] = layoutPanel;

            args[1] = fframe;

            Object obj = ep.create(fframe.getName(), args);

            if (obj != null) {

                IFFrameDialog fframedialog = (IFFrameDialog) obj;

                fframedialog.setRectangle(fframe

                    .getBoundingBox(affineTransform));

                return fframedialog;

            }

        } catch (Exception e) {

            LOG.error("Error creating a FFrameDialog", e);

        }

        return null;

    }

    public IFFrameDialog createFFrameDialog(IFFrame fframe,

        LayoutPanel layoutPanel) {

        return createFFrameDialog(fframe, layoutPanel, layoutPanel

            .getLayoutControl().getAT());

    }

    public void registerFrameFactory(FrameFactory frameFactory, String alias) {

        ExtensionPoint ep =

            ToolsLocator.getExtensionPointManager().add(KEY_LAYOUT_FFRAME);

        ep.append(frameFactory.getRegisterName(), "", frameFactory);

        if (alias != null) {

            ep.addAlias(frameFactory.getRegisterName(), alias);

        }

    }

    public void registerFrameFactory(FrameFactory frameFactory) {

        registerFrameFactory(frameFactory, null);

    }

    @SuppressWarnings("unchecked")

    public IFFrame createFrame(String frameName) {

        Iterator<Extension> iterator =

            ToolsLocator.getExtensionPointManager().get(KEY_LAYOUT_FFRAME)

                .iterator();

        while (iterator.hasNext()) {

            try {

                FrameFactory frameFactory =

                    (FrameFactory) iterator.next().create();

                if (frameFactory.getRegisterName().equals(frameName)) {

                    IFFrame frame = frameFactory.createFrame();

                    if (frame == null) {

                        return null;

                    }

                    frame.setFrameFactory(frameFactory);

                    return frame;

                }

            } catch (Exception e) {

                NotificationManager.addError(e);

            }

        }

        return null;

    }

    @SuppressWarnings("unchecked")

    public void registerFFrameDialog(String name, Class clazz) {

        if (!IFFrameDialog.class.isAssignableFrom(clazz)) {

            throw new IllegalArgumentException(clazz.getName()

                + " must implement the IFFrameDialog interface");

        }

        ExtensionPoint extensionPoint =

            extensionPoints.add(KEY_LAYOUT_FFRAMEDIALOG, "");

        extensionPoint.append(name, name, clazz);

    }

    @Override

    public IWindow getPropertiesWindow(Document doc) {

        IWindow win = super.getPropertiesWindow(doc);

        if( win == null ) {

            win = new MapProperties((LayoutDocument) doc);

        }

        return win;

    }

    /**

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

     * 

     */

    public static void register() {

        DefaultLayoutManager factory = new DefaultLayoutManager();

        PersistenceManager manager = ToolsLocator.getPersistenceManager();

        manager.registerFactory(factory);

        ProjectManager.getInstance().registerDocumentFactory(factory);

        ProjectManager.getInstance().registerDocumentAction(TYPENAME,new CopyDocumentAction());

        ProjectManager.getInstance().registerDocumentAction(TYPENAME,new CutDocumentAction());

        ProjectManager.getInstance().registerDocumentAction(TYPENAME,new PasteDocumentAction());

        if (factory.persistenceDefinition == null) {

            factory.persistenceDefinition =

                manager.addDefinition(LayoutDocument.class,

                    PERSISTENCE_LAYOUT_DOCUMENT_DEFINITION_NAME,

                    "Layout document Persistence definition", null, null);

            factory.persistenceDefinition.extend(manager

                .getDefinition(AbstractDocument.PERSISTENCE_DEFINITION_NAME));

            factory.persistenceDefinition

                .addDynFieldObject(DefaultLayoutDocument.LAYOUT_CONTEXT_OBJECT)

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

            DefaultLayoutPanel.registerPersistent();

            DefaultLayoutContext.registerPersistent();

        }

    }

    public int getPriority() {

        return 2;

    }

    /**

     * Sets whether the grid should be shown.

     * 

     * @param showGrid

     */

    public void setDefaultShowGrid(boolean showGrid) {

        defaultShowGrid = new Boolean(showGrid);

    }

    /**

     * Sets whether the snapping to grid should be enabled or not

     * 

     * @param gridEnable

     */

    public void setDefaultAdjustToGrid(boolean gridEnabled) {

        defaultAdjustToGrid = new Boolean(gridEnabled);

    }

    /**

     * Sets whether the ruler should be shown or not

     * 

     * @param showRuler

     */

    public void setDefaultShowRulers(boolean showRules) {

        defaultShowRulers = new Boolean(showRules);

    }

    /**

     * Returns if the grid should be shown.

     * 

     * @return True if the grid should be shown.

     */

    public boolean getDefaultShowGrid() {

        if (defaultShowGrid == null) {

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

            if (xml.contains(PreferenceKeys.DEFAULT_SHOW_LAYOUT_GRID_KEY_NAME)) {

                defaultShowGrid =

                    new Boolean(xml.getBooleanProperty(PreferenceKeys.DEFAULT_SHOW_LAYOUT_GRID_KEY_NAME));

            } else {

                defaultShowGrid = new Boolean(PreferenceKeys.FACTORY_DEFAULT_LAYOUT_GRID_SHOW);

            }

        }

        return defaultShowGrid.booleanValue();

    }

    /**

     * Returns if the adjust to grid should be active.

     * 

     * @return True if the adjust to grid should be active.

     */

    public boolean getDefaultAdjustToGrid() {

        if (defaultAdjustToGrid == null) {

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

            if (xml.contains(PreferenceKeys.DEFAULT_ENABLE_LAYOUT_GRID_KEY_NAME)) {

                defaultAdjustToGrid =

                    new Boolean(

                        xml.getBooleanProperty(PreferenceKeys.DEFAULT_ENABLE_LAYOUT_GRID_KEY_NAME));

            } else {

                defaultAdjustToGrid = new Boolean(PreferenceKeys.FACTORY_DEFAULT_LAYOUT_GRID_ENABLE);

            }

        }

        return defaultAdjustToGrid.booleanValue();

    }

    /**

     * Returns if the ruler should be shown.

     * 

     * @return True if the ruler should be shown.

     */

    public boolean getDefaultShowRulers() {

        if (defaultShowRulers == null) {

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

            if (xml.contains(PreferenceKeys.DEFAULT_SHOW_LAYOUT_RULERS_KEY_NAME)) {

                defaultShowRulers =

                    new Boolean(

                        xml.getBooleanProperty(PreferenceKeys.DEFAULT_SHOW_LAYOUT_RULERS_KEY_NAME));

            } else {

                defaultShowRulers = new Boolean(PreferenceKeys.FACTORY_DEFAULT_LAYOUT_ENABLE_RULERS);

            }

        }

        return defaultShowRulers.booleanValue();

    }

    public boolean getDefaultShowInitialPageConfigDialog() {

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

    	boolean value;

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

            value = xml.getBooleanProperty(PreferenceKeys.DEFAULT_SHOW_INITIAL_CONFIG_DIALOG_KEY_NAME);

        } else {

        	value = PreferenceKeys.FACTORY_DEFAULT_SHOW_INITIAL_CONFIG_DIALOG_FOR_LAYOUT;

        }

        return value;

    }

    public DynStruct getDefinition(String className) {

        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("unchecked")

    protected Class getDocumentClass() {

        return DefaultLayoutDocument.class;

    }

    public boolean manages(Object object) {

        return object instanceof LayoutDocument;

    }

    public void registerLayoutMenuAction(String name,

        Class<? extends IContextMenuAction> clazz) {

        ExtensionPoint extensionPoint =

            ToolsLocator.getExtensionPointManager().add(LAYOUT_CONTEXT_MENUS);

        extensionPoint.append(name, "", clazz);

    }

    public IContextMenuAction[] createLayoutMenuActions(LayoutPanel layoutPanel) {

        List<IContextMenuAction> actionArrayList =

            new ArrayList<IContextMenuAction>();

        @SuppressWarnings("unchecked")

        Iterator<ExtensionPoint.Extension> iter =

            ToolsLocator.getExtensionPointManager().get(LAYOUT_CONTEXT_MENUS).iterator();

        AbstractLayoutContextMenuAction action;

        while (iter.hasNext()) {

            action = null;

            try {

                action = (AbstractLayoutContextMenuAction) iter.next().create();

            } catch (InstantiationException e) {

                LOG.error("Error creating the context menu", e);

            } catch (IllegalAccessException e) {

                LOG.error("Error creating the context menu", e);

            }

            if (action != null) {

                action.setLayout(layoutPanel);

                if (action.isVisible(null, layoutPanel.getLayoutContext().getSelectedFFrames())) {

                    actionArrayList.add(action);

                }

            }

        }

        IContextMenuAction[] result =

            (IContextMenuAction[]) Array.newInstance(IContextMenuAction.class,

                actionArrayList.size());

        System.arraycopy(actionArrayList.toArray(), 0, result, 0,

            actionArrayList.size());

        Arrays.sort(result, new CompareAction());

        return result;

    }

    private class CompareAction implements Comparator<IContextMenuAction> {

        public int compare(IContextMenuAction o1, IContextMenuAction o2) {

            NumberFormat formater = NumberFormat.getInstance();

            formater.setMinimumIntegerDigits(3);

            String key1 =

                "" + formater.format(o1.getGroupOrder()) + o1.getGroup()

                    + formater.format(o1.getOrder());

            String key2 =

                "" + formater.format(o2.getGroupOrder()) + o2.getGroup()

                    + formater.format(o2.getOrder());

            return key1.compareTo(key2);

        }

    }    

}

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

import java.awt.Image;

import java.awt.Point;

import java.awt.Rectangle;

import java.awt.geom.AffineTransform;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

import javax.swing.JComponent;

import org.gvsig.app.project.documents.layout.geometryadapters.GeometryAdapter;

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

import org.gvsig.app.project.documents.layout.tools.behavior.LayoutBehavior;

import org.gvsig.fmap.dal.exception.ReadException;

import org.gvsig.tools.observer.Observer;

/**

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

 */

public interface LayoutControl extends Observer {

    /**

     * <p>Returns a copy of the rectangle that represents the size

     * and position of the layout sheet (in pixels), relative to

     * the containing LayoutControl.</p>

     * 

     * <p>Note: you must use {@link #setRect(Rectangle2D)} to update

     * the rectangle, as this method only returns a copy of it.</p>

     * @return Rectangle2D.Double Rectangle that represents the sheet.

     * @see LayoutControl#setRect(Rectangle2D)

     */

    public Rectangle2D.Double getRect();

    /**

     * <p>Sets the size and position of the layout sheet in screen coordinates

     * (pixels), relative to the LayoutControl.</p>

     * 

     * <p>The size of the sheet is usually different from the

     * bounds of the underlying UI control, for instance if we have zoomed in

     * an area of the sheet then the paper size in pixels will be bigger than

     * the actual control size.</p>

     * 

     */

    public void setRect(Rectangle2D r);

    /**

     * Returns the name of the current selected tool on this Layout

     * 

     * @return A tool name.

     */

    public String getCurrentTool();

    /**

     * Add a new Layout tool.

     * 

     * @param name

     *            Name of tool.

     * @param tool

     *            LayoutBehavior

     */

    public void addLayoutTool(String name, LayoutBehavior tool);

    /**

     * Inserts the LayoutContext.

     * 

     * @param lc

     *            LayoutContext.

     */

    public void setLayoutContext(LayoutContext lc);

    /**

     * Returns the image with the ruler.

     * 

     * @return Ruler image.

     */

    public BufferedImage getImgRuler();

    /**

     * It obtains the rect that is adjusted to the size of the window,

     * to see the full extent of layout.

     */

    public void fullRect();

    /**

     * Returns the current image of Layout.

     * 

     * @return Current image of Layout.

     */

    public BufferedImage getImage();

    /**

     * Changes the pointer of the mouse by the image of parameter.

     * 

     * @param image

     *            Image

     */

    public void setMapCursor(Image image);

    /**

     * It establishes as selected to the tool from its name of identification.

     * 

     * @param toolName

     *            Name of identification tool.

     */

    public void setTool(String toolName);

    /**

     * Changes the currently selected tool to the default tool

     */

    public void setDefaultTool();

    /**

     * Start the vertex edition of graphics.

     * 

     */

    public void startEdit();

    /**

     * Stop the vertex edition of graphics.

     * 

     */

    public void stopEdit();

    /**

     * It returns the point that represents the northwest corner of the Layout.

     * 

     * @return Point.

     */

    public Point getRectOrigin();

    /**

     * Returns the object to draw the Layout.

     * 

     * @return FLayoutDraw.

     */

    public FLayoutDraw getLayoutDraw();

    /**

     * Returns the current Layout tool.

     * 

     * @return LayoutBehavior Current Layout Tool.

     */

    public LayoutBehavior getCurrentLayoutTool();

    /**

     * It returns the first click point of mouse.

     * 

     * @return Point.

     */

    public Point getFirstPoint();

    /**

     * Returns the previous click of mouse.

     * 

     * @return Point.

     */

    public Point getPointAnt();

    /**

     * Returns the last click point of mouse.

     * 

     * @return Point.

     */

    public Point getLastPoint();

    /**

     * Inserts the first click point of mouse.

     * 

     * @param p

     *            Point.

     */

    public void setFirstPoint();

    /**

     * Inserts the previous click point of mouse.

     * 

     * @param p

     *            Point.

     */

    public void setPointAnt();

    /**

     * Inserts the last click point of mouse.

     * 

     * @param p

     *            Point.

     */

    public void setLastPoint();

    /**

     * Insert the position point and calculate the new position if the grid is

     * actived.

     * 

     * @param point2

     *            Position.

     */

    public void setPosition(Point point2);

    /**

     * Returns the position adjusted point.

     * 

     * @return

     */

    public Point getPosition();

    /**

     * Returns the AffineTransform that is applying in the Layout.

     * 

     * @return AffineTransform

     */

    public AffineTransform getAT();

    /**

     * It returns the current GeometryAdapter.

     * 

     * @return Current GeometryAdapter.

     */

    public GeometryAdapter getGeometryAdapter();

    /**

     * Remove last point of geometryAdapter.

     * 

     */

    public void delLastPoint();

    /**

     * Add a new point to geometryAdapter.

     * 

     * @return Number of points in the geometryAdapter.

     */

    public int addGeometryAdapterPoint();

    /**

     * Change the position of mousemoved point of geometryAdapter.

     */

    public void setGeometryAdapterPoinPosition();

    /**

     * Clear the image of pointer of mouse.

     */

    public void clearMouseImage();

    /**

     * Refres the Layout.

     */

    public void refresh();

    /**

     * It returns true if the drawing has been canceled.

     * 

     * @return true if the drawn has been canceled.

     */

    public boolean isDrawingCancelled();

    /**

     * It cancels the drawing if the parameter is true.

     * 

     * @param b

     *            true if the drawing wants to be canceled

     */

    public void setCancelDrawing(boolean b);

    /**

     * Returns the rectangle of selection.

     * 

     * @return Rectangle of selection.

     */

    public Rectangle getReSel();

    /**

     * It returns true if should draw the rectangle of selection and does the

     * selection.

     * 

     * @return true if should draw the rectangle of selection.

     */

    public boolean isReSel();

    /**

     * Insert true if should draw the rectangle of selection and does the

     * selection.

     * 

     * @param b

     *            boolean.

     */

    public void setIsReSel(boolean b);

    /**

     * It does a full extent of the layers that contains the view of the

     * FFrameView selected.

     * 

     * @throws ReadDriverException

     */

    public void viewFull() throws ReadException;

    /**

     * Returns the object to make zooms.

     * 

     * @return FLayoutZooms.

     */

    public FLayoutZooms getLayoutZooms();

    /**

     * Returns the object of FLayoutFunctions.

     * 

     * @return FLayoutFunctions

     */

    public FLayoutFunctions getLayoutFunctions();

    /**

     * Returns the LayoutContext.

     * 

     * @return LayoutContext.

     */

    public LayoutContext getLayoutContext();

    /**

     * Inserts the geometryAdapter.

     * 

     * @param adapter

     *            GeometryAdapter.

     */

    public void setGeometryAdapter(GeometryAdapter adapter);

    public JComponent getComponent();

    public int getWidth();

    public int getHeight();

    public void repaint();

}

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

import java.awt.Dimension;

import java.awt.Point;

import java.awt.geom.AffineTransform;

import java.awt.geom.NoninvertibleTransformException;

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import java.util.ArrayList;

import java.util.List;

import org.cresques.cts.IProjection;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

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

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

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

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

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

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.fmap.mapcontext.ViewPort;

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

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

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

/**

 * Clase que recoge m?todos est?ticos sobre el Layout.

 * 

 * @author Vicente Caballero Navarro

 */

public class FLayoutUtilities {

    private static Logger logger = LoggerFactory.getLogger(

        FLayoutUtilities.class);

    /**

     * Devuelve true si las dos ArrayList que se le pasan como parametro son

     * iguales.

     * 

     * @param n

     *            lista anterior

     * @param l

     *            lista actual

     * 

     * @return true si los ArrayList son iguales.

     */

    public static boolean isEqualList(ArrayList n, ArrayList l) {

        if (n.size() != l.size()) {

            return false;

        }

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

            if (l.get(i) != n.get(i)) {

                return false;

            }

        }

        return true;

    }

    /**

     * Pasa una distancia en pixels a unidades del folio.

     * 

     * @param d

     *            distancia en pixels.

     * @param at

     *            Matriz de transformaci?n.

     * 

     * @return distancia en unidades de folio.

     */

    public static double toSheetDistance(double d, AffineTransform at) {

        double dist = d / at.getScaleX(); // pProv.x;

        return dist;

    }

    /**

     * Pasa una distancia de coordenadas del folio a pixels.

     * 

     * @param d

     *            distancia en coordenadas de folio.

     * @param at

     *            Matriz de transformaci?n.

     * 

     * @return double en pixels.

     */

    public static double fromSheetDistance(double d, AffineTransform at) {

        Point2D.Double pSheet1 = new Point2D.Double(0, 0);

        Point2D.Double pSheet2 = new Point2D.Double(1, 0);

        Point2D.Double pScreen1 = new Point2D.Double();

        Point2D.Double pScreen2 = new Point2D.Double();

        try {

            at.transform(pSheet1, pScreen1);

            at.transform(pSheet2, pScreen2);

        } catch (Exception e) {

            System.err.print(e.getMessage());

        }

        return pScreen1.distance(pScreen2) * d;

    }

    /**

     * Pasa un punto en pixels a coordenadas del folio.

     * 

     * @param pScreen

     *            pixels.

     * @param at

     *            Matriz de transformaci?n.

     * 

     * @return Point2D en coordenadas de folio.

     */

    public static Point2D.Double toSheetPoint(Point2D pScreen,

        AffineTransform at) {

        Point2D.Double pWorld = new Point2D.Double();

        AffineTransform at1;

        try {

            at1 = at.createInverse();

            at1.transform(pScreen, pWorld);

        } catch (NoninvertibleTransformException e) {

        }

        return pWorld;

    }

    /**

     * Pasa un ret?ngulo de pixels a coordenadas del folio.

     * 

     * @param r

     *            rect?ngulo en coordenadas de pixels a coordenadas de folio.

     * @param at

     *            Matriz de transformaci?n.

     * 

     * @return Rectangle2D en coordenadas de folio.

     */

    public static Rectangle2D.Double toSheetRect(Rectangle2D r,

        AffineTransform at) {

        Point2D.Double pSheet =

            toSheetPoint(new Point2D.Double(r.getX(), r.getY()), at);

        Point2D.Double pSheetX =

            toSheetPoint(new Point2D.Double(r.getMaxX(), r.getMinY()), at);

        Point2D.Double pSheetY =

            toSheetPoint(new Point2D.Double(r.getMinX(), r.getMaxY()), at);

        Rectangle2D.Double res = new Rectangle2D.Double();

        res.setRect(pSheet.getX(), pSheet.getY(), pSheet.distance(pSheetX),

            pSheet.distance(pSheetY));

        return res;

    }

    /**

     * Pasa de un punto en coordenadas del folio a pixels.

     * 

     * @param pSheet

     *            punto en coordenadas de folio.

     * @param at

     *            Matriz de transformaci?n.

     * 

     * @return Point2D en pixels.

     */

    public static Point2D.Double fromSheetPoint(Point2D pSheet,

        AffineTransform at) {

        Point2D.Double pScreen = new Point2D.Double();

        try {

            at.transform(pSheet, pScreen);

        } catch (Exception e) {

            System.err.print(e.getMessage());

        }

        return pScreen;

    }

    /**

     * Pasa un rect?ngulo en coordenadas del folio a pixels.

     * 

     * @param r

     *            rect?ngulo en coordenadas de folio.

     * @param at

     *            Matriz de transformaci?n.

     * 

     * @return Rectangle2D en pixels.

     */

    public static Rectangle2D.Double fromSheetRect(Rectangle2D r,

        AffineTransform at) {

        Point2D.Double pSheet = new Point2D.Double(r.getX(), r.getY());

        Point2D.Double pSX = new Point2D.Double(r.getMaxX(), r.getMinY());

        Point2D.Double pSY = new Point2D.Double(r.getMinX(), r.getMaxY());

        Point2D.Double pScreen = new Point2D.Double();

        Point2D.Double pScreenX = new Point2D.Double();

        Point2D.Double pScreenY = new Point2D.Double();

        try {

            at.transform(pSheet, pScreen);

            at.transform(pSX, pScreenX);

            at.transform(pSY, pScreenY);

        } catch (Exception e) {

            System.err.print(e.getMessage());

        }

        Rectangle2D.Double res = new Rectangle2D.Double();

        res.setRect(pScreen.getX(), pScreen.getY(), pScreen.distance(pScreenX),

            pScreen.distance(pScreenY));

        return res;

    }

    /**

     * Obtiene el punto ajustado al grid del layout.

     * 

     * @param p

     *            Punto a ajustar.

     * @param distX

     *            Distancia m?nima en cm de X.

     * @param distY

     *            Distancia m?nima en cm de Y.

     * @param at

     *            Matriz de transformaci?n.

     */

    public static Point getPointGrid(Point p, double distX, double distY,

        AffineTransform at) {

        if (distX * at.getScaleX() < 2 && distY * at.getScaleY() < 2) {

            /*

             * In this case, it makes no sense to care about snapping

             * because snapping would mean to move the position by one pixel

             */

            return p;

        }

        Point2D.Double auxp =

            FLayoutUtilities.fromSheetPoint(new Point2D.Double(0, 0), at);

        double gridintx = distX * at.getScaleX();

        double gridinty = distY * at.getScaleY();

        double seppx = p.x - Math.round(auxp.x);

        double seppy = p.y - Math.round(auxp.y);

        long round_int_p_x = Math.round(seppx / gridintx);

        long round_int_p_y = Math.round(seppy / gridinty);

        // Rounded

        seppx = round_int_p_x * gridintx;

        seppy = round_int_p_y * gridinty;

        return new Point(

            (int) (auxp.x + seppx),

            (int) (auxp.y + seppy));

    }

    /**

     * Cuando se dibuja sobre el graphics todo se tiene que situar en enteros y

     * aqu? lo que se comprueba es que si los valores que contiene el

     * Rectangle2D, que toma como par?metro, supera los valores soportados por

     * un entero.

     * 

     * @param r

     *            Rectangle2D a comprobar si los valores que contiene no superan

     *            a los que puede tener un entero.

     * 

     * @return true si no se han superado los l?mites.

     */

    public static boolean isPosible(Rectangle2D.Double r) {

        if ((r.getMaxX() > Integer.MAX_VALUE)

            || (r.getMaxY() > Integer.MAX_VALUE)

            || (r.getMinX() < Integer.MIN_VALUE)

            || (r.getMinY() < Integer.MIN_VALUE)

            || (r.getWidth() > Integer.MAX_VALUE)

            || (r.getHeight() > Integer.MAX_VALUE)) {

            return false;

        }

        return true;

    }

    public static List<Document> removeEditing(List<Document> list) {

        List<Document> resp = new ArrayList<Document>();

        Document item = null;

        ViewDocument viewdoc = null;

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

            item = list.get(i);

            if (item instanceof ViewDocument) {

                viewdoc = (ViewDocument) item;

                if (!hasEditingLayers(viewdoc)) {

                    resp.add(item);

                }

            }

        }

        return resp;

    }

    public static boolean hasEditingLayers(ViewDocument viewdoc) {

        return hasEditingLayers(viewdoc.getMapContext().getLayers());

    }

    /**

     * Recursively find out if any layer is in editing mode

     * 

     * @param lyrs

     * @return

     */

    public static boolean hasEditingLayers(FLayers lyrs) {

        int len = lyrs.getLayersCount();

        FLayer lyr = null;

        FLyrVect vlyr = null;

        for (int i=0; i<len; i++) {

            lyr = lyrs.getLayer(i);

            if (lyr instanceof FLyrVect) {

                vlyr = (FLyrVect) lyr;

                if (vlyr.isEditing()) {

                    return true;

                }

            } else {

                if (lyr instanceof FLayers) {

                    if (hasEditingLayers((FLayers) lyr)) {

                        return true;

                    }

                }

            }