Package org.gvsig.app.project.documents.layout.fframes

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

Cloneable, IFFrame, IFFrameViewDependence, org.gvsig.fmap.mapcontext.rendering.symbols.IPrintable, org.gvsig.tools.dispose.Disposable, org.gvsig.tools.lang.Cloneable, org.gvsig.tools.observer.Observable, org.gvsig.tools.persistence.Persistent

public class FFrameGrid
extends AbstractFFrameViewDependence
implements IFFrameViewDependence

FFrame para introducir una cuadrícula sobre una vista en el Layout.

Author:

Vicente Caballero Navarro

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FIXED_DISTANCE_MODE	Use a fixed distance (intervalX and intervalY) to calculate the position of grid lines
static final int	NUM_DIVISIONS_HORIZ_MODE	Use a specific number of horizontal divisions in order to calculate the position of grid lines
static final int	NUM_DIVISIONS_VERT_MODE	Use a specific number of vertical divisions in order to calculate the position of grid lines
static final 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	Description
FFrameGrid()

Method Summary

Modifier and Type	Method	Description
void	draw(Graphics2D g, AffineTransform at, Rectangle2D rv, BufferedImage imgBase)	Draws the FFrame on the provided Graphics, according to the provided affine transform and the visible rectangle.
void	drawHandlers(Graphics2D g)	Dibuja los handlers sobre el boundingBox en el graphics que se pasa como par�metro.
Rectangle2D.Double	getBoundingBox(AffineTransform at)	Returns the bounding box (in pixels) of this FFrame, based on the provided AffineTransform.
Font	getFont()
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()
Rectangle2D	getLastMoveRect()	Devuelve el rect�ngulo que representa el �ltimo generado al desplazar o modificar el tama�o del fframe.
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.
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.
String	getName()	Devuelve el nombre que representa al fframe.
String	getNameFFrame()	Devuelve el nombre que representa al tipo de FFrame.
int	getNumDivisionsHoriz()
int	getNumDivisionsVert()
int	getSizeFont()
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getSymbolLine()
org.gvsig.fmap.mapcontext.rendering.symbols.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(org.gvsig.tools.persistence.PersistentState state)
void	print(Graphics2D g, AffineTransform at, org.gvsig.fmap.geom.Geometry shape, org.gvsig.compat.print.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(org.gvsig.tools.persistence.PersistentState state)
void	setFFrameDependence(IFFrame f)	Inserta una FFrame de la cual se necesita por tener una dependencia.
void	setFont(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(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbolLine)
void	setSymbolPoint(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbolPoint)
void	setTextColor(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(org.gvsig.fmap.geom.primitive.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

Field Details

PERSISTENCE_DEFINITION_NAME

public static final 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 Details

FFrameGrid

public FFrameGrid()

Method Details

draw

public void draw(Graphics2D g,
 AffineTransform at,
 Rectangle2D rv,
 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 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 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(Color textcolor)

setIsLine

public void setIsLine(boolean b)

isLine

public boolean isLine()

getFontColor

public Color getFontColor()

getSizeFont

public int getSizeFont()

setSizeFont

public void setSizeFont(int sizeFont)

getBoundingBox

public Rectangle2D.Double getBoundingBox(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 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 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(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 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 org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getSymbolLine()

setSymbolLine

public void setSymbolLine(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbolLine)

getSymbolPoint

public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getSymbolPoint()

setSymbolPoint

public void setSymbolPoint(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbolPoint)

getFont

public Font getFont()

setFont

public void setFont(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(org.gvsig.fmap.geom.primitive.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 -

invalid reference

RotatedTextUtils.ANCHOR_CORNER

or

invalid reference

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 -

invalid reference

RotatedTextUtils.ANCHOR_CORNER

or

invalid reference

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(Graphics2D g,
 AffineTransform at,
 org.gvsig.fmap.geom.Geometry shape,
 org.gvsig.compat.print.PrintAttributes properties)

Specified by:

print in interface org.gvsig.fmap.mapcontext.rendering.symbols.IPrintable

registerPersistent

public static void registerPersistent()

loadFromState

public void loadFromState(org.gvsig.tools.persistence.PersistentState state)
                   throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

loadFromState in interface org.gvsig.tools.persistence.Persistent

Overrides:

loadFromState in class AbstractFFrameViewDependence

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

saveToState

public void saveToState(org.gvsig.tools.persistence.PersistentState state)
                 throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

saveToState in interface org.gvsig.tools.persistence.Persistent

Overrides:

saveToState in class AbstractFFrameViewDependence

Throws:

org.gvsig.tools.persistence.exception.PersistenceException