LayoutControl

All Superinterfaces:

Observer

All Known Implementing Classes:

DefaultLayoutControl
```
public interface LayoutControl
extends Observer
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`addGeometryAdapterPoint()` Add a new point to geometryAdapter.
`void`	`addLayoutTool(java.lang.String name, LayoutBehavior tool)` Add a new Layout tool.
`void`	`clearMouseImage()` Clear the image of pointer of mouse.
`void`	`delLastPoint()` Remove last point of geometryAdapter.
`void`	`fullRect()` It obtains the rect that is adjusted to the size of the window, to see the full extent of layout.
`java.awt.geom.AffineTransform`	`getAT()` Returns the AffineTransform that is applying in the Layout.
`javax.swing.JComponent`	`getComponent()`
`LayoutBehavior`	`getCurrentLayoutTool()` Returns the current Layout tool.
`java.lang.String`	`getCurrentTool()` Returns the name of the current selected tool on this Layout
`java.awt.Point`	`getFirstPoint()` It returns the first click point of mouse.
`GeometryAdapter`	`getGeometryAdapter()` It returns the current GeometryAdapter.
`int`	`getHeight()`
`java.awt.image.BufferedImage`	`getImage()` Returns the current image of Layout.
`java.awt.image.BufferedImage`	`getImgRuler()` Returns the image with the ruler.
`java.awt.Point`	`getLastPoint()` Returns the last click point of mouse.
`LayoutContext`	`getLayoutContext()` Returns the LayoutContext.
`FLayoutDraw`	`getLayoutDraw()` Returns the object to draw the Layout.
`FLayoutFunctions`	`getLayoutFunctions()` Returns the object of FLayoutFunctions.
`LayoutBehavior`	`getLayoutTool(java.lang.String name)`
`FLayoutZooms`	`getLayoutZooms()` Returns the object to make zooms.
`java.awt.Point`	`getPointAnt()` Returns the previous click of mouse.
`java.awt.Point`	`getPosition()` Returns the position adjusted point.
`java.awt.geom.Rectangle2D.Double`	`getRect()` Returns a copy of the rectangle that represents the size and position of the layout sheet (in pixels), relative to the containing LayoutControl.
`java.awt.Point`	`getRectOrigin()` It returns the point that represents the northwest corner of the Layout.
`java.awt.Rectangle`	`getReSel()` Returns the rectangle of selection.
`int`	`getWidth()`
`boolean`	`isDrawingCancelled()` It returns true if the drawing has been canceled.
`boolean`	`isReSel()` It returns true if should draw the rectangle of selection and does the selection.
`void`	`refresh()` Refres the Layout.
`void`	`repaint()`
`void`	`setCancelDrawing(boolean b)` It cancels the drawing if the parameter is true.
`void`	`setDefaultTool()` Changes the currently selected tool to the default tool
`void`	`setFirstPoint()` Inserts the first click point of mouse.
`void`	`setGeometryAdapter(GeometryAdapter adapter)` Inserts the geometryAdapter.
`void`	`setGeometryAdapterPoinPosition()` Change the position of mousemoved point of geometryAdapter.
`void`	`setIsReSel(boolean b)` Insert true if should draw the rectangle of selection and does the selection.
`void`	`setLastPoint()` Inserts the last click point of mouse.
`void`	`setLayoutContext(LayoutContext lc)` Inserts the LayoutContext.
`void`	`setMapCursor(java.awt.Image image)` Changes the pointer of the mouse by the image of parameter.
`void`	`setPointAnt()` Inserts the previous click point of mouse.
`void`	`setPosition(java.awt.Point point2)` Insert the position point and calculate the new position if the grid is actived.
`void`	`setRect(java.awt.geom.Rectangle2D r)` Sets the size and position of the layout sheet in screen coordinates (pixels), relative to the LayoutControl.
`void`	`setTool(java.lang.String toolName)` It establishes as selected to the tool from its name of identification.
`void`	`startEdit()` Start the vertex edition of graphics.
`void`	`stopEdit()` Stop the vertex edition of graphics.
`void`	`viewFull()` It does a full extent of the layers that contains the view of the FFrameView selected.

Methods inherited from interface org.gvsig.tools.observer.Observer
update

- Method Detail
  - getRect
```
java.awt.geom.Rectangle2D.Double getRect()
```
    Returns a copy of the rectangle that represents the size and position of the layout sheet (in pixels), relative to the containing LayoutControl.
    
    Note: you must use setRect(Rectangle2D) to update the rectangle, as this method only returns a copy of it.
    
    Returns:
    
    Rectangle2D.Double Rectangle that represents the sheet.
    
    See Also:
    
    setRect(Rectangle2D)
  - setRect
```
void setRect(java.awt.geom.Rectangle2D r)
```
    Sets the size and position of the layout sheet in screen coordinates (pixels), relative to the LayoutControl.
    
    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.
  - getCurrentTool
```
java.lang.String getCurrentTool()
```
    Returns the name of the current selected tool on this Layout
    
    Returns:
    
    A tool name.
  - addLayoutTool
```
void addLayoutTool(java.lang.String name,
                   LayoutBehavior tool)
```
    Add a new Layout tool.
    
    Parameters:
    
    name - Name of tool.
    
    tool - LayoutBehavior
  - getLayoutTool
```
LayoutBehavior getLayoutTool(java.lang.String name)
```
  - setLayoutContext
```
void setLayoutContext(LayoutContext lc)
```
    Inserts the LayoutContext.
    
    Parameters:
    
    lc - LayoutContext.
  - getImgRuler
```
java.awt.image.BufferedImage getImgRuler()
```
    Returns the image with the ruler.
    
    Returns:
    
    Ruler image.
  - fullRect
```
void fullRect()
```
    It obtains the rect that is adjusted to the size of the window, to see the full extent of layout.
  - getImage
```
java.awt.image.BufferedImage getImage()
```
    Returns the current image of Layout.
    
    Returns:
    
    Current image of Layout.
  - setMapCursor
```
void setMapCursor(java.awt.Image image)
```
    Changes the pointer of the mouse by the image of parameter.
    
    Parameters:
    
    image - Image
  - setTool
```
void setTool(java.lang.String toolName)
```
    It establishes as selected to the tool from its name of identification.
    
    Parameters:
    
    toolName - Name of identification tool.
  - setDefaultTool
```
void setDefaultTool()
```
    Changes the currently selected tool to the default tool
  - startEdit
```
void startEdit()
```
    Start the vertex edition of graphics.
  - stopEdit
```
void stopEdit()
```
    Stop the vertex edition of graphics.
  - getRectOrigin
```
java.awt.Point getRectOrigin()
```
    It returns the point that represents the northwest corner of the Layout.
    
    Returns:
    
    Point.
  - getLayoutDraw
```
FLayoutDraw getLayoutDraw()
```
    Returns the object to draw the Layout.
    
    Returns:
    
    FLayoutDraw.
  - getCurrentLayoutTool
```
LayoutBehavior getCurrentLayoutTool()
```
    Returns the current Layout tool.
    
    Returns:
    
    LayoutBehavior Current Layout Tool.
  - getFirstPoint
```
java.awt.Point getFirstPoint()
```
    It returns the first click point of mouse.
    
    Returns:
    
    Point.
  - getPointAnt
```
java.awt.Point getPointAnt()
```
    Returns the previous click of mouse.
    
    Returns:
    
    Point.
  - getLastPoint
```
java.awt.Point getLastPoint()
```
    Returns the last click point of mouse.
    
    Returns:
    
    Point.
  - setFirstPoint
```
void setFirstPoint()
```
    Inserts the first click point of mouse.
    
    Parameters:
    
    p - Point.
  - setPointAnt
```
void setPointAnt()
```
    Inserts the previous click point of mouse.
    
    Parameters:
    
    p - Point.
  - setLastPoint
```
void setLastPoint()
```
    Inserts the last click point of mouse.
    
    Parameters:
    
    p - Point.
  - setPosition
```
void setPosition(java.awt.Point point2)
```
    Insert the position point and calculate the new position if the grid is actived.
    
    Parameters:
    
    point2 - Position.
  - getPosition
```
java.awt.Point getPosition()
```
    Returns the position adjusted point.
    
    Returns:
  - getAT
```
java.awt.geom.AffineTransform getAT()
```
    Returns the AffineTransform that is applying in the Layout.
    
    Returns:
    
    AffineTransform
  - getGeometryAdapter
```
GeometryAdapter getGeometryAdapter()
```
    It returns the current GeometryAdapter.
    
    Returns:
    
    Current GeometryAdapter.
  - delLastPoint
```
void delLastPoint()
```
    Remove last point of geometryAdapter.
  - addGeometryAdapterPoint
```
int addGeometryAdapterPoint()
```
    Add a new point to geometryAdapter.
    
    Returns:
    
    Number of points in the geometryAdapter.
  - setGeometryAdapterPoinPosition
```
void setGeometryAdapterPoinPosition()
```
    Change the position of mousemoved point of geometryAdapter.
  - clearMouseImage
```
void clearMouseImage()
```
    Clear the image of pointer of mouse.
  - refresh
```
void refresh()
```
    Refres the Layout.
  - isDrawingCancelled
```
boolean isDrawingCancelled()
```
    It returns true if the drawing has been canceled.
    
    Returns:
    
    true if the drawn has been canceled.
  - setCancelDrawing
```
void setCancelDrawing(boolean b)
```
    It cancels the drawing if the parameter is true.
    
    Parameters:
    
    b - true if the drawing wants to be canceled
  - getReSel
```
java.awt.Rectangle getReSel()
```
    Returns the rectangle of selection.
    
    Returns:
    
    Rectangle of selection.
  - isReSel
```
boolean isReSel()
```
    It returns true if should draw the rectangle of selection and does the selection.
    
    Returns:
    
    true if should draw the rectangle of selection.
  - setIsReSel
```
void setIsReSel(boolean b)
```
    Insert true if should draw the rectangle of selection and does the selection.
    
    Parameters:
    
    b - boolean.
  - viewFull
```
void viewFull()
       throws ReadException
```
    It does a full extent of the layers that contains the view of the FFrameView selected.
    
    Throws:
    
    ReadDriverException
    
    ReadException
  - getLayoutZooms
```
FLayoutZooms getLayoutZooms()
```
    Returns the object to make zooms.
    
    Returns:
    
    FLayoutZooms.
  - getLayoutFunctions
```
FLayoutFunctions getLayoutFunctions()
```
    Returns the object of FLayoutFunctions.
    
    Returns:
    
    FLayoutFunctions
  - getLayoutContext
```
LayoutContext getLayoutContext()
```
    Returns the LayoutContext.
    
    Returns:
    
    LayoutContext.
  - setGeometryAdapter
```
void setGeometryAdapter(GeometryAdapter adapter)
```
    Inserts the geometryAdapter.
    
    Parameters:
    
    adapter - GeometryAdapter.
  - getComponent
```
javax.swing.JComponent getComponent()
```
  - getWidth
```
int getWidth()
```
  - getHeight
```
int getHeight()
```
  - repaint
```
void repaint()
```

Interface LayoutControl

Method Summary

Methods inherited from interface org.gvsig.tools.observer.Observer

Method Detail

getRect

setRect

getCurrentTool

addLayoutTool

getLayoutTool

setLayoutContext

getImgRuler

fullRect

getImage

setMapCursor

setTool

setDefaultTool

startEdit

stopEdit

getRectOrigin

getLayoutDraw

getCurrentLayoutTool

getFirstPoint

getPointAnt

getLastPoint

setFirstPoint

setPointAnt

setLastPoint

setPosition

getPosition

getAT

getGeometryAdapter

delLastPoint

addGeometryAdapterPoint

setGeometryAdapterPoinPosition

clearMouseImage

refresh

isDrawingCancelled

setCancelDrawing

getReSel

isReSel

setIsReSel

viewFull

getLayoutZooms

getLayoutFunctions

getLayoutContext

setGeometryAdapter

getComponent

getWidth

getHeight

repaint