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

Class FFrameScaleBar

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

All Implemented Interfaces:

Cloneable, IFFrame, IFFrameViewDependence, IPrintable, Disposable, Observable, Persistent

public class FFrameScaleBar
extends AbstractFFrameViewDependence
implements IFFrameViewDependence

FFrame para introducir una barra de escala en el Layout.

Field Summary

Fields

Modifier and Type	Field and Description
static NumberFormat	numberFormat
static 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, 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
FFrameScaleBar() Creates a new FFrameScaleBar object.

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(Graphics2D g, AffineTransform at, Rectangle2D rv, BufferedImage imgBase) Método que dibuja sobre el graphics que se le pasa como parámetro, según la transformada afin que se debe de aplicar y el rectángulo que se debe de dibujar.
String	format(double d) DOCUMENT ME!
Color	getBarColor() Devuelve el color de la escala gráfica.
String	getDescription() Devuelve la descripción de la escala.
MapContext	getFMap() Devuelve el FMap de la vista que se representa en la escala.
Font	getFont() Devuelve la fuente con la que se está dibujando sobre el graphics.
String	getInterval() Devuelve el long que representa el intervalo.
String	getName() Devuelve el nombre que representa al fframe.
String	getNameFFrame() Devuelve el nombre que representa al tipo de FFrame.
int	getNumDec() DOCUMENT ME!
int	getNumInterval() Devuelve el número de intervalos por encima del cero.
int	getNumLeft() Devuelve el número de intervalos en los que se quiere particionar el intervalo que se queda por debajo del cero.
int	getStyle() Devuelve el tipo de escala a dibujar.
Color	getTextColor() Devuelve el color del texto.
int	getUnits() Devuelve un entero que representa el tipo de unidades que representamos.
void	initialize()
boolean	isAboveDescription() Devuelve true si se muestra la descripción a la parte de arriba de la escala gráfica.
boolean	isAboveIntervals() Devuelve true si se muestran a la parte de arriba los valores de los intervalos.
boolean	isAboveName() Devuelve si se muestra a la parte de arriba de la escala gráfica el nombre de las unidades de medida o debajo.
boolean	isbIntervalSet() Devuelve si el intervalo es variable o si por el contrario es fijo.
boolean	isShowDescription() Devuelve si se debe mostrar la descripción o no.
boolean	isShowNameUnits() Devuelve true si se debe mostrar el nombre de las unidades de medida de la escala gráfica.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
String	obtainInterval() Devuelve el valor del intervalo.
void	print(Graphics2D g, AffineTransform at, Geometry geom, 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	setAboveDescription(boolean aboveDescription) Introduce true si se muestra arriba de la escala gráfica la descripción.
void	setAboveIntervals(boolean aboveIntervals) Inserta si se muestran los valores de los intervalos a la parte de arriba de la escala o debajo.
void	setAboveName(boolean aboveName) Inserta si el nombre se muestra a la parte de arriba de la escala gráfica o a la parte de abajo.
void	setBarColor(Color color) Inserta el color de la escala gráfica.
void	setbIntervalSet(boolean b) Especificar si el intervalo se debe mantener o es variable.
void	setBoundBox(Rectangle2D.Double r) Rellena con el rectángulo que se pasa como parámetro el boundBox(en centímetros) del fframe del cual con una transformación se podrá calcular el BoundingBox (en pixels).
void	setFFrameDependence(IFFrame f) Inserta una FFrame de la cual se necesita por tener una dependencia.
void	setFont(Font f) Rellena la fuente utilizada para dibujar los intervalos y la unidad de medida utilizada.
void	setHeight(double d) Rellenar el rectángulo de la vista sobre la que se obtiene la escala.
void	setInterval(double s) Rellenar el tamaño de un intervalo.
void	setIntervalSet(boolean b) Seleccionar ,a true, si se quiere o, a false, si no mantener los intervalos.
void	setMapUnits(int i) Rellena la unidad de medida en la que está la vista.
void	setNumDec(int numDec) DOCUMENT ME!
void	setNumInterval(int s) Rellenar el número de intervalos.
void	setNumLeft(int s) Rellenar el número de intervalos a la izquierda del cero.
void	setShowDescription(boolean showDescription) Inserta si se muestra o no la descripción.
void	setShowNameUnits(boolean showNameUnits) Inserta si se debe de mostrar el nombre de las unidades de medida o no.
void	setStyle(int s) Rellenar el estilo de barra de escala que se elige.
void	setTextColor(Color color) Inserta el color del texto.
void	setUnits(int s) Seleccionar la unidad de medida a representar en la barra de escala.

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, drawHandlers, drawSymbolTag, frameAdded, frameRemoved, getBoundBox, getBoundingBox, getContains, getDocument, getFrameFactory, getLastMoveRect, getLayoutContext, getLevel, getMapCursor, getMovieRect, 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 Detail

PERSISTENCE_DEFINITION_NAME

public static final String PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

numberFormat

public static NumberFormat numberFormat

Constructor Detail

FFrameScaleBar

public FFrameScaleBar()

Creates a new FFrameScaleBar object.

Method Detail

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.

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.

getFMap

public MapContext getFMap()

Devuelve el FMap de la vista que se representa en la escala.

Returns:

FMap.

setStyle

public void setStyle(int s)

Rellenar el estilo de barra de escala que se elige.

Parameters:

s - entero que representa el tipo de barra seleccionada.

getStyle

public int getStyle()

Devuelve el tipo de escala a dibujar.

Returns:

entero.

setInterval

public void setInterval(double s)

Rellenar el tamaño de un intervalo.

Parameters:

s - tamaño de un intervalo.

obtainInterval

public String obtainInterval()

Devuelve el valor del intervalo.

Returns:

long.

setNumInterval

public void setNumInterval(int s)

Rellenar el número de intervalos.

Parameters:

s - número de intervalos.

getNumInterval

public int getNumInterval()

Devuelve el número de intervalos por encima del cero.

Returns:

entero.

setNumLeft

public void setNumLeft(int s)

Rellenar el número de intervalos a la izquierda del cero.

Parameters:

s - número de intervalos a la izquierda.

getNumLeft

public int getNumLeft()

Devuelve el número de intervalos en los que se quiere particionar el intervalo que se queda por debajo del cero.

Returns:

entero.

setIntervalSet

public void setIntervalSet(boolean b)

Seleccionar ,a true, si se quiere o, a false, si no mantener los intervalos.

Parameters:

b - boolean a true si se quiere mantener los intervalos.

setUnits

public void setUnits(int s)

Seleccionar la unidad de medida a representar en la barra de escala.

Parameters:

s - entero que representa la unidad de medida que se selecciona.

getUnits

public int getUnits()

Devuelve un entero que representa el tipo de unidades que representamos.

Returns:

entero.

getInterval

public String getInterval()

Devuelve el long que representa el intervalo.

Returns:

Intervalo.

setHeight

public void setHeight(double d)

Rellenar el rectángulo de la vista sobre la que se obtiene la escala.

Parameters:

d - Rectángulo.

setMapUnits

public void setMapUnits(int i)

Rellena la unidad de medida en la que está la vista.

Parameters:

i - entero que representa la unidad de medida de la vista.

draw

public void draw(Graphics2D g,
        AffineTransform at,
        Rectangle2D rv,
        BufferedImage imgBase)

Método que dibuja sobre el graphics que se le pasa como parámetro, según la transformada afin que se debe de aplicar y el rectángulo que se debe de dibujar.

Specified by:

draw in interface IFFrame

Specified by:

draw in class FFrame

Parameters:

g - Graphics

at - Transformada afin.

rv - rectángulo sobre el que hacer un clip.

imgBase - Image para acelerar el dibujado.

setBoundBox

public void setBoundBox(Rectangle2D.Double r)

Rellena con el rectángulo que se pasa como parámetro el boundBox(en centímetros) del fframe del cual con una transformación se podrá calcular el BoundingBox (en pixels).

Parameters:

r - Rectángulo en centímetros.

setFont

public void setFont(Font f)

Rellena la fuente utilizada para dibujar los intervalos y la unidad de medida utilizada.

Parameters:

f - fuente a utilizar.

getFont

public Font getFont()

Devuelve la fuente con la que se está dibujando sobre el graphics.

Returns:

fuente utilizada.

isbIntervalSet

public boolean isbIntervalSet()

Devuelve si el intervalo es variable o si por el contrario es fijo.

Returns:

true si el intervalo es fijo.

setbIntervalSet

public void setbIntervalSet(boolean b)

Especificar si el intervalo se debe mantener o es variable.

Parameters:

b - si se quiere mantener el intervalo especificado.

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.

See Also:

IFFrame.getNameFFrame()

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.

setBarColor

public void setBarColor(Color color)

Inserta el color de la escala gráfica.

Parameters:

color - Color de la escala gráfica.

setTextColor

public void setTextColor(Color color)

Inserta el color del texto.

Parameters:

color - Color del texto.

getBarColor

public Color getBarColor()

Devuelve el color de la escala gráfica.

Returns:

Color de la escala gráfica.

getTextColor

public Color getTextColor()

Devuelve el color del texto.

Returns:

Color del texto.

isShowNameUnits

public boolean isShowNameUnits()

Devuelve true si se debe mostrar el nombre de las unidades de medida de la escala gráfica.

Returns:

True si se muestra las unidades de medida.

setShowNameUnits

public void setShowNameUnits(boolean showNameUnits)

Inserta si se debe de mostrar el nombre de las unidades de medida o no.

Parameters:

showNameUnits - True si se muestra el nombre de las unidades de medida.

isAboveDescription

public boolean isAboveDescription()

Devuelve true si se muestra la descripción a la parte de arriba de la escala gráfica.

Returns:

True si se muestra arriba de la escala gráfica.

setAboveDescription

public void setAboveDescription(boolean aboveDescription)

Introduce true si se muestra arriba de la escala gráfica la descripción.

Parameters:

aboveDescription - True si se muestra arriba la descripción.

isAboveIntervals

public boolean isAboveIntervals()

Devuelve true si se muestran a la parte de arriba los valores de los intervalos.

Returns:

True si se muestran arriba de la escala gráfica.

setAboveIntervals

public void setAboveIntervals(boolean aboveIntervals)

Inserta si se muestran los valores de los intervalos a la parte de arriba de la escala o debajo.

Parameters:

aboveIntervals - True si se muestran los valores de los intervalos a la parte de arriba de la escala gráfica.

isAboveName

public boolean isAboveName()

Devuelve si se muestra a la parte de arriba de la escala gráfica el nombre de las unidades de medida o debajo.

Returns:

True si se muestra a la parte de arriba de la escala gráfica.

setAboveName

public void setAboveName(boolean aboveName)

Inserta si el nombre se muestra a la parte de arriba de la escala gráfica o a la parte de abajo.

Parameters:

aboveName - True si se muestra a la parte de arriba de la escala gráfica.

isShowDescription

public boolean isShowDescription()

Devuelve si se debe mostrar la descripción o no.

Returns:

True si se muestra la descripción.

setShowDescription

public void setShowDescription(boolean showDescription)

Inserta si se muestra o no la descripción.

Parameters:

showDescription - True si se muestra la descripción.

getDescription

public String getDescription()

Devuelve la descripción de la escala.

Returns:

Descripción de la escala.

print

public void print(Graphics2D g,
         AffineTransform at,
         Geometry geom,
         PrintAttributes properties)

Specified by:

print in interface IPrintable

See Also:

org.gvsig.app.project.documents.layout.fframes.IFFrame#print(java.awt.Graphics2D, java.awt.geom.AffineTransform)

format

public String format(double d)

DOCUMENT ME!

Parameters:

d - DOCUMENT ME!

Returns:

DOCUMENT ME!

getNumDec

public int getNumDec()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setNumDec

public void setNumDec(int numDec)

DOCUMENT ME!

Parameters:

numDec - DOCUMENT ME!

initialize

public void initialize()

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