Application: gvSIG desktop

/*

 * Created on 20-feb-2004

 *

 * To change the template for this generated file go to

 * Window>Preferences>Java>Code Generation>Code and Comments

 */

package com.iver.cit.gvsig.gui.layout.fframes;

import com.iver.utiles.XMLEntity;

import java.awt.Cursor;

import java.awt.Graphics2D;

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

/**

 * Interface que implementa FFrame.

 *

 * @author Vicente Caballero Navarro

 */

public interface IFFrame {

    /**

     * Devuelve el boundingBox del fframe en funci?n de la transformada af?n

     * que se pasa como par?metro. Si se pasa como par?metro null, devuelve el

     * ?ltimo boundingbox que se calcul?.

     *

     * @param at Transformada af?n

     *

     * @return Rect?ngulo que representa el BoundingBox del fframe.

     */

    public Rectangle2D.Double getBoundingBox(AffineTransform at);

    /**

     * Devuelve el rect?ngulo que representa el fframe en cent?metros.

     *

     * @return Rect?ngulo en centimetros.

     */

    public Rectangle2D.Double getBoundBox();

    /**

     * 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).

     *

     * @param r Rect?ngulo en cent?metros.

     */

    public void setBoundBox(Rectangle2D.Double rect);

    /**

     * Devuelve el rect?ngulo del fframe en pixels a partir  de un rect?ngulo

     * como par?metro de entrada en cent?metros.

     *

     * @param r Rect?ngulo en cent?metros.

     * @param at Transformada af?n

     */

    /* public Rectangle2D.Double fromSheetRect(Rectangle2D.Double r,

       AffineTransform at);

     */

    /**

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

     *

     * @param g Graphics

     * @param at Transformada afin.

     * @param r rect?ngulo sobre el que hacer un clip.

     * @param imgBase TODO

     */

    public void draw(Graphics2D g, AffineTransform at, Rectangle2D r,

        BufferedImage imgBase);

    /**

     * Devuelve el nombre que representa al fframe.

     *

     * @return String

     */

    public String getName();

    /**

     * Rellena el String que representa al nombre del fframe.

     *

     * @param n nombre del fframe.

     */

    public void setName(String n);

    /**

     * Devuelve true, si el punto que se pasa como par?metro esta contenido

     * dentro del boundingbox del fframe.

     *

     * @param p punto a comprobar.

     *

     * @return true si el punto esta dentro del boundingbox.

     */

    public boolean contains(Point2D.Double p);

    /**

     * Dibuja los handlers sobre el boundingBox en el graphics que se pasa como

     * par?metro.

     *

     * @param g Graphics sobre el que dibujar.

     */

    public void drawHandlers(Graphics2D g);

    /**

     * Pasando como par?metro true,  se toma como que esta seleccionado el

     * fframe  y si es false como que esta sin seleccionar,  de esta forma se

     * selecciona un fframe directamente  sin comprobar si un punto esta

     * contenido en ?l.

     *

     * @param b true si se quiere seleccionar y false si se quiere

     *        deseleccionar.

     */

    public void setSelected(Point2D.Double b);

    /**

     * Establece que tipo de selecci?n se realiza sobre el fframe.

     *

     * @param p punto sobre el que se debe de establecer si se selecciona o no

     *        el fframe.

     */

    public void setSelected(boolean b);

    /**

     * Devuelve un entero que representa el tipo de selecci?n que se ha

     * realizado sobre el fframe.

     *

     * @return tipo de selecci?n que se ha realizado.

     */

    public int getSelected();

    /**

     * Devuelve un entero que representa donde esta contenido el punto que se

     * pasa como par?metro.

     *

     * @param p punto a comparar.

     *

     * @return entero que representa como esta contenido el punto.

     */

    public int getContains(Point2D.Double p);

    /**

     * Devuelve el Cursor adecuado seg?n como est? contenido el punto, si es

     * para desplazamiento, o cambio de tama?o.

     *

     * @param p punto a comprobar.

     *

     * @return Cursor adecuado a la posici?n.

     */

    public Cursor getMapCursor(Point2D.Double p);

    /**

     * Devuelve el rect?ngulo a partir del desplazamiento en el eje x y el

     * desplazamiento en el eje y.

     *

     * @param difx desplazamiento sobre el eje x.

     * @param dify desplazamiento sobre el eje y.

     *

     * @return rect?ngulo modificado en funci?n del desplazamiento realizado.

     */

    public Rectangle2D getMovieRect(int difx, int dify);

    /**

     * Devuelve un Objeto XMLEntity con la informaci?n los atributos

     * necesarios para poder despu?s volver a crear el objeto original.

     *

     * @return XMLEntity.

     */

    public XMLEntity getXMLEntity();

    /**

     * Dibuja un rect?ngulo de color gris,  con el nombre en el centro y

     * escalado en forma de borrador.

     *

     * @param g Graphics sobre el que se dibuja.

     */

    public void drawDraft(Graphics2D g);

    /**

     * Actualiza el rect?ngulo que representa al FFrame.

     *

     * @param at Matriz de transformaci?n.

     */

    public void updateRect(Rectangle2D r,AffineTransform at);

        public boolean intersects(Rectangle2D rv,Rectangle2D r);

        public void updateNum();

        public int getNum();

}