Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id$

* $Log$

* Revision 1.8  2007-03-06 17:08:54  caballero

* Exceptions

*

* Revision 1.7  2007/01/25 16:25:23  jaume

* *** empty log message ***

*

* Revision 1.6  2007/01/24 17:58:22  jaume

* new features and architecture error fixes

*

* Revision 1.5  2007/01/16 11:50:44  jaume

* *** empty log message ***

*

* Revision 1.4  2007/01/12 10:08:26  jaume

* *** empty log message ***

*

* Revision 1.3  2007/01/11 12:17:34  jaume

* *** empty log message ***

*

* Revision 1.2  2007/01/10 16:39:41  jaume

* ISymbol now belongs to com.iver.cit.gvsig.fmap.core.symbols package

*

* Revision 1.1  2007/01/10 16:31:36  jaume

* *** empty log message ***

*

*

*/

package com.iver.cit.gvsig.fmap.core.symbols;

import java.awt.Graphics2D;

import java.awt.Rectangle;

import java.awt.Shape;

import java.awt.geom.AffineTransform;

import java.util.ArrayList;

import javax.print.attribute.PrintRequestAttributeSet;

import com.hardcode.gdbms.driver.exceptions.ReadDriverException;

import com.iver.cit.gvsig.fmap.core.FShape;

import com.iver.cit.gvsig.fmap.core.IGeometry;

import com.iver.cit.gvsig.fmap.core.SymbolFactory;

import com.iver.utiles.XMLEntity;

/**

 * <p>Symbol that allows to combine many symbols into one and treat it

 * as a single one. Within MultiLayerSymbol, each symbol is defined as a

 * layer inside the MultiLayerSymbol.<br></p>

 *

 * <p>This symbol does not perform anything by itself. Rather than that it

 * keeps a list of symbols and iterates over each element performing the

 * operation over each one.<br></p>

 *

 * <p>The elements of the list can be any symbol, even other MultiLayerSymbol

 * so, it is also possible to define symbols as a tree of symbols</p>

 *

 * @author jaume dominguez faus - jaume.dominguez@iver.es

 *

 */

public class MultiLayerSymbol extends AbstractSymbol {

	private ISymbol[] layers = new ISymbol[0];

	private MultiLayerSymbol selectionSymbol;

	private int symbolType;

	/**

	 * Gets the symbol in the layerIndex position of the symbol list.

	 * @param int layerIndex

	 * @return

	 */

	public ISymbol getLayer(int layerIndex) {

		try{

			return layers[layerIndex];

		} catch (Exception e) {

			return null;

		}

	}

	public int getLayerCount() {

		return layers.length;

	}

	public ISymbol getSymbolForSelection() {

		if (selectionSymbol == null) {

			selectionSymbol = new MultiLayerSymbol();

			selectionSymbol.setDescription(getDescription());

			selectionSymbol.symbolType = symbolType;

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

				selectionSymbol.addLayer(layers[i].getSymbolForSelection());

			}

		}

		return selectionSymbol;

	}

	/**

	 * Stacks a new symbol to the symbol list. The symbol is appended to the

	 * list and, in terms of use, it will be the last symbol to be processed.

	 * @param ISymbol newLayer

	 */

	public void addLayer(ISymbol newLayer) {

		if (newLayer == null) return;

		selectionSymbol = null; /* forces the selection symbol to be re-created

								 * next time it is required

								 */

		int size = layers.length+1;

		ISymbol[] newLayers = new ISymbol[size];

		for (int i = 0; i < newLayers.length-1; i++) {

			newLayers[i] = layers[i];

		}

		newLayers[size-1] = newLayer;

		layers = newLayers;

	}

	public void addLayer(ISymbol newLayer, int layerIndex) throws IndexOutOfBoundsException {

		if (newLayer == null) return;

		selectionSymbol = null; /* forces the selection symbol to be re-created

		 						 * next time it is required

		 						 */

		if (layerIndex < 0 || layers.length < layerIndex)

			throw new IndexOutOfBoundsException(layerIndex+" < 0 or "+layerIndex+" > "+layers.length);

		int size = layers.length+1;

		ArrayList newLayers = new ArrayList();

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

			newLayers.add(layers[i]);

		}

		newLayers.add(layerIndex, newLayer);

		layers = (ISymbol[]) newLayers.toArray(new ISymbol[0]);

	}

	/**

	 * TODO maybe push it up to ISymbol

	 * @param layer

	 * @return true if this symbol contains the removed one

	 */

	public boolean removeLayer(ISymbol layer) {

		int capacity = 0;

		capacity = layers.length;

		ArrayList lst = new ArrayList(capacity);

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

			lst.add(layers[i]);

		}

		boolean contains = lst.remove(layer);

		layers = (ISymbol[])lst.toArray(new ISymbol[0]);

		return contains;

	}

	public void draw(Graphics2D g, AffineTransform affineTransform, FShape shp) {

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

			layers[i].draw(g, affineTransform, shp);

		}

	}

	public int getPixExtentPlus(Graphics2D g, AffineTransform affineTransform, Shape shp) {

		// TODO Auto-generated method stub

		throw new Error("Not yet implemented!");

	}

	public int getOnePointRgb() {

		// will paint only the last layer pixel

		return layers[layers.length-1].getOnePointRgb();

	}

	public XMLEntity getXMLEntity() {

		XMLEntity xml = new XMLEntity();

		xml.putProperty("className", getClass().getName());

		xml.putProperty("isShapeVisible", isShapeVisible());

		xml.putProperty("symbolType", symbolType);

		xml.putProperty("desc", getDescription());

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

			xml.addChild(layers[i].getXMLEntity());

		}

		return xml;

	}

	public int getSymbolType() {

		return symbolType;

	}

	public boolean isSuitableFor(IGeometry geom) {

		return (geom.getGeometryType() & symbolType) > 0;

	}

	public void drawInsideRectangle(Graphics2D g, AffineTransform scaleInstance, Rectangle r) {

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

			layers[i].drawInsideRectangle(g, scaleInstance, r);

		}

	}

	public String getClassName() {

		return getClass().getName();

	}

	public void setXMLEntity(XMLEntity xml) {

		setIsShapeVisible(xml.getBooleanProperty("isShapeVisible"));

		setDescription(xml.getStringProperty("desc"));

		symbolType = xml.getIntProperty("symbolType");

		layers = new ISymbol[xml.getChildrenCount()];

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

			layers[i] = SymbolFactory.createFromXML(xml.getChild(i), "layer" + i);

		}

	}

	public void setPrintingProperties(PrintRequestAttributeSet properties) {

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

			layers[i].setPrintingProperties(properties);

		}

	}

	public void print(Graphics2D g, AffineTransform at, FShape shape) throws ReadDriverException {

		// TODO Implement it

		throw new Error("Not yet implemented!");

	}

	public void setLayer(int index, ISymbol layer) throws IndexOutOfBoundsException {

		layers[index] = layer;

	}

	public void setMultiLayerSymbolType(int type) {

		symbolType = type;

	}

	public void swapLayers(int index1, int index2) {

		ISymbol aux1 = getLayer(index1), aux2 = getLayer(index2);

		layers[index2] = aux1;

		layers[index1] = aux2;

	}

}