Application: gvSIG desktop

package org.gvsig.raster.lib.legend.api;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.util.List;

import org.gvsig.tools.persistence.Persistent;

/**

 * @author fdiaz

 *

 */

public interface Transparency extends Persistent, Cloneable {

    /**

     * Add {@link PropertyChangeListener} to fire {@link PropertyChangeEvent}

     * when properties are modified.

     *

     * @param listener

     */

    public void addPropertyChangeListener(PropertyChangeListener listener);

    /**

     * Remove {@link PropertyChangeListener} from this {@link Transparency}

     *

     * @param listener

     */

    public void removePropertyChangeListener(PropertyChangeListener listener);

    /**

     * @return Returns value of transparency

     */

    public int getAlpha();

    /**

     * @return Returns defined {@link TransparencyRange}

     */

    public List<TransparencyRange> getTransparencyRanges();

    /**

     * Add {@link TransparencyRange} to this {@link Transparency}

     *

     * @param range

     *            {@link TransparencyRange} to be added

     */

    public void addTransparencyRange(TransparencyRange range);

    /**

     * Remove {@link TransparencyRange} from this {@link Transparency}

     *

     * @param range

     *            {@link TransparencyRange} to be removed

     */

    public void removeTransparencyRange(TransparencyRange range);

    /**

     * Gets alpha of RGB. If there are any {@link TransparencyRange} that

     * defines alpha to this RGB, it will be returned. Otherwise, this method

     * will return 255.

     *

     * @param r

     *            Red byte

     * @param g

     *            Green byte

     * @param b

     *            Blue byte

     * @return Alpha defined to this RGB.

     */

    public int getTransparencyRangeAlpha(byte r, byte g, byte b);

    /**

     * Gets alpha of RGB. If there are any {@link TransparencyRange} that

     * defines alpha to this RGB, it will be returned. Otherwise, this method

     * will return 255.

     *

     * @param r

     *            Red value

     * @param g

     *            Green value

     * @param b

     *            Blue value

     * @return Alpha defined to this RGB.

     */

    public int getTransparencyRangeAlpha(int r, int g, int b);

    /**

     * Sets transparency value

     *

     * @param value

     *            Value between 0 and 255

     */

    public void setValue(int value);

    /**

     * Set {@link TransparencyRange} of this {@link Transparency}

     *

     * @param ranges

     */

    public void setTransparencyRanges(List<TransparencyRange> ranges);

}