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

Class FFrame

java.lang.Object

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

All Implemented Interfaces:

java.lang.Cloneable, IFFrame, IPrintable, Disposable, Observable, Persistent

Direct Known Subclasses:

AbstractFFrameViewDependence, FFrameBasic, FFrameGraphics, FFrameMapBox, FFramePicture, FFrameText, FFrameView

public abstract class FFrame
extends java.lang.Object
implements IFFrame

Class implementing the IFFrame interface, that will be extended by all the FFrames. It provides default methods useful for all fframes and abstract methods to be implemented by them.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Rectangle	e
protected FrameFactory	frameFactory
static java.awt.Image	iEResize
static java.awt.Image	iNResize
protected java.awt.geom.AffineTransform	lastAT
protected LayoutManager	layoutManager
protected static Logger	LOG
protected java.awt.geom.Rectangle2D.Double	m_BoundBox
protected int	m_Selected
protected java.awt.Rectangle	n
protected java.awt.Rectangle	ne
protected java.awt.Rectangle	no
protected int	num
protected java.awt.Rectangle	o
protected ObservableHelper	observers
static java.lang.String	PERSISTENCE_DEFINITION_NAME
protected java.awt.Rectangle	s
protected java.awt.Rectangle	se
protected java.awt.Rectangle	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
FFrame()

Method Summary

Modifier and Type	Method and Description
void	addObserver(Observer o)
java.lang.Object	clone() Creates a copy of the object.
boolean	contains(java.awt.geom.Point2D p) Devuelve true, si el punto que se pasa como par�metro esta contenido dentro del boundingbox del fframe.
void	deleteObserver(Observer o)
void	deleteObservers()
void	dispose() Disposes the current object, to allow it to close and dispose any used resources.
protected void	doSetSelected(int selectedStatus)
abstract void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, java.awt.geom.Rectangle2D r, java.awt.image.BufferedImage imgBase) Draws the FFrame on the provided Graphics, according to the provided affine transform and the visible rectangle.
void	drawDraft(java.awt.Graphics2D g) Dibuja sobre el graphics el rect�ngulo del fframe en modo borrador.
void	drawEmpty(java.awt.Graphics2D g) Draws the FFrame rectangle on the provided Graphics2D, only showing the FFrame name on an empty rectangle.
void	drawHandlers(java.awt.Graphics2D g) Dibuja los handlers sobre el boundingBox en el graphics que se pasa como par�metro.
void	drawSymbolTag(java.awt.Graphics2D g) Dibuja sobre el graphics que se pasa como par�metro el icono que representa que contiene un tag.
void	frameAdded() This method is called when the FFrame has been added to the Layout
void	frameRemoved() This method is called when the FFrame has been removed from the Layout
java.awt.geom.Rectangle2D.Double	getBoundBox() Returns the bounding box in centimeters of this FFrame, using paper coordinates
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.
int	getContains(java.awt.geom.Point2D p) Checks whether the provided point is contained within the FFrame rectangle.
Document	getDocument()
FrameFactory	getFrameFactory()
java.awt.geom.Rectangle2D	getLastMoveRect() Devuelve el rect�ngulo que representa el �ltimo generado al desplazar o modificar el tama�o del fframe.
LayoutContext	getLayoutContext()
int	getLevel() Devuelve el nivel en el que se encuentra el FFrame.
java.awt.Image	getMapCursor(java.awt.geom.Point2D p) Devuelve el Cursor adecuado seg�n como est� contenido el punto, si es para desplazamiento, o cambio de tama�o.
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.
double	getRotation() Gets the rotation of the frame, measured in arc degrees
protected java.awt.geom.AffineTransform	getRotationAT() Gets the affine transform used to rotate the graphics when rotation is not 0
int	getSelected() Returns an integer representing the type of selection applied to the FFrame.
java.lang.String	getTag() Devuelve el tag.
protected java.awt.geom.Rectangle2D	getVisibleRect(java.awt.geom.Rectangle2D visibleLayoutDocRect, java.awt.geom.Rectangle2D frame) Gets the visible rectangle of the frame, taking rotation into consideration.
static void	initializeIcons() Initilizes the static icons
boolean	intersects(java.awt.geom.Rectangle2D rv, java.awt.geom.Rectangle2D r) Devuelve true si el rect�ngulo primero es null o si es distinto de null e intersecta.
boolean	isSelected() Gets the selection status of the frame
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setBoundBox(java.awt.geom.Rectangle2D r) Sets the bounding box in centimeters of this FFrame, using paper coordinates.
void	setDocument(Document document)
void	setFrameFactory(FrameFactory flf)
void	setLayoutContext(LayoutContext layoutContext)
void	setLevel(int l) Inserta el nivel al que se encuentra el FFrame.
void	setNum(int i) Rellena con el n�mero de FFrame.
void	setRotation(double rotation) Sets the rotation of the frame, measured in arc degrees
void	setSelected(boolean selected) Sets the selected status of the frame.
void	setSelected(java.awt.geom.Point2D p, java.awt.event.MouseEvent e) Sets the type of selection performed on the frame, based on the position of the provided Point compared with the boundaries of the FFrame.
void	setTag(java.lang.String s) Rellena el tag del FFrame.
void	updateRect(java.awt.geom.Rectangle2D r, java.awt.geom.AffineTransform at) Actualiza el BoundBox del FFrame a partir de su rect�ngulo en pixels y la matriz de transformaci�n.

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

getName, getNameFFrame

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.IPrintable

print

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

LOG

protected static final Logger LOG

m_BoundBox

protected java.awt.geom.Rectangle2D.Double m_BoundBox

lastAT

protected java.awt.geom.AffineTransform lastAT

m_Selected

protected int m_Selected

n

protected java.awt.Rectangle n

ne

protected java.awt.Rectangle ne

e

protected java.awt.Rectangle e

se

protected java.awt.Rectangle se

s

protected java.awt.Rectangle s

so

protected java.awt.Rectangle so

o

protected java.awt.Rectangle o

no

protected java.awt.Rectangle no

num

protected int num

frameFactory

protected FrameFactory frameFactory

iEResize

public static java.awt.Image iEResize

iNResize

public static java.awt.Image iNResize

layoutManager

protected LayoutManager layoutManager

observers

protected ObservableHelper observers

Constructor Detail

FFrame

public FFrame()

Method Detail

drawHandlers

public void drawHandlers(java.awt.Graphics2D g)

Dibuja los handlers sobre el boundingBox en el graphics que se pasa como par�metro.

Specified by:

drawHandlers in interface IFFrame

Parameters:

g - Graphics sobre el que dibujar.

setSelected

public void setSelected(java.awt.geom.Point2D p,
                        java.awt.event.MouseEvent e)

Sets the type of selection performed on the frame, based on the position of the provided Point compared with the boundaries of the FFrame. This method is usually called when the user clicks on the FFrame

Specified by:

setSelected in interface IFFrame

Parameters:

p - Point which should be evaluated to establish if the FFrame must be selected or not

e - Mouse event that triggered this method call

See Also:

#isSelected()}, {@link #getSelected()}

updateRect

public void updateRect(java.awt.geom.Rectangle2D r,
                       java.awt.geom.AffineTransform at)

Actualiza el BoundBox del FFrame a partir de su rect�ngulo en pixels y la matriz de transformaci�n.

Specified by:

updateRect in interface IFFrame

Parameters:

r - Rect�ngulo.

at - Matriz de transformaci�n.

getMovieRect

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

Specified by:

getMovieRect in interface IFFrame

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

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.

getLastMoveRect

public java.awt.geom.Rectangle2D getLastMoveRect()

Devuelve el rect�ngulo que representa el �ltimo generado al desplazar o modificar el tama�o del fframe.

Specified by:

getLastMoveRect in interface IFFrame

Returns:

Rectangle2D

getSelected

public int getSelected()

Returns an integer representing the type of selection applied to the FFrame. Valid values are: IFFrame.NOSELECT, IFFrame.NO, IFFrame.N, IFFrame.NE, IFFrame.O, IFFrame.RECT, IFFrame.E, IFFrame.SO, IFFrame.S, IFFrame.SE.

Specified by:

getSelected in interface IFFrame

Returns:

The type of selection that has been applied

See Also:

#isSelected()}, {@link #setSelected(boolean)}

isSelected

public boolean isSelected()

Gets the selection status of the frame

Specified by:

isSelected in interface IFFrame

Returns:

true if the frame is selected, false otherwise

See Also:

#getSelected()}, {@link #setSelected(boolean)}

contains

public boolean contains(java.awt.geom.Point2D p)

Devuelve true, si el punto que se pasa como par�metro esta contenido dentro del boundingbox del fframe.

Specified by:

contains in interface IFFrame

Parameters:

p - punto a comprobar en pixels.

Returns:

true si el punto esta dentro del boundingbox.

getContains

public int getContains(java.awt.geom.Point2D p)

Description copied from interface: IFFrame

Checks whether the provided point is contained within the FFrame rectangle.

Specified by:

getContains in interface IFFrame

Parameters:

p - Point to compare

Returns:

An integer representing the topologic relation of the point and the frame rectangle. It can be one of: IFFrame.NOSELECT, IFFrame.NO, IFFrame.N, IFFrame.NE, IFFrame.O, IFFrame.RECT, IFFrame.E, IFFrame.SO, IFFrame.S, IFFrame.SE.

getMapCursor

public java.awt.Image getMapCursor(java.awt.geom.Point2D p)

Devuelve el Cursor adecuado seg�n como est� contenido el punto, si es para desplazamiento, o cambio de tama�o.

Specified by:

getMapCursor in interface IFFrame

Parameters:

p - punto a comprobar.

Returns:

Cursor adecuado a la posici�n.

draw

public abstract void draw(java.awt.Graphics2D g,
                          java.awt.geom.AffineTransform at,
                          java.awt.geom.Rectangle2D r,
                          java.awt.image.BufferedImage imgBase)

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

Parameters:

g - Graphics2D

at - Affine transform to translate sheet coordinates (in cm) to screen coordinates (in pixels)

visibleLayoutDocRect - visible rectangle

imgBase - Image used to speed up the drawing process

getBoundingBox

public 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. If the AffineTransform is null, it returns the last calculated bounding box.

Specified by:

getBoundingBox in interface IFFrame

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

setBoundBox

public void setBoundBox(java.awt.geom.Rectangle2D r)

Sets the bounding box in centimeters of this FFrame, using paper coordinates.

Specified by:

setBoundBox in interface IFFrame

Parameters:

r - Rectangle in centimeters

getBoundBox

public java.awt.geom.Rectangle2D.Double getBoundBox()

Returns the bounding box in centimeters of this FFrame, using paper coordinates

Specified by:

getBoundBox in interface IFFrame

Returns:

The bounding box of this FFrame, measured in centimeters.

setSelected

public void setSelected(boolean selected)

Sets the selected status of the frame.

Specified by:

setSelected in interface IFFrame

Parameters:

selected - true to select the frame, false to unselect it

See Also:

#isSelected()}, {@link #getSelected()}

doSetSelected

protected void doSetSelected(int selectedStatus)

drawDraft

public void drawDraft(java.awt.Graphics2D g)

Dibuja sobre el graphics el rect�ngulo del fframe en modo borrador.

Specified by:

drawDraft in interface IFFrame

Parameters:

g - Graphics so bre el que dibujar.

setNum

public void setNum(int i)

Rellena con el n�mero de FFrame.

Specified by:

setNum in interface IFFrame

Parameters:

i - n�mero

drawEmpty

public void drawEmpty(java.awt.Graphics2D g)

Draws the FFrame rectangle on the provided Graphics2D, only showing the FFrame name on an empty rectangle.

Parameters:

g - The graphics to draw on

intersects

public boolean intersects(java.awt.geom.Rectangle2D rv,
                          java.awt.geom.Rectangle2D r)

Devuelve true si el rect�ngulo primero es null o si es distinto de null e intersecta.

Specified by:

intersects in interface IFFrame

Parameters:

rv - Rect�ngulo

r - Rect�ngulo

Returns:

True si intersecta o es null.

setTag

public void setTag(java.lang.String s)

Rellena el tag del FFrame.

Specified by:

setTag in interface IFFrame

Parameters:

s - String que representa el valor a guardar en el tag.

getTag

public java.lang.String getTag()

Devuelve el tag.

Specified by:

getTag in interface IFFrame

Returns:

tag.

drawSymbolTag

public void drawSymbolTag(java.awt.Graphics2D g)

Dibuja sobre el graphics que se pasa como par�metro el icono que representa que contiene un tag.

Specified by:

drawSymbolTag in interface IFFrame

Parameters:

g - Graphics sobre el que dibujar el icono.

setRotation

public void setRotation(double rotation)

Sets the rotation of the frame, measured in arc degrees

Specified by:

setRotation in interface IFFrame

Parameters:

rotation - Rotation to apply to the frame

getRotationAT

protected java.awt.geom.AffineTransform getRotationAT()

Gets the affine transform used to rotate the graphics when rotation is not 0

Returns:

getRotation

public double getRotation()

Gets the rotation of the frame, measured in arc degrees

Specified by:

getRotation in interface IFFrame

Returns:

Rotation of the frame

getLevel

public int getLevel()

Devuelve el nivel en el que se encuentra el FFrame.

Specified by:

getLevel in interface IFFrame

Returns:

nivel

setLevel

public void setLevel(int l)

Inserta el nivel al que se encuentra el FFrame.

Specified by:

setLevel in interface IFFrame

Parameters:

l - entero que refleja el nivel del FFrame.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class java.lang.Object

Returns:

a copy of the object

Throws:

java.lang.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()}.

setFrameFactory

public void setFrameFactory(FrameFactory flf)

Specified by:

setFrameFactory in interface IFFrame

getFrameFactory

public FrameFactory getFrameFactory()

Specified by:

getFrameFactory in interface IFFrame

initializeIcons

public static void initializeIcons()

Initilizes the static icons

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

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

Throws:

PersistenceException

addObserver

public void addObserver(Observer o)

Specified by:

addObserver in interface Observable

deleteObserver

public void deleteObserver(Observer o)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable

dispose

public void dispose()

Description copied from interface: Disposable

Disposes the current object, to allow it to close and dispose any used resources.

NOTE:After calling this method, the object may not be usable anymore.

Specified by:

dispose in interface Disposable

frameRemoved

public void frameRemoved()

Description copied from interface: IFFrame

This method is called when the FFrame has been removed from the Layout

Specified by:

frameRemoved in interface IFFrame

frameAdded

public void frameAdded()

Description copied from interface: IFFrame

This method is called when the FFrame has been added to the Layout

Specified by:

frameAdded in interface IFFrame

getLayoutContext

public LayoutContext getLayoutContext()

Specified by:

getLayoutContext in interface IFFrame

setLayoutContext

public void setLayoutContext(LayoutContext layoutContext)

Specified by:

setLayoutContext in interface IFFrame

getDocument

public Document getDocument()

Specified by:

getDocument in interface IFFrame

setDocument

public void setDocument(Document document)

Specified by:

setDocument in interface IFFrame

getVisibleRect

protected java.awt.geom.Rectangle2D getVisibleRect(java.awt.geom.Rectangle2D visibleLayoutDocRect,
                                                   java.awt.geom.Rectangle2D frame)

Gets the visible rectangle of the frame, taking rotation into consideration. The result of this method is the rectangular area of the unrotated frame that will be visible when the frame gets rotated.

Parameters:

visibleLayoutDocRect - The visible area of the layout document

frame - The bounding box of this frame

Returns:

the rectangular area of the unrotated frame that will be visible when the frame gets rotated, measured in screen coordinates