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

Class FFrameBasic

java.lang.Object

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

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

All Implemented Interfaces:

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

public class FFrameBasic
extends FFrame

FFrame básica que contiene una FFrame de cualquier tipo.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PERSISTENCE_DEFINITION_NAME

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
FFrameBasic()

Method Summary

Modifier and Type	Method and Description
IFFrame	clone() Creates a copy of the object.
boolean	contains(java.awt.geom.Point2D.Double p)
void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, java.awt.geom.Rectangle2D rv, java.awt.image.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.
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.
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.Double p)
IFFrame	getFframe()
FFrameGraphics	getFframeGraphics()
int	getLevel() Devuelve el nivel en el que se encuentra el 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.
double	getRotation() Gets the rotation of the frame, measured in arc degrees
int	getSelected() Returns an integer representing the type of selection applied to the FFrame.
java.lang.String	getTag() Devuelve el tag.
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.
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 geom, PrintAttributes printingProperties)
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	setFframe(IFFrame fframe)
void	setFframeGraphics(FFrameGraphics fframeGraphics)
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	setRectangle(java.awt.geom.Rectangle2D r)
void	setRotation(double rotation) Sets the rotation of the frame, measured in arc degrees
void	setSelected(boolean b) 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 org.gvsig.app.project.documents.layout.fframes.FFrame

addObserver, contains, deleteObserver, deleteObservers, dispose, doSetSelected, frameAdded, frameRemoved, getContains, getDocument, getFrameFactory, getLastMoveRect, getLayoutContext, getMapCursor, getRotationAT, getVisibleRect, initializeIcons, isSelected, setDocument, setFrameFactory, setLayoutContext

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

FFrameBasic

public FFrameBasic()

Method Detail

setRectangle

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

draw

public void draw(java.awt.Graphics2D g,
                 java.awt.geom.AffineTransform at,
                 java.awt.geom.Rectangle2D rv,
                 java.awt.image.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 - Imagen para acelerar el dibujado.

getNameFFrame

public java.lang.String getNameFFrame()

Description copied from interface: IFFrame

Devuelve el nombre que representa al tipo de FFrame.

Returns:

nombre del elemento.

See Also:

IFFrame.getNameFFrame()

print

public void print(java.awt.Graphics2D g,
                  java.awt.geom.AffineTransform at,
                  Geometry geom,
                  PrintAttributes printingProperties)

See Also:

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

getFframe

public IFFrame getFframe()

setFframe

public void setFframe(IFFrame fframe)

getFframeGraphics

public FFrameGraphics getFframeGraphics()

setFframeGraphics

public void setFframeGraphics(FFrameGraphics fframeGraphics)

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.

clone

public IFFrame clone()
              throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class FFrame

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

contains

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

drawDraft

public void drawDraft(java.awt.Graphics2D g)

Description copied from class: FFrame

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

Specified by:

drawDraft in interface IFFrame

Overrides:

drawDraft in class FFrame

Parameters:

g - Graphics so bre el que dibujar.

drawEmpty

public void drawEmpty(java.awt.Graphics2D g)

Description copied from class: FFrame

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

Overrides:

drawEmpty in class FFrame

Parameters:

g - The graphics to draw on

drawSymbolTag

public void drawSymbolTag(java.awt.Graphics2D g)

Description copied from class: FFrame

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

Specified by:

drawSymbolTag in interface IFFrame

Overrides:

drawSymbolTag in class FFrame

Parameters:

g - Graphics sobre el que dibujar el icono.

getBoundBox

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

Description copied from class: FFrame

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

Specified by:

getBoundBox in interface IFFrame

Overrides:

getBoundBox in class FFrame

Returns:

The bounding box of this FFrame, measured in centimeters.

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

getContains

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

getLevel

public int getLevel()

Description copied from class: FFrame

Devuelve el nivel en el que se encuentra el FFrame.

Specified by:

getLevel in interface IFFrame

Overrides:

getLevel in class FFrame

Returns:

nivel

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.

getName

public java.lang.String getName()

Description copied from interface: IFFrame

Devuelve el nombre que representa al fframe.

Returns:

String nombre del FFrame.

getRotation

public double getRotation()

Description copied from class: FFrame

Gets the rotation of the frame, measured in arc degrees

Specified by:

getRotation in interface IFFrame

Overrides:

getRotation in class FFrame

Returns:

Rotation of the frame

getSelected

public int getSelected()

Description copied from class: FFrame

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

Overrides:

getSelected in class FFrame

Returns:

The type of selection that has been applied

See Also:

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

getTag

public java.lang.String getTag()

Description copied from class: FFrame

Devuelve el tag.

Specified by:

getTag in interface IFFrame

Overrides:

getTag in class FFrame

Returns:

tag.

intersects

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

Description copied from class: FFrame

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

Specified by:

intersects in interface IFFrame

Overrides:

intersects in class FFrame

Parameters:

rv - Rect�ngulo

r - Rect�ngulo

Returns:

True si intersecta o es null.

setBoundBox

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

Description copied from class: FFrame

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

Specified by:

setBoundBox in interface IFFrame

Overrides:

setBoundBox in class FFrame

Parameters:

r - Rectangle in centimeters

setLevel

public void setLevel(int l)

Description copied from class: FFrame

Inserta el nivel al que se encuentra el FFrame.

Specified by:

setLevel in interface IFFrame

Overrides:

setLevel in class FFrame

Parameters:

l - entero que refleja el nivel del FFrame.

setNum

public void setNum(int i)

Description copied from class: FFrame

Rellena con el n�mero de FFrame.

Specified by:

setNum in interface IFFrame

Overrides:

setNum in class FFrame

Parameters:

i - n�mero

setRotation

public void setRotation(double rotation)

Description copied from class: FFrame

Sets the rotation of the frame, measured in arc degrees

Specified by:

setRotation in interface IFFrame

Overrides:

setRotation in class FFrame

Parameters:

rotation - Rotation to apply to the frame

setSelected

public void setSelected(boolean b)

Description copied from class: FFrame

Sets the selected status of the frame.

Specified by:

setSelected in interface IFFrame

Overrides:

setSelected in class FFrame

Parameters:

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

See Also:

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

setSelected

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

Description copied from class: FFrame

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

Overrides:

setSelected in class FFrame

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()}

setTag

public void setTag(java.lang.String s)

Description copied from class: FFrame

Rellena el tag del FFrame.

Specified by:

setTag in interface IFFrame

Overrides:

setTag in class FFrame

Parameters:

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

updateRect

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

Description copied from class: FFrame

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

Overrides:

updateRect in class FFrame

Parameters:

r - Rect�ngulo.

at - Matriz de transformaci�n.

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