com.aspose.imaging

Class ColorPalette

java.lang.Object

com.aspose.imaging.ColorPalette

All Implemented Interfaces:

IColorPalette

public final class ColorPalette
extends Object
implements IColorPalette

Defines an array of colors that make up a color palette. The colors are 32-bit ARGB colors. Not inheritable.

Constructor Summary

Constructors

Constructor and Description
ColorPalette(Color[] entries) Initializes a new instance of the ColorPalette class and IsCompactPalette is false.
ColorPalette(Color[] entries, boolean isCompactPalette) Initializes a new instance of the ColorPalette class.
ColorPalette(int[] argb32Entries) Initializes a new instance of the ColorPalette class and IsCompactPalette is false.
ColorPalette(int[] argb32Entries, boolean isCompactPalette) Initializes a new instance of the ColorPalette class.

Method Summary

Modifier and Type	Method and Description
static ColorPalette	copyPalette(IColorPalette colorPalette) Copies the palette.
static ColorPalette	copyPalette(IColorPalette colorPalette, boolean useCompactPalette) Copies the palette.
int	getArgb32Color(int index) Gets the 32-bit ARGB palette color by index.
int[]	getArgb32Entries() Gets an array of 32-bit ARGB structures.
Color	getColor(int index) Gets the palette color by index.
Color[]	getEntries() Gets an array of com.aspose.imaging.Color structures.
int	getEntriesCount() Gets the entries count.
int	getNearestColorIndex(Color color) Gets the index of the nearest color.
int	getNearestColorIndex(int argb32Color) Gets the index of the nearest color.
boolean	isCompactPalette() Gets or sets a value indicating whether compact palette is used.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColorPalette

public ColorPalette(int[] argb32Entries,
                    boolean isCompactPalette)

Initializes a new instance of the ColorPalette class.

Parameters:

argb32Entries - The 32-bit ARGB color palette entries.

isCompactPalette - Indicating whether compact it palette.

ColorPalette

public ColorPalette(int[] argb32Entries)

Initializes a new instance of the ColorPalette class and IsCompactPalette is false.

Parameters:

argb32Entries - The 32-bit ARGB color palette entries.

ColorPalette

public ColorPalette(Color[] entries,
                    boolean isCompactPalette)

Initializes a new instance of the ColorPalette class.

Parameters:

entries - The color palette entries.

isCompactPalette - Indicating whether compact it palette.

ColorPalette

public ColorPalette(Color[] entries)

Initializes a new instance of the ColorPalette class and IsCompactPalette is false.

Parameters:

entries - The color palette entries.

Method Detail

getEntriesCount

public int getEntriesCount()

Gets the entries count.

Specified by:

getEntriesCount in interface IColorPalette

Returns:

The entries count.

getArgb32Entries

public int[] getArgb32Entries()

Gets an array of 32-bit ARGB structures.

Specified by:

getArgb32Entries in interface IColorPalette

Returns:

The entries. The copy of array of the 32-bit ARGB values that make up this ColorPalette.

getEntries

public Color[] getEntries()

Gets an array of com.aspose.imaging.Color structures.

Specified by:

getEntries in interface IColorPalette

Returns:

The entries. The copy of array of the Color structures that make up this ColorPalette.

isCompactPalette

public boolean isCompactPalette()

Gets or sets a value indicating whether compact palette is used.

Specified by:

isCompactPalette in interface IColorPalette

Returns:

true if compact palette is used; otherwise, false.

Compact palette means that image will contain only the specified palette entries if possible or in other words the image will be more compact and occupy less space; otherwise there will be 2^BitsPerPixel entries and image will reserve more space for all possible palette entries. Setting this value to true and changing palette entries may cause performance penalty since data movement may occur so use it carefully.

copyPalette

public static ColorPalette copyPalette(IColorPalette colorPalette,
                                       boolean useCompactPalette)

Copies the palette.

Parameters:

colorPalette - The color palette.

useCompactPalette - Indicating whether compact palette.

Returns:

The newly created and copied palette or null if null palette passed.

copyPalette

public static ColorPalette copyPalette(IColorPalette colorPalette)

Copies the palette.

Parameters:

colorPalette - The color palette.

Returns:

The newly created and copied palette or null if null palette passed.

getNearestColorIndex

public int getNearestColorIndex(int argb32Color)

Gets the index of the nearest color.

Specified by:

getNearestColorIndex in interface IColorPalette

Parameters:

argb32Color - The 32-bit ARGB color.

Returns:

The index of the nearest color.

getNearestColorIndex

public int getNearestColorIndex(Color color)

Gets the index of the nearest color.

Specified by:

getNearestColorIndex in interface IColorPalette

Parameters:

color - The color.

Returns:

The index of the nearest color.

getArgb32Color

public int getArgb32Color(int index)

Gets the 32-bit ARGB palette color by index.

Specified by:

getArgb32Color in interface IColorPalette

Parameters:

index - The 32-bit ARGB palette color index.

Returns:

The color palette entry specified by the index.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - if color palette index specified is out of the palette entries range.

getColor

public Color getColor(int index)

Gets the palette color by index.

Specified by:

getColor in interface IColorPalette

Parameters:

index - The palette color index.

Returns:

The color palette entry specified by the index.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - if color palette index specified is out of the palette entries range.