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

Interface IFFrame

All Superinterfaces:

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

All Known Subinterfaces:

IFFrameUseFMap, LayoutPanelListener

All Known Implementing Classes:

AbstractFFrameViewDependence, FFrame, FFrameBasic, FFrameGraphics, FFrameGrid, FFrameGroup, FFrameLegend, FFrameMapBox, FFrameNorth, FFrameOverView, FFramePicture, FFrameScaleBar, FFrameSymbol, FFrameTable, FFrameText, FFrameView

public interface IFFrame
extends IPrintable, Persistent, Cloneable, Observable, Disposable

Interface representing a frame that can be added to a LayoutDocument. IFFrames are assumed to be rectangular objects that are able to draw themselves on a Graphics2D object. They handle selection status and can also be rotated. Specific implementations of this interface should be able to persist their status.

Field Summary

Fields

Modifier and Type	Field and Description
static int	E FFrame has been selected by clicking on its East boundary
static int	N FFrame has been selected by clicking on its North boundary
static int	NE FFrame has been selected by clicking on its North-East corner
static int	NO FFrame has been selected by clicking on its North-West corner
static int	NOSELECT FFrame is not selected
static int	O FFrame has been selected by clicking on its West boundary
static int	RECT FFrame has been selected by clicking within the frame rectangle
static int	S FFrame has been selected by clicking on its South boundary
static int	SE FFrame has been selected by clicking on its South-East corner
static int	SO FFrame has been selected by clicking on its South-West corner

Method Summary

Modifier and Type	Method and Description
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	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, java.awt.geom.Rectangle2D r, java.awt.image.BufferedImage imgBase) Este método se implementa en cada una de las fframe, ya que cada una se dibuja de una forma diferente sobre el graphics.
void	drawDraft(java.awt.Graphics2D g) Dibuja un rectángulo de color gris, con el nombre en el centro y escalado en forma de borrador.
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 el símbolo que indica que el FFrame 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()
LayoutContext	getLayoutContext()
int	getLevel() Devuelve el nivel al que se encuentra el FFrame en el Layout.
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.
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 valor del 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.
boolean	isSelected() Gets the selection status of the frame
void	setBoundBox(java.awt.geom.Rectangle2D rect) Sets the bounding box in centimeters of this FFrame, using paper coordinates.
void	setDocument(Document document)
void	setFrameFactory(FrameFactory frameFactory)
void	setLayoutContext(LayoutContext layoutContext)
void	setLevel(int l) Inserta el nivel de dibujado del FFrame respecto del resto de fframes del Layout.
void	setNum(int i) Introduce el número de FFrame en el que de que se trata.
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 b, 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.
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 interface org.gvsig.fmap.mapcontext.rendering.symbols.IPrintable

print

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Methods inherited from interface org.gvsig.tools.lang.Cloneable

clone, cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Field Detail

N

static final int N

FFrame has been selected by clicking on its North boundary

See Also:

Constant Field Values

NE

static final int NE

FFrame has been selected by clicking on its North-East corner

See Also:

Constant Field Values

E

static final int E

FFrame has been selected by clicking on its East boundary

See Also:

Constant Field Values

SE

static final int SE

FFrame has been selected by clicking on its South-East corner

See Also:

Constant Field Values

S

static final int S

FFrame has been selected by clicking on its South boundary

See Also:

Constant Field Values

SO

static final int SO

FFrame has been selected by clicking on its South-West corner

See Also:

Constant Field Values

O

static final int O

FFrame has been selected by clicking on its West boundary

See Also:

Constant Field Values

NO

static final int NO

FFrame has been selected by clicking on its North-West corner

See Also:

Constant Field Values

RECT

static final int RECT

FFrame has been selected by clicking within the frame rectangle

See Also:

Constant Field Values

NOSELECT

static final int NOSELECT

FFrame is not selected

See Also:

Constant Field Values

Method Detail

getBoundingBox

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.

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

getBoundBox

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

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

Returns:

The bounding box of this FFrame, measured in centimeters.

setBoundBox

void setBoundBox(java.awt.geom.Rectangle2D rect)

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

Parameters:

r - Rectangle in centimeters

draw

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

Este método se implementa en cada una de las fframe, ya que cada una se dibuja de una forma diferente sobre el graphics. 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.

Parameters:

g - Graphics

at - Transformada afin.

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

imgBase - Imagen para acelerar el dibujado.

Throws:

ReadDriverException - TODO

getName

java.lang.String getName()

Devuelve el nombre que representa al fframe.

Returns:

String nombre del FFrame.

contains

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.

Parameters:

p - punto a comprobar.

Returns:

true si el punto esta dentro del boundingbox.

drawHandlers

void drawHandlers(java.awt.Graphics2D g)

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

Parameters:

g - Graphics sobre el que dibujar.

setSelected

void setSelected(java.awt.geom.Point2D b,
                 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

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

setSelected

void setSelected(boolean b)

Sets the selected status of the frame.

Parameters:

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

See Also:

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

getSelected

int getSelected()

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

Returns:

The type of selection that has been applied

See Also:

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

isSelected

boolean isSelected()

Gets the selection status of the frame

Returns:

true if the frame is selected, false otherwise

See Also:

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

getContains

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

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

Parameters:

p - Point to compare

Returns:

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

getMapCursor

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.

Parameters:

p - punto a comprobar.

Returns:

Cursor adecuado a la posición.

getMovieRect

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.

Parameters:

difx - desplazamiento sobre el eje x.

dify - desplazamiento sobre el eje y.

Returns:

rectángulo modificado en función del desplazamiento realizado.

getMovieRect

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.

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.

drawDraft

void drawDraft(java.awt.Graphics2D g)

Dibuja un rectángulo de color gris, con el nombre en el centro y escalado en forma de borrador.

Parameters:

g - Graphics sobre el que se dibuja.

updateRect

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.

Parameters:

r - Rectángulo.

at - Matriz de transformación.

intersects

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.

Parameters:

rv - Rectángulo

r - Rectángulo

Returns:

True si intersecta o es null.

setNum

void setNum(int i)

Introduce el número de FFrame en el que de que se trata.

Parameters:

i - número de FFrame

getNameFFrame

java.lang.String getNameFFrame()

Devuelve el nombre que representa al tipo de FFrame.

Returns:

nombre del elemento.

setTag

void setTag(java.lang.String s)

Rellena el tag.

Parameters:

s - valor del tag.

getTag

java.lang.String getTag()

Devuelve el valor del tag.

Returns:

String del valor del tag.

drawSymbolTag

void drawSymbolTag(java.awt.Graphics2D g)

Dibuja el símbolo que indica que el FFrame contiene un tag.

Parameters:

g - Graphics sobre el que dibujar.

setRotation

void setRotation(double rotation)

Sets the rotation of the frame, measured in arc degrees

Parameters:

rotation - Rotation to apply to the frame

getRotation

double getRotation()

Gets the rotation of the frame, measured in arc degrees

Returns:

Rotation of the frame

getLevel

int getLevel()

Devuelve el nivel al que se encuentra el FFrame en el Layout.

Returns:

nivel.

setLevel

void setLevel(int l)

Inserta el nivel de dibujado del FFrame respecto del resto de fframes del Layout.

Parameters:

l - nivel.

getLastMoveRect

java.awt.geom.Rectangle2D getLastMoveRect()

setFrameFactory

void setFrameFactory(FrameFactory frameFactory)

getFrameFactory

FrameFactory getFrameFactory()

getDocument

Document getDocument()

setDocument

void setDocument(Document document)

getLayoutContext

LayoutContext getLayoutContext()

setLayoutContext

void setLayoutContext(LayoutContext layoutContext)

frameRemoved

void frameRemoved()

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

frameAdded

void frameAdded()

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