Application: gvSIG desktop » gvSIG Document Layout

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.app.project.documents.layout;

import java.awt.geom.AffineTransform;

import java.util.Iterator;

import org.gvsig.app.project.documents.layout.commands.FrameCommandsRecord;

import org.gvsig.app.project.documents.layout.fframes.IFFrame;

import org.gvsig.app.project.documents.layout.toc.TocModelObserver;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.persistence.Persistent;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public interface LayoutContext extends Persistent, Observable {

    /**

     * Returns the AffineTransform that is applying in the Layout.

     *

     * @return AffineTransform

     */

    public AffineTransform getAT();

    /**

     * Call all LayoutDrawListeners.

     *

     */

    public void notifAllObservers();

    /**

     * It returns the print attributes of the Layout.

     *

     * @return Attributes.

     */

    public Attributes getAttributes();

    /**

     * Inserts the print attributes of Layout.

     *

     * @param attributes Attributes.

     */

    public void setAtributes(Attributes attributes);

    /**

     * It obtains the Array with all the FFrames that have been added al Layout.

     *

     * @return Array with all the FFrames that have been added al Layout.

     */

    public IFFrame[] getFFrames();

    /**

     * It obtains the FFrame from an index.

     *

     */

    public IFFrame getFFrame(int i);

    /**

     * It orders the FFrames depending on its position specified by level.

     *

     */

    public void updateFFrames();

    /**

     * Remove the fframes selected.

     *

     */

    public void delFFrameSelected();

    /**

     * Clear the selection of FFrames.

     *

     */

    public void clearSelection();

    /**

     * Remove the fframe of index.

     *

     */

    public void delFFrame(int index);

    /**

     * Remove the fframe of parameter.

     *

     * @param frame FFrame to remove.

     */

    public void delFFrame(IFFrame frame);

    /**

     * Returns the EditableFeatureSource, is the control of all change in the

     * FFrames of Layout.

     *

     * @return EditableFatureSource.

     */

    public FrameCommandsRecord getFrameCommandsRecord();

    /**

     * It adds a fframe to Arraylist of FFrames .

     *

     * @param frame fframe to add.

     * @param clearSelection True True if clean the selection of the fframes

     * already added and false if intends to maintain the same selection.

     * @param select Boolean that indicates if has to remain selected the FFrame

     * that is added or not.

     */

    public void addFFrame(IFFrame frame, boolean clearSelection, boolean select);

    /**

     * It adds a fframe to Arraylist of FFrames with the same properties.

     *

     * @param frame fframe to add.

     */

    public void addFFrameSameProperties(IFFrame frame);

    /**

     * Returns other number behind the current fframes.

     *

     * @return new Position behind.

     */

    public int getNumBehind();

    /**

     * Returns other number before the current fframes.

     *

     * @return new Position before.

     */

    public int getNumBefore();

    /**

     * It returns all the fframes included them erased and modified in all its

     * previous forms.

     *

     * @return IFFrame[] Array of FFrames.

     */

    public IFFrame[] getAllFFrames();

    /**

     * Gets the list of selected FFrames

     *

     * @return An Array of selected FFrames

     */

    public IFFrame[] getSelectedFFrames();

    /**

     * Gets the list of selected FFrames that are instance of the provided

     * Class.

     *

     * @param <T>

     *

     * @param clazz A class

     * @return An Array of selected FFrames

     */

    public <T> T[] getSelectedFFrames(Class<T> clazz);

    /**

     * It returns if the Layout is in edition.

     *

     * @return True if Layout is in edition.

     */

    public boolean isEditable();

    /**

     * It inserts if the Layout is in edition.

     *

     * @param b True if Layout is in edition.

     */

    public void setEditable(boolean b);

    /**

     * It returns if has been applying in the fframes that are added to Layout

     * the grid, or not.

     *

     * @return true if has been applying the grid.

     */

    public boolean isAdjustingToGrid();

    /**

     * It inserts if has been applying in the fframes that are added to Layout

     * the grid, or not.

     *

     * @param b true if has been applying the grid.

     */

    public void setAdjustToGrid(boolean b);

    /**

     * It inserts if is shown or not the rule of the Layout.

     *

     * @param b True if is shown or not the rule of the Layout.

     */

    public void setRuler(boolean b);

    /**

     * Returns if is shown or not the rule of the Layout.

     *

     * @return True si se muestra la regla.

     */

    public boolean getRuler();

    /**

     * It returns if has been showing the grid of Layout, or not.

     *

     * @return true if has been showing the grid of Layout.

     */

    public boolean isGridVisible();

    /**

     * It inserts if draws the Grid in the Layout or not.

     *

     * @param b True if draws the Grid in the Layout.

     */

    public void setGridVisible(boolean b);

    /**

     * Refresh all FFrames of Layout.

     */

    public void fullRefresh();

    public void setNumBehind(int numBehind);

    public void setNumBefore(int numBefore);

    /**

     * Sets the model of the TOC. The LayoutPanel will create a TOC in the user

     * interface if a tocModel has been set.

     */

    public void setTocModel(MapContext tocModel);

    /**

     * Gets the model of the TOC. The LayoutPanel will create a TOC in the user

     * interface if a tocModel has been set.

     */

    public MapContext getTocModel();

    /**

     * Triggers a notification to the TocModel observers of type

     * {@link TocModelChangedNotification#MODEL_CHANGED}

     */

    public void notifyTocUpdated(TocModelChangedNotification.Type notificationType);

    public void addTocObserver(TocModelObserver observer);

    public void removeTocObserver(TocModelObserver observer);

    public void removeTocObservers();

    /**

     * True when the document window has been opened at least once, false

     * otherwise. This is required to decide whether the page setting dialog has

     * to be shown to the user, otherwise it would be shown every time the

     * document is opened from project persistence

     */

    public boolean hasDocBeenOpened();

    /**

     * True when the document window has been opened at least once, false

     * otherwise. This is required to decide whether the page setting dialog has

     * to be shown to the user, otherwise it would be shown every time the

     * document is opened from project persistence

     */

    public void setHasDocBeenOpened(boolean hasBeenOpened);

    /**

     * Get an Iterator over al elements in the layout.

     * 

     * @return 

     */

    public Iterator deepiterator();

    public Iterator iterator();

}