/*DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2006-2008. Tim Boudreau. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  This particular file is designated
 * as subject to the "Classpath" exception as provided
 * in the GPL Version 2 section of the License file that
 * accompanied this code.
 */

package net.java.dev.colorchooser;

import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics;

/**
 * Model for a palette that can be painted, and from which colors may be
 * selected. An array of palettes to use may be supplied to a ColorChooser via
 * the setPalettes method.
 * 
 * @author Tim Boudreau
 */
public abstract class Palette {

	/**
	 * Returns the color at the specified point, or null if the point is beyond
	 * the bounds of the palette or in an area that does not indicate a color
	 * 
	 * @param x
	 *            - an horizontal coordinate in the coordinate space of the
	 *            palette
	 * @param y
	 *            - a vertical coordinate in the coordinate space of the palette
	 * @return - a color or null
	 */
	public abstract Color getColorAt(int x, int y);

	/**
	 * Returns a string description of the color at the point. May be a name or
	 * a set of RGB values, but should not be longer than 30 characters. Returns
	 * null if the position is outside the bounds of the palette or has no
	 * description associated with it. Generally getNameAt() should return null
	 * from the same coordinates that getColorAt() would.
	 * 
	 * @param x
	 *            an horizontal coordinate in the coordinate space of the
	 *            palette
	 * @param y
	 *            a vertical coordinate in the coordinate space of the palette
	 * @return a string describing the color at this coordinate or null
	 * @see #getColorAt
	 */
	public abstract String getNameAt(int x, int y);

	/**
	 * Paint this palette to a graphics context.
	 * 
	 * @param g
	 *            - a graphics context to paint into
	 */
	public abstract void paintTo(Graphics g);

	/**
	 * Get the on-screen size of this palette
	 * 
	 * @return the size of this palette - corresponding to the screen space
	 *         required to display it and defining the coordinate space of this
	 *         palette.
	 */
	public abstract Dimension getSize();

	/**
	 * Get a localized name for this palette or null if a display name is not
	 * warranted
	 * 
	 * @return the display name
	 */

	public abstract void setSize(int w, int h);

	public abstract String getDisplayName();

	/**
	 * Get the default set of 8 palettes used by the color chooser. If
	 * continuousFirst is true, the first four will be continuous palettes and
	 * the second four swatches with named colors, system colors, etc.
	 */
	public static final Palette[] getDefaultPalettes(
			final boolean continuousFirst) {
		Palette[] result = new Palette[8];
		final Palette[] first = continuousFirst ? ContinuousPalette
				.createDefaultPalettes() : PredefinedPalette
				.createDefaultPalettes();
				final Palette[] second = !continuousFirst ? ContinuousPalette
						.createDefaultPalettes() : PredefinedPalette
						.createDefaultPalettes();

						result = new Palette[second.length + first.length];
						System.arraycopy(first, 0, result, 0, 4);
						System.arraycopy(second, 0, result, 4, 4);
						return result;
	}

	public static final Palette createContinuousPalette(final String name,
			final Dimension size, final float saturation) {
		if (size.width <= 0)
			throw new IllegalArgumentException("width less than or equal 0");
		if (size.height <= 0)
			throw new IllegalArgumentException("height less than or equal 0");
		return new ContinuousPalette(name, size.width, size.height, saturation);
	}

	public static final Palette createPredefinedPalette(final String name,
			final Color[] colors, final String[] names) {
		final NamedColor[] cc = new NamedColor[colors.length];
		for (int i = 0; i < colors.length; i++) {
			cc[i] = NamedColor.create(colors[i], names[i]);
		}
		return new PredefinedPalette(name, cc);
	}

}