All Downloads are FREE. Search and download functionalities are using the official Maven repository.

java.awt.image.IndexColorModel Maven / Gradle / Ivy

There is a newer version: 1.3.1
Show newest version
/*

NOTICE


(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.

Neither this file nor any files generated from it describe a complete specification, and they may only be used as described below. For example, no permission is given for you to incorporate this file, in whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided to you for informative, as opposed to normative, use. The file and any files generated from it may be used to generate other informative documentation, such as a unified set of documents of API signatures for a platform that includes technologies expressed as Java APIs. The file may also be used to produce "compilation stubs," which allow applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 217: Personal Basis Profile 1.1. In the event of a discrepency between this work and the JSR 217 specification, which is available at http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence. */ package java.awt.image; import java.awt.Transparency; import java.awt.color.ColorSpace; import java.math.BigInteger; /** * The IndexColorModel class is a ColorModel * class that works with pixel values consisting of a * single sample that is an index into a fixed colormap in the default * sRGB color space. The colormap specifies red, green, blue, and * optional alpha components corresponding to each index. All components * are represented in the colormap as 8-bit unsigned integral values. * Some constructors allow the caller to specify "holes" in the colormap * by indicating which colormap entries are valid and which represent * unusable colors via the bits set in a BigInteger object. * This color model is similar to an X11 PseudoColor visual. *

* Some constructors provide a means to specify an alpha component * for each pixel in the colormap, while others either provide no * such means or, in some cases, a flag to indicate whether the * colormap data contains alpha values. If no alpha is supplied to * the constructor, an opaque alpha component (alpha = 1.0) is * assumed for each entry. * An optional transparent pixel value can be supplied that indicates a * completely transparent pixel, regardless of any alpha component * supplied or assumed for that pixel value. * Note that the color components in the colormap of an * IndexColorModel objects are never pre-multiplied with * the alpha components. *

* * The transparency of an IndexColorModel object is * determined by examining the alpha components of the colors in the * colormap and choosing the most specific value after considering * the optional alpha values and any transparent index specified. * The transparency value is Transparency.OPAQUE * only if all valid colors in * the colormap are opaque and there is no valid transparent pixel. * If all valid colors * in the colormap are either completely opaque (alpha = 1.0) or * completely transparent (alpha = 0.0), which typically occurs when * a valid transparent pixel is specified, * the value is Transparency.BITMASK. * Otherwise, the value is Transparency.TRANSLUCENT, indicating * that some valid color has an alpha component that is * neither completely transparent nor completely opaque (0.0 < alpha < 1.0). * *

* The index represented by a pixel value is stored in the least * significant n bits of the pixel representations passed to the * methods of this class, where n is the pixel size specified to the * constructor for a particular IndexColorModel object; * n must be between 1 and 16, inclusive. * Higher order bits in pixel representations are assumed to be zero. * For those methods that use a primitive array pixel representation of * type transferType, the array length is always one. * The transfer types supported are DataBuffer.TYPE_BYTE and * DataBuffer.TYPE_USHORT. A single int pixel * representation is valid for all objects of this class, since it is * always possible to represent pixel values used with this class in a * single int. Therefore, methods that use this representation do * not throw an IllegalArgumentException due to an invalid * pixel value. *

* Many of the methods in this class are final. The reason for * this is that the underlying native graphics code makes assumptions * about the layout and operation of this class and those assumptions * are reflected in the implementations of the methods here that are * marked final. You can subclass this class for other reaons, but * you cannot override or modify the behaviour of those methods. * * @see ColorModel * @see ColorSpace * @see DataBuffer * * @version 10 Feb 1997 */ public class IndexColorModel extends ColorModel { /** * Constructs an IndexColorModel from the specified * arrays of red, green, and blue components. Pixels described * by this color model all have alpha components of 255 * unnormalized (1.0 normalized), which means they * are fully opaque. All of the arrays specifying the color * components must have at least the specified number of entries. * The ColorSpace is the default sRGB space. * Since there is no alpha information in any of the arguments * to this constructor, the transparency value is always * Transparency.OPAQUE. * The transfer type is the smallest of DataBuffer.TYPE_BYTE * or DataBuffer.TYPE_USHORT that can hold a single pixel. * @param bits the number of bits each pixel occupies * @param size the size of the color component arrays * @param r the array of red color components * @param g the array of green color components * @param b the array of blue color components * @throws IllegalArgumentException if bits is less * than 1 or greater than 16 * @throws IllegalArgumentException if size is less * than 1 */ public IndexColorModel(int bits, int size, byte[] r, byte[] g, byte[] b) { super(0); } /** * Constructs an IndexColorModel from the given arrays * of red, green, and blue components. Pixels described by this color * model all have alpha components of 255 unnormalized * (1.0 normalized), which means they are fully opaque, except * for the indicated transparent pixel. All of the arrays * specifying the color components must have at least the specified * number of entries. * The ColorSpace is the default sRGB space. * The transparency value may be Transparency.OPAQUE or * Transparency.BITMASK depending on the arguments, as * specified in the class description above. * The transfer type is the smallest of DataBuffer.TYPE_BYTE * or DataBuffer.TYPE_USHORT that can hold a * single pixel. * @param bits the number of bits each pixel occupies * @param size the size of the color component arrays * @param r the array of red color components * @param g the array of green color components * @param b the array of blue color components * @param trans the index of the transparent pixel * @throws IllegalArgumentException if bits is less than * 1 or greater than 16 * @throws IllegalArgumentException if size is less than * 1 */ public IndexColorModel(int bits, int size, byte[] r, byte[] g, byte[] b, int trans) { super(0); } /** * Constructs an IndexColorModel from the given * arrays of red, green, blue and alpha components. All of the * arrays specifying the components must have at least the specified * number of entries. * The ColorSpace is the default sRGB space. * The transparency value may be any of Transparency.OPAQUE, * Transparency.BITMASK, * or Transparency.TRANSLUCENT * depending on the arguments, as specified * in the class description above. * The transfer type is the smallest of DataBuffer.TYPE_BYTE * or DataBuffer.TYPE_USHORT that can hold a single pixel. * @param bits the number of bits each pixel occupies * @param size the size of the color component arrays * @param r the array of red color components * @param g the array of green color components * @param b the array of blue color components * @param a the array of alpha value components * @throws IllegalArgumentException if bits is less * than 1 or greater than 16 * @throws IllegalArgumentException if size is less * than 1 */ public IndexColorModel(int bits, int size, byte[] r, byte[] g, byte[] b, byte[] a) { super(0); } /** * Constructs an IndexColorModel from a single * array of interleaved red, green, blue and optional alpha * components. The array must have enough values in it to * fill all of the needed component arrays of the specified * size. The ColorSpace is the default sRGB space. * The transparency value may be any of Transparency.OPAQUE, * Transparency.BITMASK, * or Transparency.TRANSLUCENT * depending on the arguments, as specified * in the class description above. * The transfer type is the smallest of * DataBuffer.TYPE_BYTE or DataBuffer.TYPE_USHORT * that can hold a single pixel. * * @param bits the number of bits each pixel occupies * @param size the size of the color component arrays * @param cmap the array of color components * @param start the starting offset of the first color component * @param hasalpha indicates whether alpha values are contained in * the cmap array * @throws IllegalArgumentException if bits is less * than 1 or greater than 16 * @throws IllegalArgumentException if size is less * than 1 */ public IndexColorModel(int bits, int size, byte[] cmap, int start, boolean hasalpha) { super(0); } /** * Constructs an IndexColorModel from a single array of * interleaved red, green, blue and optional alpha components. The * specified transparent index represents a pixel that is considered * entirely transparent regardless of any alpha value specified * for it. The array must have enough values in it to fill all * of the needed component arrays of the specified size. * The ColorSpace is the default sRGB space. * The transparency value may be any of Transparency.OPAQUE, * Transparency.BITMASK, * or Transparency.TRANSLUCENT * depending on the arguments, as specified * in the class description above. * The transfer type is the smallest of * DataBuffer.TYPE_BYTE or DataBuffer.TYPE_USHORT * that can hold a single pixel. * @param bits the number of bits each pixel occupies * @param size the size of the color component arrays * @param cmap the array of color components * @param start the starting offset of the first color component * @param hasalpha indicates whether alpha values are contained in * the cmap array * @param trans the index of the fully transparent pixel * @throws IllegalArgumentException if bits is less than * 1 or greater than 16 * @throws IllegalArgumentException if size is less than * 1 */ public IndexColorModel(int bits, int size, byte[] cmap, int start, boolean hasalpha, int trans) { super(0); } // /** // * Constructs an IndexColorModel from an array of // * ints where each int is comprised of red, green, blue, and // * optional alpha components in the default RGB color model format. // * The specified transparent index represents a pixel that is considered // * entirely transparent regardless of any alpha value specified // * for it. The array must have enough values in it to fill all // * of the needed component arrays of the specified size. // * The ColorSpace is the default sRGB space. // * The transparency value may be any of Transparency.OPAQUE, // * Transparency.BITMASK, // * or Transparency.TRANSLUCENT // * depending on the arguments, as specified // * in the class description above. // * @param bits the number of bits each pixel occupies // * @param size the size of the color component arrays // * @param cmap the array of color components // * @param start the starting offset of the first color component // * @param hasalpha indicates whether alpha values are contained in // * the cmap array // * @param trans the index of the fully transparent pixel // * @param transferType the data type of the array used to represent // * pixel values. The data type must be either // * DataBuffer.TYPE_BYTE or // * DataBuffer.TYPE_USHORT. // * @throws IllegalArgumentException if bits is less // * than 1 or greater than 16 // * @throws IllegalArgumentException if size is less // * than 1 // * @throws IllegalArgumentException if transferType is not // * one of DataBuffer.TYPE_BYTE or // * DataBuffer.TYPE_USHORT // */ // public IndexColorModel(int bits, int size, int[] cmap, int start, boolean // hasalpha, int trans, int transferType) // { } // /** // * Constructs an IndexColorModel from an // * int array where each int is // * comprised of red, green, blue, and alpha // * components in the default RGB color model format. // * The array must have enough values in it to fill all // * of the needed component arrays of the specified size. // * The ColorSpace is the default sRGB space. // * The transparency value may be any of Transparency.OPAQUE, // * Transparency.BITMASK, // * or Transparency.TRANSLUCENT // * depending on the arguments, as specified // * in the class description above. // * The transfer type must be one of DataBuffer.TYPE_BYTE // * DataBuffer.TYPE_USHORT. // * The BigInteger object specifies the valid/invalid pixels // * in the cmap array. A pixel is valid if the // * BigInteger value at that index is set, and is invalid // * if the BigInteger bit at that index is not set. // * @param bits the number of bits each pixel occupies // * @param size the size of the color component array // * @param cmap the array of color components // * @param start the starting offset of the first color component // * @param transferType the specified data type // * @param validBits a BigInteger object. If a bit is // * set in the BigInteger, the pixel at that index is valid. // * If a bit is not set, the pixel at that index // * is considered invalid. If null, all pixels are valid. // * Only bits from 0 to the map size are considered. // * @throws IllegalArgumentException if bits is less // * than 1 or greater than 16 // * @throws IllegalArgumentException if size is less // * than 1 // * @throws IllegalArgumentException if transferType is not // * one of DataBuffer.TYPE_BYTE or // * DataBuffer.TYPE_USHORT // * // */ // public IndexColorModel(int bits, int size, int[] cmap, int start, int // transferType, BigInteger validBits) // { } // /** // * Returns the transparency. Returns either OPAQUE, BITMASK, // * or TRANSLUCENT // * @return the transparency of this IndexColorModel // * @see Transparency#OPAQUE // * @see Transparency#BITMASK // * @see Transparency#TRANSLUCENT // */ // public int getTransparency() { } // // /** // * Returns an array of the number of bits for each color/alpha component. // * The array contains the color components in the order red, green, // * blue, followed by the alpha component, if present. // * @return an array containing the number of bits of each color // * and alpha component of this IndexColorModel // */ // public int[] getComponentSize() { } // /** * Returns the size of the color/alpha component arrays in this * IndexColorModel. * @return the size of the color and alpha component arrays. */ public final int getMapSize() { return 0; } /** * Returns the index of the transparent pixel in this * IndexColorModel or -1 if there is no transparent pixel. * @return the index of this IndexColorModel object's * transparent pixel, or -1 if there is no such pixel. */ public final int getTransparentPixel() { return 0; } /** * Copies the array of red color components into the specified array. * Only the initial entries of the array as specified by * {@link #getMapSize() getMapSize} are written. * @param r the specified array into which the elements of the * array of red color components are copied */ public final void getReds(byte[] r) { } /** * Copies the array of green color components into the specified array. * Only the initial entries of the array as specified by * getMapSize are written. * @param g the specified array into which the elements of the * array of green color components are copied */ public final void getGreens(byte[] g) { } /** * Copies the array of blue color components into the specified array. * Only the initial entries of the array as specified by * getMapSize are written. * @param b the specified array into which the elements of the * array of blue color components are copied */ public final void getBlues(byte[] b) { } /** * Copies the array of alpha transparency components into the * specified array. Only the initial entries of the array as specified * by getMapSize are written. * @param a the specified array into which the elements of the * array of alpha components are copied */ public final void getAlphas(byte[] a) { } // /** // * Converts data for each index from the color and alpha component // * arrays to an int in the default RGB ColorModel format and copies // * the resulting 32-bit ARGB values into the specified array. Only // * the initial entries of the array as specified by // * getMapSize are // * written. // * @param rgb the specified array into which the converted ARGB // * values from this array of color and alpha components // * are copied. // */ // public final void getRGBs(int[] rgb) { } /** * Returns the red color component for the specified pixel, scaled * from 0 to 255 in the default RGB ColorSpace, sRGB. The pixel value * is specified as an int. The returned value is a * non pre-multiplied value. * @param pixel the specified pixel * @return the value of the red color component for the specified pixel */ public final int getRed(int pixel) { return 0; } /** * Returns the green color component for the specified pixel, scaled * from 0 to 255 in the default RGB ColorSpace, sRGB. The pixel value * is specified as an int. The returned value is a * non pre-multiplied value. * @param pixel the specified pixel * @return the value of the green color component for the specified pixel */ public final int getGreen(int pixel) { return 0; } /** * Returns the blue color component for the specified pixel, scaled * from 0 to 255 in the default RGB ColorSpace, sRGB. The pixel value * is specified as an int. The returned value is a * non pre-multiplied value. * @param pixel the specified pixel * @return the value of the blue color component for the specified pixel */ public final int getBlue(int pixel) { return 0; } /** * Returns the alpha component for the specified pixel, scaled * from 0 to 255. The pixel value is specified as an int. * @param pixel the specified pixel * @return the value of the alpha component for the specified pixel */ public final int getAlpha(int pixel) { return 0; } /** * Returns the color/alpha components of the pixel in the default * RGB color model format. The pixel value is specified as an int. * The returned value is in a non pre-multiplied format. * @param pixel the specified pixel * @return the color and alpha components of the specified pixel * @see ColorModel#getRGBdefault */ public final int getRGB(int pixel) { return 0; } // /** // * Returns a data element array representation of a pixel in this // * ColorModel, given an integer pixel representation in the // * default RGB color model. This array can then be passed to the // * {@link WritableRaster#setDataElements(int, int, java.lang.Object) setDataElements} // * method of a {@link WritableRaster} object. If the pixel variable is // * null, a new array is allocated. If pixel // * is not null, it must be // * a primitive array of type transferType; otherwise, a // * ClassCastException is thrown. An // * ArrayIndexOutOfBoundsException is // * thrown if pixel is not large enough to hold a pixel // * value for this ColorModel. The pixel array is returned. // *

// * Since IndexColorModel can be subclassed, subclasses // * inherit the implementation of this method and if they don't // * override it then they throw an exception if they use an // * unsupported transferType. // * // * @param rgb the integer pixel representation in the default RGB // * color model // * @param pixel the specified pixel // * @return an array representation of the specified pixel in this // * IndexColorModel. // * @throws ClassCastException if pixel // * is not a primitive array of type transferType // * @throws ArrayIndexOutOfBoundsException if // * pixel is not large enough to hold a pixel value // * for this ColorModel // * @throws UnsupportedOperationException if transferType // * is invalid // * @see WritableRaster#setDataElements // * @see SampleModel#setDataElements // */ // public synchronized Object getDataElements(int rgb, Object pixel) { } // /** // * Returns an array of unnormalized color/alpha components for a // * specified pixel in this ColorModel. The pixel value // * is specified as an int. If the components array is null, // * a new array is allocated. The components array is returned. // * Color/alpha components are stored in the components array starting // * at offset even if the array is allocated by this method. // * An ArrayIndexOutOfBoundsException // * is thrown if the components array is not null and is // * not large enough to hold all the color and alpha components // * starting at offset. // * @param pixel the specified pixel // * @param components the array to receive the color and alpha // * components of the specified pixel // * @param offset the offset into the components array at // * which to start storing the color and alpha components // * @return an array containing the color and alpha components of the // * specified pixel starting at the specified offset. // */ // public int[] getComponents(int pixel, int[] components, int offset) { } // /** // * Returns an array of unnormalized color/alpha components for // * a specified pixel in this ColorModel. The pixel // * value is specified by an array of data elements of type // * transferType passed in as an object reference. // * If pixel is not a primitive array of type // * transferType, a ClassCastException // * is thrown. An ArrayIndexOutOfBoundsException // * is thrown if pixel is not large enough to hold // * a pixel value for this ColorModel. If the // * components array is null, a new array // * is allocated. The components array is returned. // * Color/alpha components are stored in the components // * array starting at offset even if the array is // * allocated by this method. An // * ArrayIndexOutOfBoundsException is also // * thrown if the components array is not // * null and is not large enough to hold all the color // * and alpha components starting at offset. // *

// * Since IndexColorModel can be subclassed, subclasses // * inherit the implementation of this method and if they don't // * override it then they throw an exception if they use an // * unsupported transferType. // * // * @param pixel the specified pixel // * @param components an array that receives the color and alpha // * components of the specified pixel // * @param offset the index into the components array at // * which to begin storing the color and alpha components of the // * specified pixel // * @return an array containing the color and alpha components of the // * specified pixel starting at the specified offset. // * @throws ArrayIndexOutOfBoundsException if pixel // * is not large enough to hold a pixel value for this // * ColorModel or if the // * components array is not null // * and is not large enough to hold all the color // * and alpha components starting at offset // * @throws ClassCastException if pixel is not a // * primitive array of type transferType // * @throws UnsupportedOperationException if transferType // * is not one of the supported transer types // */ // public int[] getComponents(Object pixel, int[] components, int offset) { } // /** // * Returns a pixel value represented as an int in this // * ColorModel given an array of unnormalized // * color/alpha components. An // * ArrayIndexOutOfBoundsException // * is thrown if the components array is not large // * enough to hold all of the color and alpha components starting // * at offset. Since // * ColorModel can be subclassed, subclasses inherit the // * implementation of this method and if they don't override it then // * they throw an exception if they use an unsupported transferType. // * @param components an array of unnormalized color and alpha // * components // * @param offset the index into components at which to // * begin retrieving the color and alpha components // * @return an int pixel value in this // * ColorModel corresponding to the specified components. // * @throws ArrayIndexOutOfBoundsException if // * the components array is not large enough to // * hold all of the color and alpha components starting at // * offset // * @throws UnsupportedOperationException if transferType // * is invalid // */ // public int getDataElement(int[] components, int offset) { } // /** // * Returns a data element array representation of a pixel in this // * ColorModel given an array of unnormalized color/alpha // * components. This array can then be passed to the // * setDataElements method of a WritableRaster // * object. An ArrayIndexOutOfBoundsException is // * thrown if the // * components array is not large enough to hold all of the // * color and alpha components starting at offset. // * If the pixel variable is null, a new array // * is allocated. If pixel is not null, // * it must be a primitive array of type transferType; // * otherwise, a ClassCastException is thrown. // * An ArrayIndexOutOfBoundsException is thrown if pixel // * is not large enough to hold a pixel value for this // * ColorModel. // *

// * Since IndexColorModel can be subclassed, subclasses // * inherit the implementation of this method and if they don't // * override it then they throw an exception if they use an // * unsupported transferType // * // * @param components an array of unnormalized color and alpha // * components // * @param offset the index into components at which to // * begin retrieving color and alpha components // * @param pixel the Object representing an array of color // * and alpha components // * @return an Object representing an array of color and // * alpha components. // * @throws ClassCastException if pixel // * is not a primitive array of type transferType // * @throws ArrayIndexOutOfBoundsException if // * pixel is not large enough to hold a pixel value // * for this ColorModel or the components // * array is not large enough to hold all of the color and alpha // * components starting at offset // * @throws UnsupportedOperationException if transferType // * is not one of the supported transer types // * @see WritableRaster#setDataElements // * @see SampleModel#setDataElements // */ // public Object getDataElements(int[] components, int offset, Object pixel) // { } // /** // * Creates a WritableRaster with the specified width // * and height that has a data layout (SampleModel) // * compatible with this ColorModel. This method // * only works for color models with 16 or fewer bits per pixel. // *

// * Since IndexColorModel can be subclassed, any // * subclass that supports greater than 16 bits per pixel must // * override this method. // * // * @param w the width to apply to the new WritableRaster // * @param h the height to apply to the new WritableRaster // * @return a WritableRaster object with the specified // * width and height. // * @throws UnsupportedOperationException if the number of bits in a // * pixel is greater than 16 // * @see WritableRaster // * @see SampleModel // */ // public WritableRaster createCompatibleWritableRaster(int w, int h) { } // // /** // * Returns true if raster is compatible // * with this ColorModel or false if it // * is not compatible with this ColorModel. // * @param raster the {@link Raster} object to test for compatibility // * @return true if raster is compatible // * with this ColorModel; false otherwise. // * // */ // public boolean isCompatibleRaster(Raster raster) { } // // /** // * Creates a SampleModel with the specified // * width and height that has a data layout compatible with // * this ColorModel. // * @param w the width to apply to the new SampleModel // * @param h the height to apply to the new SampleModel // * @return a SampleModel object with the specified // * width and height. // * @throws IllegalArgumentException if w or // * h is not greater than 0 // * @see SampleModel // */ // public SampleModel createCompatibleSampleModel(int w, int h) { } // // /** // * Checks if the specified SampleModel is compatible // * with this ColorModel. If sm is // * null, this method returns false. // * @param sm the specified SampleModel, // * or null // * @return true if the specified SampleModel // * is compatible with this ColorModel; false // * otherwise. // * @see SampleModel // */ // public boolean isCompatibleSampleModel(SampleModel sm) { } // // /** // * Returns a new BufferedImage of TYPE_INT_ARGB or // * TYPE_INT_RGB that has a Raster with pixel data // * computed by expanding the indices in the source Raster // * using the color/alpha component arrays of this ColorModel. // * If forceARGB is true, a TYPE_INT_ARGB image is // * returned regardless of whether or not this ColorModel // * has an alpha component array or a transparent pixel. // * @param raster the specified Raster // * @param forceARGB if true, the returned // * BufferedImage is TYPE_INT_ARGB; otherwise it is // * TYPE_INT_RGB // * @return a BufferedImage created with the specified // * Raster // * @throws IllegalArgumentException if the raster argument is not // * compatible with this IndexColorModel // */ // public BufferedImage convertToIntDiscrete(Raster raster, boolean forceARGB) // { } // // /** // * Returns whether or not the pixel is valid. // * @param pixel the specified pixel value // * @return true if pixel // * is valid; false otherwise. // */ // public boolean isValid(int pixel) { } // // /** // * Returns whether or not all of the pixels are valid. // * @return true if all pixels are valid; // * false otherwise. // */ // public boolean isValid() { } // // /** // * Returns a BigInteger that indicates the valid/invalid // * pixels in the colormap. A bit is valid if the // * BigInteger value at that index is set, and is invalid // * if the BigInteger value at that index is not set. // * The only valid ranges to query in the BigInteger are // * between 0 and the map size. // * @return a BigInteger indicating the valid/invalid pixels. // */ // public BigInteger getValidPixels() { } /** * Disposes of system resources associated with this * ColorModel once this ColorModel is no * longer referenced. */ public void finalize() { } /** * Returns the String representation of the contents of * this ColorModelobject. * @return a String representing the contents of this * ColorModel object. */ public String toString() { return null; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy