/trunk/org.gvsig.app.document.layout2.app/org.gvsig.app.document.layout2.app.mainplugin/src/main/java/org/gvsig/app/project/documents/layout/LayoutControl.java - Annotate - gvSIG Document Layout - gvSIG

svn-document-layout / trunk / org.gvsig.app.document.layout2.app / org.gvsig.app.document.layout2.app.mainplugin / src / main / java / org / gvsig / app / project / documents / layout / LayoutControl.java @ 1744

History | View | Annotate | Download (8.43 KB)

-            jldominguez
+/* 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;
-            cmartinez
+import org.gvsig.app.project.documents.layout.gui.LayoutPanel;
-            jldominguez
+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 {
     /**
-            cmartinez
+     * <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>
             jldominguez
-            cmartinez
+     * <p>Note: you must use {@link #setRect(Rectangle2D)} to update
      * the rectangle, as this method only returns a copy of it.</p>
-            jldominguez
+     * @return Rectangle2D.Double Rectangle that represents the sheet.
-            cmartinez
+     * @see LayoutControl#setRect(Rectangle2D)
-            jldominguez
+     */
     public Rectangle2D.Double getRect();
     /**
-            cmartinez
+     * <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);
     /**
-            jldominguez
+     * 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);
             cmartinez
     /**
      * Changes the currently selected tool to the default tool
      */
     public void setDefaultTool();
             jldominguez
     /**
      * 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();
+}

Application: gvSIG desktop » gvSIG Document Layout

svn-document-layout / trunk / org.gvsig.app.document.layout2.app / org.gvsig.app.document.layout2.app.mainplugin / src / main / java / org / gvsig / app / project / documents / layout / LayoutControl.java @ 1744