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

Class FFrameText

java.lang.Object

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

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

All Implemented Interfaces:

Cloneable, IFFrame, IPrintable, Disposable, Observable, Persistent

Direct Known Subclasses:

MapSheetsFrameText

public class FFrameText
extends FFrame

FFrame para introducir un texto en el Layout.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTER
static int	LEFT Localización del texto.
static String	PERSISTENCE_DEFINITION_NAME
static int	RIGTH

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
FFrameText() Crea un nuevo FFrameText.

Method Summary

Modifier and Type	Method and Description
void	addText(String s) Rellenar el texto que se quiere añadir al Layout.
void	clearText() Use this method if you want the text in the FFrameText to be removed.
Object	clone() Creates a copy of the object.
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.
double	getCellPadding() Obtiene el cellPadding
Font	getFont() Devuelve la fuente del texto.
int	getFontSize() Obtiene el fontSize
double	getFrameBorderSize() Devuelve el tamaño del borde.
Color	getFrameColor() DOCUMENT ME!
String	getName() Devuelve el nombre que representa al fframe.
String	getNameFFrame() Devuelve el nombre que representa al tipo de FFrame.
int	getPos() Devuelve la posición izquierda, centro o derecha del texto.
ArrayList	getText() Devuelve el ArrayList que contiene las líneas de texto.
Color	getTextColor() Devuelve el color del texto del FFrameText.
String	getTitle() Devuelve un string con el título.
Color	getTitleColor() DOCUMENT ME!
int	getTitleSize() Devuelve el tamaño del título.
boolean	hasTitle() Devuelve true si tiene un título.
void	initialize()
boolean	isFontSizeFixed() Obtiene el fixedFontSize
boolean	isSizeFixed() Devuelve si está fijado el tamaño.
boolean	isSurrounded() True if the FFrameText is set to draw an involving rectangle, or false if not.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(Graphics2D g, AffineTransform at, Geometry geom, PrintAttributes properties)
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setCellPadding(double i) Sets the gap between the involving rectangle and the text
void	setFixedFontSize(boolean fixedFontSize) Establece fixedFontSize
void	setFont(Font f) Inserta la fuente del texto.
void	setFontSize(int fontSize) Establece fontSize
void	setFrameBorderSize(double size) Inserta el tamaño del borde.
void	setFrameColor(Color frameColor) DOCUMENT ME!
void	setHasTitle(boolean b) Inserta true si tiene título
void	setPos(int p) Pone la posición izquierda, centro o derecha del texto.
void	setSizeFixed(boolean b) Seleccionar si se quiere un tamaño fijo o adecuado a la escala.
void	setSurrounded(boolean b) Sets FFrameText to draw an involving rectangle
void	setTextColor(Color color) Inserta el color del texto a escribir.
void	setTitle(String text) Inserta un string con el título.
void	setTitleColor(Color titleColor) DOCUMENT ME!
void	setTitleSize(int size) Inserta el tamaño del título.

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

Field Detail

PERSISTENCE_DEFINITION_NAME

public static final String PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

LEFT

public static final int LEFT

Localización del texto.

See Also:

Constant Field Values

CENTER

public static final int CENTER

See Also:

Constant Field Values

RIGTH

public static final int RIGTH

See Also:

Constant Field Values

Constructor Detail

FFrameText

public FFrameText()

Crea un nuevo FFrameText.

Method Detail

setFont

public void setFont(Font f)

Inserta la fuente del texto.

Parameters:

f - Fuente del texto.

getTextColor

public Color getTextColor()

Devuelve el color del texto del FFrameText.

Returns:

Color del texto.

isFontSizeFixed

public boolean isFontSizeFixed()

Obtiene el fixedFontSize

Returns:

boolean

setFixedFontSize

public void setFixedFontSize(boolean fixedFontSize)

Establece fixedFontSize

Parameters:

fixedFontSize -

getFontSize

public int getFontSize()

Obtiene el fontSize

Returns:

int

setFontSize

public void setFontSize(int fontSize)

Establece fontSize

Parameters:

fontSize -

getCellPadding

public double getCellPadding()

Obtiene el cellPadding

Returns:

int

setTextColor

public void setTextColor(Color color)

Inserta el color del texto a escribir.

Parameters:

color - Color del texto.

getFont

public Font getFont()

Devuelve la fuente del texto.

Returns:

Fuente del texto.

getPos

public int getPos()

Devuelve la posición izquierda, centro o derecha del texto.

Returns:

Posición del texto.

setPos

public void setPos(int p)

Pone la posición izquierda, centro o derecha del texto.

Parameters:

p - 0=LEFT,1=CENTER,2=RIGTH.

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 afín.

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

imgBase - Imagen para acelerar el dibujado.

print

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

addText

public void addText(String s)

Rellenar el texto que se quiere añadir al Layout.

Parameters:

s - String a añadir.

getText

public ArrayList getText()

Devuelve el ArrayList que contiene las líneas de texto.

Returns:

ArrayList.

setSizeFixed

public void setSizeFixed(boolean b)

Seleccionar si se quiere un tamaño fijo o adecuado a la escala.

Parameters:

b - true si se quiere tamaño fijo.

isSizeFixed

public boolean isSizeFixed()

Devuelve si está fijado el tamaño.

Returns:

True si está fijado el tamaño.

getNameFFrame

public String getNameFFrame()

Description copied from interface: IFFrame

Devuelve el nombre que representa al tipo de FFrame.

Returns:

nombre del elemento.

See Also:

IFFrame.getNameFFrame()

getName

public String getName()

Description copied from interface: IFFrame

Devuelve el nombre que representa al fframe.

Returns:

String nombre del FFrame.

setSurrounded

public void setSurrounded(boolean b)

Sets FFrameText to draw an involving rectangle

Parameters:

b -

isSurrounded

public boolean isSurrounded()

True if the FFrameText is set to draw an involving rectangle, or false if not.

Returns:

boolean

setCellPadding

public void setCellPadding(double i)

Sets the gap between the involving rectangle and the text

Parameters:

i -

hasTitle

public boolean hasTitle()

Devuelve true si tiene un título.

Returns:

getTitle

public String getTitle()

Devuelve un string con el título.

Returns:

setHasTitle

public void setHasTitle(boolean b)

Inserta true si tiene título

Parameters:

b -

setTitle

public void setTitle(String text)

Inserta un string con el título.

Parameters:

text -

getTitleSize

public int getTitleSize()

Devuelve el tamaño del título.

Returns:

setTitleSize

public void setTitleSize(int size)

Inserta el tamaño del título.

Parameters:

size - DOCUMENT ME!

setFrameBorderSize

public void setFrameBorderSize(double size)

Inserta el tamaño del borde.

Parameters:

size -

getFrameBorderSize

public double getFrameBorderSize()

Devuelve el tamaño del borde.

Returns:

setFrameColor

public void setFrameColor(Color frameColor)

DOCUMENT ME!

Parameters:

frameColor -

setTitleColor

public void setTitleColor(Color titleColor)

DOCUMENT ME!

Parameters:

titleColor - DOCUMENT ME!

getFrameColor

public Color getFrameColor()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getTitleColor

public Color getTitleColor()

DOCUMENT ME!

Returns:

DOCUMENT ME!

clearText

public void clearText()

Use this method if you want the text in the FFrameText to be removed.

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 FFrame

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 FFrame

Throws:

PersistenceException

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class FFrame

Returns:

a copy of the object

Throws:

CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.