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.commands;

import java.util.ArrayList;

import java.util.BitSet;

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

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

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

public class FrameManager {

    private ArrayList<IFFrame> fframes = new ArrayList<IFFrame>();

    private BitSet invalidates = new BitSet();

    /**

     * Returns from an index the FFrame.

     * 

     * @param index

     * 

     * @return FFrame.

     */

    public IFFrame getFFrame(int index) {

        return fframes.get(index);

    }

    /**

     * Returns the number of FFrame.

     * 

     * @return Number of FFrames

     */

    public int getFFrameCount() {

        return fframes.size();

    }

    /**

     * Undo add FFrame from index.

     * 

     * @param index

     */

    public void undoAddFFrame(int index) {

        doRemoveFFrame(index);

    }

    /**

     * Add FFrame.

     * 

     * @param frame

     * 

     * @return index of new fframe.

     */

    public int doAddFFrame(IFFrame frame) {

        fframes.add(frame);

        int index = fframes.size() - 1;

        notifyAdded(index);

        return index; 

    }

    /**

     * Add FFrame from index.

     * 

     * @param frame

     *            New FFrame.

     * @param index

     *            Index of new FFrame.

     */

    public void doAddFFrame(IFFrame frame, int index) {

        invalidates.set(index, false);

        fframes.set(index, frame);

        notifyAdded(index);

    }

    /**

     * Undo modify an FFrame modified.

     * 

     * @param fant

     *            Previous fframe.

     * @param fnew

     *            New FFrame.

     * @param indexAnt

     *            Actual index.

     * @param indexLast

     *            Previous index.

     */

    public void undoModifyFFrame(int index, int newIndex) {

        undoRemoveFFrame(index);

        undoAddFFrame(newIndex);

        IFFrame fant = fframes.get(newIndex);

        IFFrame fnew = fframes.get(index);

        refreshDependences(fant, fnew);

    }

    /**

     * Modify FFrame from index and new FFrame.

     * 

     * @param indexAnt

     *            Actual index.

     * @param frameNext

     *            New FFrame.

     * 

     * @return New index of FFrame.

     */

    public int doModifyFFrame(int indexAnt, IFFrame frameNext) {

        doRemoveFFrame(indexAnt);

        return doAddFFrame(frameNext);

    }

    /**

     * Undo Remove FFrame from index.

     * 

     * @param index

     *            Actual index of FFrame.

     */

    public void undoRemoveFFrame(int index) {

        invalidates.set(index, false);

        notifyAdded(index);

    }

    /**

     * Remove FFrame from actual index.

     * 

     * @param index

     *            Actual index.

     */

    public void doRemoveFFrame(int index) {

        invalidates.set(index, true);

        notifyRemoved(index);

    }

    protected void notifyRemoved(int index) {

            IFFrame frame = fframes.get(index);

            frame.frameRemoved();

    }

    protected void notifyAdded(int index) {

            IFFrame frame = fframes.get(index);

            frame.frameAdded();

    }

    /**

     * Returns all the fframes that are not removed.

     * 

     * @return Vector with fframes.

     */

    public IFFrame[] getFFrames() {

        ArrayList<IFFrame> frames = new ArrayList<IFFrame>();

        for (int i = 0; i < getFFrameCount(); i++) {

            if (!invalidates.get(i)) {

                frames.add(fframes.get(i));

            }

        }

        IFFrame[] fframesV = frames.toArray(new IFFrame[0]);

        return fframesV;

    }

    /**

     * Returns all the fframes, remove and done not remove.

     * 

     * @return All FFrames.

     */

    public IFFrame[] getAllFFrames() {

        return fframes.toArray(new IFFrame[0]);

    }

    /**

     * Returns all the fframes, remove and done not remove and the ones that are

     * in the FFrameGroups

     * 

     * @return All FFrames.

     */

    public IFFrame[] getAllFFrameToDepends() {

        IFFrame[] fs = getAllFFrames();

        return getFFrameToDepends(fs);

    }

    private IFFrame[] getFFrameToDepends(IFFrame[] fs) {

        ArrayList<IFFrame> result = new ArrayList<IFFrame>();

        for (int i = 0; i < fs.length; i++) {

            result.add(fs[i]);

            if (fs[i] instanceof FFrameGroup) {

                IFFrame[] ffs =

                    getFFrameToDepends(((FFrameGroup) fs[i]).getFFrames());

                for (int j = 0; j < ffs.length; j++) {

                    result.add(ffs[j]);

                }

            }

        }

        return result.toArray(new IFFrame[0]);

    }

    public void refreshDependences(IFFrame fant, IFFrame fnew) {

        for (int i = 0; i < fframes.size(); i++) {

            if (fframes.get(i) instanceof IFFrameViewDependence) {

                IFFrameViewDependence f =

                    (IFFrameViewDependence) fframes.get(i);

                f.refreshDependence(fant, fnew);

            }

        }

    }

    public void redoModifyFFrame(int index, int newIndex, IFFrame frame) {

        doRemoveFFrame(index);

        doAddFFrame(frame, newIndex);

        IFFrame fant = fframes.get(newIndex);

        refreshDependences(fant, frame);

    }

    public BitSet invalidates() {

        return invalidates;

    }

    public void clear() {

    }

}