FFrameGrid

java.lang.Object
- org.gvsig.app.project.documents.layout.fframes.FFrame
- - org.gvsig.app.project.documents.layout.fframes.AbstractFFrameViewDependence
  - - org.gvsig.app.project.documents.layout.fframes.FFrameGrid

All Implemented Interfaces:

java.lang.Cloneable, IFFrame, IFFrameViewDependence, IPrintable, Disposable, Observable, Persistent
```
public class FFrameGrid
extends AbstractFFrameViewDependence
implements IFFrameViewDependence
```
FFrame para introducir una cuadrícula sobre una vista en el Layout.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FIXED_DISTANCE_MODE` Use a fixed distance (intervalX and intervalY) to calculate the position of grid lines
`static int`	`NUM_DIVISIONS_HORIZ_MODE` Use a specific number of horizontal divisions in order to calculate the position of grid lines
`static int`	`NUM_DIVISIONS_VERT_MODE` Use a specific number of vertical divisions in order to calculate the position of grid lines
`static java.lang.String`	`PERSISTENCE_DEFINITION_NAME`

Fields inherited from class org.gvsig.app.project.documents.layout.fframes.AbstractFFrameViewDependence
fframeViewDependence

Fields inherited from class org.gvsig.app.project.documents.layout.fframes.FFrame
e, frameFactory, iEResize, iNResize, lastAT, layoutManager, LOG, m_BoundBox, m_Selected, n, ne, no, num, o, observers, s, se, so

Fields inherited from interface org.gvsig.app.project.documents.layout.fframes.IFFrame
E, N, NE, NO, NOSELECT, O, RECT, S, SE, SO

Constructor Summary

Constructors
Constructor and Description

FFrameGrid()

Constructors
Constructor and Description
`FFrameGrid()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, java.awt.geom.Rectangle2D rv, java.awt.image.BufferedImage imgBase)` Draws the FFrame on the provided Graphics, according to the provided affine transform and the visible rectangle.
`void`	`drawHandlers(java.awt.Graphics2D g)` Dibuja los handlers sobre el boundingBox en el graphics que se pasa como parďż˝metro.
`java.awt.geom.Rectangle2D.Double`	`getBoundingBox(java.awt.geom.AffineTransform at)` Returns the bounding box (in pixels) of this FFrame, based on the provided AffineTransform.
`java.awt.Font`	`getFont()`
`java.awt.Color`	`getFontColor()`
`int`	`getFontSize()`
`double`	`getHorizLabelRotation()` Gets the rotation of the labels corresponding to horizontal lines
`double`	`getIntervalX()`
`double`	`getIntervalY()`
`int`	`getLabelAnchor()` Defines the alignment of the grid label compared with the associated grid tick
`FFrameGridCoordinateFormat`	`getLabelFormat()`
`java.awt.geom.Rectangle2D`	`getLastMoveRect()` Devuelve el rectďż˝ngulo que representa el ďż˝ltimo generado al desplazar o modificar el tamaďż˝o del fframe.
`java.awt.geom.Rectangle2D`	`getMovieRect(int difx, int dify)` Devuelve el rectďż˝ngulo a partir del desplazamiento en el eje x y el desplazamiento en el eje y.
`java.awt.geom.Rectangle2D`	`getMovieRect(int difx, int dify, boolean prop)` Devuelve el rectángulo a partir del desplazamiento en el eje x y el desplazamiento en el eje y.
`java.lang.String`	`getName()` Devuelve el nombre que representa al fframe.
`java.lang.String`	`getNameFFrame()` Devuelve el nombre que representa al tipo de FFrame.
`int`	`getNumDivisionsHoriz()`
`int`	`getNumDivisionsVert()`
`int`	`getSizeFont()`
`ISymbol`	`getSymbolLine()`
`ISymbol`	`getSymbolPoint()`
`int`	`getUseNumDivisions()` Returns true if a number of divisions is used to calculate the location of grid lines, or false if a distance (intervalX and intervalY) is used to calculate them.
`double`	`getVertLabelRotation()` Gets the rotation of the labels corresponding to vertical lines
`boolean`	`isLine()`
`void`	`loadFromState(PersistentState state)` Set the state of the object from the state passed as parameter.
`void`	`print(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, Geometry shape, PrintAttributes properties)`
`void`	`refreshDependence(IFFrame fant, IFFrame fnew)` Refresca las dependencias de la IFFrame teniendo en cuenta la dependencia anterior.
`static void`	`registerPersistent()`
`void`	`saveToState(PersistentState state)` Saves the internal state of the object on the provided PersistentState object.
`void`	`setFFrameDependence(IFFrame f)` Inserta una FFrame de la cual se necesita por tener una dependencia.
`void`	`setFont(java.awt.Font m_font)`
`void`	`setHorizLabelRotation(double labelRotation)` Sets the rotation of the labels corresponding to horizontal lines
`void`	`setIntervalX(double d)`
`void`	`setIntervalY(double d)`
`void`	`setIsLine(boolean b)`
`void`	`setLabelAnchor(int anchor)` Gets the alignment of the grid labels.
`void`	`setLabelFormat(FFrameGridCoordinateFormat f)`
`void`	`setNumDivisionsHoriz(int nx)`
`void`	`setNumDivisionsVert(int ny)`
`void`	`setSizeFont(int sizeFont)`
`void`	`setSymbolLine(ISymbol symbolLine)`
`void`	`setSymbolPoint(ISymbol symbolPoint)`
`void`	`setTextColor(java.awt.Color textcolor)`
`void`	`setUseNumDivisions(int mode)` Defines whether a number of divisions is used to calculate the location of grid lines, or a distance (intervalX and intervalY) is used to calculate them.
`void`	`setVertLabelRotation(double labelRotation)` Sets the rotation of the labels corresponding to vertical lines
`protected void`	`updateIntervals()`
`protected void`	`updateIntervals(Envelope env)`

Methods inherited from class org.gvsig.app.project.documents.layout.fframes.AbstractFFrameViewDependence
clone, getFFrameDependence

Methods inherited from class org.gvsig.app.project.documents.layout.fframes.FFrame
addObserver, contains, deleteObserver, deleteObservers, dispose, doSetSelected, drawDraft, drawEmpty, drawSymbolTag, frameAdded, frameRemoved, getBoundBox, getContains, getDocument, getFrameFactory, getLayoutContext, getLevel, getMapCursor, getRotation, getRotationAT, getSelected, getTag, getVisibleRect, initializeIcons, intersects, isSelected, setBoundBox, setDocument, setFrameFactory, setLayoutContext, setLevel, setNum, setRotation, setSelected, setSelected, setTag, updateRect

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.app.project.documents.layout.fframes.IFFrameViewDependence
getFFrameDependence

Methods inherited from interface org.gvsig.tools.lang.Cloneable
cloneQuietly, cloneQuietly

- Field Detail
  - PERSISTENCE_DEFINITION_NAME
```
public static final java.lang.String PERSISTENCE_DEFINITION_NAME
```
    See Also:
    
    Constant Field Values
  - FIXED_DISTANCE_MODE
```
public static final int FIXED_DISTANCE_MODE
```
    Use a fixed distance (intervalX and intervalY) to calculate the position of grid lines
    
    See Also:
    
    Constant Field Values
  - NUM_DIVISIONS_HORIZ_MODE
```
public static final int NUM_DIVISIONS_HORIZ_MODE
```
    Use a specific number of horizontal divisions in order to calculate the position of grid lines
    
    See Also:
    
    Constant Field Values
  - NUM_DIVISIONS_VERT_MODE
```
public static final int NUM_DIVISIONS_VERT_MODE
```
    Use a specific number of vertical divisions in order to calculate the position of grid lines
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FFrameGrid
```
public FFrameGrid()
```
- Method Detail
  - draw
```
public void draw(java.awt.Graphics2D g,
                 java.awt.geom.AffineTransform at,
                 java.awt.geom.Rectangle2D rv,
                 java.awt.image.BufferedImage imgBase)
```
    Description copied from class: FFrame
    
    Draws the FFrame on the provided Graphics, according to the provided affine transform and the visible rectangle. It has to to be implemented by each FFrame, as each of them usually draws diffently.
    
    Specified by:
    
    draw in interface IFFrame
    
    Specified by:
    
    draw in class FFrame
    
    Parameters:
    
    g - Graphics2D
    
    at - Affine transform to translate sheet coordinates (in cm) to screen coordinates (in pixels)
    
    rv - rectángulo sobre el que hacer un clip.
    
    imgBase - Image used to speed up the drawing process
  - getNameFFrame
```
public java.lang.String getNameFFrame()
```
    Description copied from interface: IFFrame
    
    Devuelve el nombre que representa al tipo de FFrame.
    
    Specified by:
    
    getNameFFrame in interface IFFrame
    
    Returns:
    
    nombre del elemento.
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: IFFrame
    
    Devuelve el nombre que representa al fframe.
    
    Specified by:
    
    getName in interface IFFrame
    
    Returns:
    
    String nombre del FFrame.
  - setFFrameDependence
```
public void setFFrameDependence(IFFrame f)
```
    Description copied from interface: IFFrameViewDependence
    
    Inserta una FFrame de la cual se necesita por tener una dependencia.
    
    Specified by:
    
    setFFrameDependence in interface IFFrameViewDependence
    
    Overrides:
    
    setFFrameDependence in class AbstractFFrameViewDependence
    
    Parameters:
    
    f - FFrame de la que se depende.
  - setIntervalX
```
public void setIntervalX(double d)
```
  - setIntervalY
```
public void setIntervalY(double d)
```
  - getIntervalX
```
public double getIntervalX()
```
  - getIntervalY
```
public double getIntervalY()
```
  - setTextColor
```
public void setTextColor(java.awt.Color textcolor)
```
  - setIsLine
```
public void setIsLine(boolean b)
```
  - isLine
```
public boolean isLine()
```
  - getFontColor
```
public java.awt.Color getFontColor()
```
  - getSizeFont
```
public int getSizeFont()
```
  - setSizeFont
```
public void setSizeFont(int sizeFont)
```
  - getBoundingBox
```
public java.awt.geom.Rectangle2D.Double getBoundingBox(java.awt.geom.AffineTransform at)
```
    Description copied from class: FFrame
    
    Returns the bounding box (in pixels) of this FFrame, based on the provided AffineTransform. If the AffineTransform is null, it returns the last calculated bounding box.
    
    Specified by:
    
    getBoundingBox in interface IFFrame
    
    Overrides:
    
    getBoundingBox in class FFrame
    
    Parameters:
    
    at - Affine transform to apply to the sheet coordinates to get the bounding box in pixels.
    
    Returns:
    
    Rectangle representing the bounding box (in pixels) of this FFrame
  - getMovieRect
```
public java.awt.geom.Rectangle2D getMovieRect(int difx,
                                              int dify)
```
    Description copied from class: FFrame
    
    Devuelve el rectďż˝ngulo a partir del desplazamiento en el eje x y el desplazamiento en el eje y.
    
    Specified by:
    
    getMovieRect in interface IFFrame
    
    Overrides:
    
    getMovieRect in class FFrame
    
    Parameters:
    
    difx - desplazamiento sobre el eje x.
    
    dify - desplazamiento sobre el eje y.
    
    Returns:
    
    rectďż˝ngulo modificado en funciďż˝n del desplazamiento realizado.
  - getMovieRect
```
public java.awt.geom.Rectangle2D getMovieRect(int difx,
                                              int dify,
                                              boolean prop)
```
    Description copied from interface: IFFrame
    
    Devuelve el rectángulo a partir del desplazamiento en el eje x y el desplazamiento en el eje y.
    
    Specified by:
    
    getMovieRect in interface IFFrame
    
    Overrides:
    
    getMovieRect in class FFrame
    
    Parameters:
    
    difx - desplazamiento sobre el eje x.
    
    dify - desplazamiento sobre el eje y.
    
    prop - true para un desplazamiento proporcional
    
    Returns:
    
    rectángulo modificado en función del desplazamiento realizado.
  - refreshDependence
```
public void refreshDependence(IFFrame fant,
                              IFFrame fnew)
```
    Description copied from interface: IFFrameViewDependence
    
    Refresca las dependencias de la IFFrame teniendo en cuenta la dependencia anterior.
    
    Specified by:
    
    refreshDependence in interface IFFrameViewDependence
    
    Overrides:
    
    refreshDependence in class AbstractFFrameViewDependence
    
    Parameters:
    
    fant - Dependencia anterior.
    
    fnew - Nueva dependencia.
  - drawHandlers
```
public void drawHandlers(java.awt.Graphics2D g)
```
    Description copied from class: FFrame
    
    Dibuja los handlers sobre el boundingBox en el graphics que se pasa como parďż˝metro.
    
    Specified by:
    
    drawHandlers in interface IFFrame
    
    Overrides:
    
    drawHandlers in class FFrame
    
    Parameters:
    
    g - Graphics sobre el que dibujar.
  - getLastMoveRect
```
public java.awt.geom.Rectangle2D getLastMoveRect()
```
    Description copied from class: FFrame
    
    Devuelve el rectďż˝ngulo que representa el ďż˝ltimo generado al desplazar o modificar el tamaďż˝o del fframe.
    
    Specified by:
    
    getLastMoveRect in interface IFFrame
    
    Overrides:
    
    getLastMoveRect in class FFrame
    
    Returns:
    
    Rectangle2D
  - getSymbolLine
```
public ISymbol getSymbolLine()
```
  - setSymbolLine
```
public void setSymbolLine(ISymbol symbolLine)
```
  - getSymbolPoint
```
public ISymbol getSymbolPoint()
```
  - setSymbolPoint
```
public void setSymbolPoint(ISymbol symbolPoint)
```
  - getFont
```
public java.awt.Font getFont()
```
  - setFont
```
public void setFont(java.awt.Font m_font)
```
  - getFontSize
```
public int getFontSize()
```
  - setUseNumDivisions
```
public void setUseNumDivisions(int mode)
```
    Defines whether a number of divisions is used to calculate the location of grid lines, or a distance (intervalX and intervalY) is used to calculate them.
    
    Parameters:
    
    useNumDivisions - One of FIXED_DISTANCE_MODE, NUM_DIVISIONS_HORIZ_MODE or NUM_DIVISIONS_HORIZ_MODE.
  - updateIntervals
```
protected void updateIntervals()
```
  - updateIntervals
```
protected void updateIntervals(Envelope env)
```
  - getUseNumDivisions
```
public int getUseNumDivisions()
```
    Returns true if a number of divisions is used to calculate the location of grid lines, or false if a distance (intervalX and intervalY) is used to calculate them.
    
    Returns:
    
    One of FIXED_DISTANCE_MODE, NUM_DIVISIONS_HORIZ_MODE or NUM_DIVISIONS_VERT_MODE.
  - setNumDivisionsHoriz
```
public void setNumDivisionsHoriz(int nx)
```
  - setNumDivisionsVert
```
public void setNumDivisionsVert(int ny)
```
  - getNumDivisionsHoriz
```
public int getNumDivisionsHoriz()
```
  - getNumDivisionsVert
```
public int getNumDivisionsVert()
```
  - setLabelFormat
```
public void setLabelFormat(FFrameGridCoordinateFormat f)
```
  - getLabelFormat
```
public FFrameGridCoordinateFormat getLabelFormat()
```
  - setHorizLabelRotation
```
public void setHorizLabelRotation(double labelRotation)
```
    Sets the rotation of the labels corresponding to horizontal lines
    
    Parameters:
    
    labelRotation - Label rotation, measured in arc degrees
  - setVertLabelRotation
```
public void setVertLabelRotation(double labelRotation)
```
    Sets the rotation of the labels corresponding to vertical lines
    
    Parameters:
    
    labelRotation - Label rotation, measured in arc degrees
  - getHorizLabelRotation
```
public double getHorizLabelRotation()
```
    Gets the rotation of the labels corresponding to horizontal lines
    
    Parameters:
    
    labelRotation - Label rotation, measured in arc degrees
  - getLabelAnchor
```
public int getLabelAnchor()
```
    Defines the alignment of the grid label compared with the associated grid tick
    
    Parameters:
    
    anchor - RotatedTextUtils.ANCHOR_CORNER or RotatedTextUtils.ANCHOR_CENTER
  - setLabelAnchor
```
public void setLabelAnchor(int anchor)
```
    Gets the alignment of the grid labels. ANCHOR_CORNER aligns the corner of the label with the grid tick, while ANCHOR_CENTER aligns the label center with the grid tick.
    
    Parameters:
    
    anchor - RotatedTextUtils.ANCHOR_CORNER or RotatedTextUtils.ANCHOR_CENTER
  - getVertLabelRotation
```
public double getVertLabelRotation()
```
    Gets the rotation of the labels corresponding to vertical lines
    
    Parameters:
    
    labelRotation - Label rotation, measured in arc degrees
  - print
```
public void print(java.awt.Graphics2D g,
                  java.awt.geom.AffineTransform at,
                  Geometry shape,
                  PrintAttributes properties)
```
    Specified by:
    
    print in interface IPrintable
  - registerPersistent
```
public static void registerPersistent()
```
  - loadFromState
```
public void loadFromState(PersistentState state)
                   throws PersistenceException
```
    Description copied from interface: Persistent
    
    Set the state of the object from the state passed as parameter.
    
    Specified by:
    
    loadFromState in interface Persistent
    
    Overrides:
    
    loadFromState in class AbstractFFrameViewDependence
    
    Throws:
    
    PersistenceException
  - saveToState
```
public void saveToState(PersistentState state)
                 throws PersistenceException
```
    Description copied from interface: Persistent
    
    Saves the internal state of the object on the provided PersistentState object.
    
    Specified by:
    
    saveToState in interface Persistent
    
    Overrides:
    
    saveToState in class AbstractFFrameViewDependence
    
    Throws:
    
    PersistenceException

Class FFrameGrid

Field Summary

Fields inherited from class org.gvsig.app.project.documents.layout.fframes.AbstractFFrameViewDependence

Fields inherited from class org.gvsig.app.project.documents.layout.fframes.FFrame

Fields inherited from interface org.gvsig.app.project.documents.layout.fframes.IFFrame

Constructor Summary

Method Summary

Methods inherited from class org.gvsig.app.project.documents.layout.fframes.AbstractFFrameViewDependence

Methods inherited from class org.gvsig.app.project.documents.layout.fframes.FFrame

Methods inherited from class java.lang.Object

Methods inherited from interface org.gvsig.app.project.documents.layout.fframes.IFFrameViewDependence

Methods inherited from interface org.gvsig.tools.lang.Cloneable

Field Detail

PERSISTENCE_DEFINITION_NAME

FIXED_DISTANCE_MODE

NUM_DIVISIONS_HORIZ_MODE

NUM_DIVISIONS_VERT_MODE

Constructor Detail

FFrameGrid

Method Detail

draw

getNameFFrame

getName

setFFrameDependence

setIntervalX

setIntervalY

getIntervalX

getIntervalY

setTextColor

setIsLine

isLine

getFontColor

getSizeFont

setSizeFont

getBoundingBox

getMovieRect

getMovieRect

refreshDependence

drawHandlers

getLastMoveRect

getSymbolLine

setSymbolLine

getSymbolPoint

setSymbolPoint

getFont

setFont

getFontSize

setUseNumDivisions

updateIntervals

updateIntervals

getUseNumDivisions

setNumDivisionsHoriz

setNumDivisionsVert

getNumDivisionsHoriz

getNumDivisionsVert

setLabelFormat

getLabelFormat

setHorizLabelRotation

setVertLabelRotation

getHorizLabelRotation

getLabelAnchor

setLabelAnchor

getVertLabelRotation

print

registerPersistent

loadFromState

saveToState