ColorFormat

Inheritance: java.lang.Object, com.aspose.slides.PVIObject

All Implemented Interfaces: com.aspose.slides.IColorFormat

public final class ColorFormat extends PVIObject implements IColorFormat

Represents a color used in a presentation.

Methods

Method	Description
getColorType()	Returns or sets the color definition method.
setColorType(int value)	Returns or sets the color definition method.
getColor()	Returns resulting color (with all color transformations applied).
setColor(Color value)	Returns resulting color (with all color transformations applied).
getPresetColor()	Returns or sets the color preset.
setPresetColor(int value)	Returns or sets the color preset.
getSystemColor()	Returns or sets the color identified by the system color table.
setSystemColor(int value)	Returns or sets the color identified by the system color table.
getSchemeColor()	Returns or sets the color identified by a color scheme.
setSchemeColor(int value)	Returns or sets the color identified by a color scheme.
getR()	Returns or sets the red component of a color.
setR(byte value)	Returns or sets the red component of a color.
getG()	Returns or sets the green component of a color.
setG(byte value)	Returns or sets the green component of a color.
getB()	Returns or sets the blue component of a color.
setB(byte value)	Returns or sets the blue component of a color.
getFloatR()	Returns or sets the red component of a color.
setFloatR(float value)	Returns or sets the red component of a color.
getFloatG()	Returns or sets the green component of a color.
setFloatG(float value)	Returns or sets the green component of a color.
getFloatB()	Returns or sets the blue component of a color.
setFloatB(float value)	Returns or sets the blue component of a color.
getHue()	Returns or sets the hue component of a color in HSL representation.
setHue(float value)	Returns or sets the hue component of a color in HSL representation.
getSaturation()	Returns or sets the saturation component of a color in HSL representation.
setSaturation(float value)	Returns or sets the saturation component of a color in HSL representation.
getLuminance()	Returns or sets the luminance component of a color in HSL representation.
setLuminance(float value)	Returns or sets the luminance component of a color in HSL representation.
getColorTransform()	Returns the collection of color transformations applied to a color.
toString(int format)	Returns a String that represents the current color format.
copyFrom(IColorFormat color)	Copy color format from “color”.
equals(Object obj)	Checks for equality with specified object.
hashCode()	Returns hash code.
getVersion()
getParent_ISlideComponent()
getParent_IPresentationComponent()

getColorType()

public final int getColorType()

Returns or sets the color definition method. Read/write ColorType.

Returns: int

setColorType(int value)

public final void setColorType(int value)

Returns or sets the color definition method. Read/write ColorType.

Parameters:

Parameter	Type	Description
value	int

getColor()

public final Color getColor()

Returns resulting color (with all color transformations applied). Sets RGB colors and clears all color transformations. Read/write java.awt.Color.

Returns: java.awt.Color

setColor(Color value)

public final void setColor(Color value)

Returns resulting color (with all color transformations applied). Sets RGB colors and clears all color transformations. Read/write java.awt.Color.

Parameters:

Parameter	Type	Description
value	java.awt.Color

getPresetColor()

public final int getPresetColor()

Returns or sets the color preset. Read/write PresetColor.

Returns: int

setPresetColor(int value)

public final void setPresetColor(int value)

Returns or sets the color preset. Read/write PresetColor.

Parameters:

Parameter	Type	Description
value	int

getSystemColor()

public final int getSystemColor()

Returns or sets the color identified by the system color table. Read/write SystemColor.

Returns: int

setSystemColor(int value)

public final void setSystemColor(int value)

Returns or sets the color identified by the system color table. Read/write SystemColor.

Parameters:

Parameter	Type	Description
value	int

getSchemeColor()

public final int getSchemeColor()

Returns or sets the color identified by a color scheme. Read/write SchemeColor.

Returns: int

setSchemeColor(int value)

public final void setSchemeColor(int value)

Returns or sets the color identified by a color scheme. Read/write SchemeColor.

Parameters:

Parameter	Type	Description
value	int

getR()

public final byte getR()

Returns or sets the red component of a color. All color transformations are ignored. Read/write byte .

Returns: byte

setR(byte value)

public final void setR(byte value)

Returns or sets the red component of a color. All color transformations are ignored. Read/write byte .

Parameters:

Parameter	Type	Description
value	byte

getG()

public final byte getG()

Returns or sets the green component of a color. All color transformations are ignored.

Returns: byte

setG(byte value)

public final void setG(byte value)

Returns or sets the green component of a color. All color transformations are ignored.

Parameters:

Parameter	Type	Description
value	byte

getB()

public final byte getB()

Returns or sets the blue component of a color. All color transformations are ignored. Read/write byte .

Returns: byte

setB(byte value)

public final void setB(byte value)

Returns or sets the blue component of a color. All color transformations are ignored. Read/write byte .

Parameters:

Parameter	Type	Description
value	byte

getFloatR()

public final float getFloatR()

Returns or sets the red component of a color. All color transformations are ignored. Read/write float .

Returns: float

setFloatR(float value)

public final void setFloatR(float value)

Returns or sets the red component of a color. All color transformations are ignored. Read/write float .

Parameters:

Parameter	Type	Description
value	float

getFloatG()

public final float getFloatG()

Returns or sets the green component of a color. All color transformations are ignored. Read/write float .

Returns: float

setFloatG(float value)

public final void setFloatG(float value)

Returns or sets the green component of a color. All color transformations are ignored. Read/write float .

Parameters:

Parameter	Type	Description
value	float

getFloatB()

public final float getFloatB()

Returns or sets the blue component of a color. All color transformations are ignored. Read/write float .

Returns: float

setFloatB(float value)

public final void setFloatB(float value)

Returns or sets the blue component of a color. All color transformations are ignored. Read/write float .

Parameters:

Parameter	Type	Description
value	float

getHue()

public final float getHue()

Returns or sets the hue component of a color in HSL representation. All color transformations are ignored. Read/write float .

Returns: float

setHue(float value)

public final void setHue(float value)

Returns or sets the hue component of a color in HSL representation. All color transformations are ignored. Read/write float .

Parameters:

Parameter	Type	Description
value	float

getSaturation()

public final float getSaturation()

Returns or sets the saturation component of a color in HSL representation. All color transformations are ignored. Read/write float .

Returns: float

setSaturation(float value)

public final void setSaturation(float value)

Returns or sets the saturation component of a color in HSL representation. All color transformations are ignored. Read/write float .

Parameters:

Parameter	Type	Description
value	float

getLuminance()

public final float getLuminance()

Returns or sets the luminance component of a color in HSL representation. All color transformations are ignored. Read/write float .

Returns: float

setLuminance(float value)

public final void setLuminance(float value)

Returns or sets the luminance component of a color in HSL representation. All color transformations are ignored. Read/write float .

Parameters:

Parameter	Type	Description
value	float

getColorTransform()

public final IColorOperationCollection getColorTransform()

Returns the collection of color transformations applied to a color. Read-only IColorOperationCollection.

Returns: IColorOperationCollection

toString(int format)

public final String toString(int format)

Returns a String that represents the current color format.

Parameters:

Parameter	Type	Description
format	int	A type of color string format.

Returns: java.lang.String - A string that represents the current color format.

copyFrom(IColorFormat color)

public final void copyFrom(IColorFormat color)

Copy color format from “color”.

Parameters:

Parameter	Type	Description
color	IColorFormat

equals(Object obj)

public boolean equals(Object obj)

Checks for equality with specified object.

Parameters:

Parameter	Type	Description
obj	java.lang.Object	Object.

Returns: boolean - True if objects are equal, otherwise false.

hashCode()

public int hashCode()

Returns hash code.

Returns: int - Hash code.

getVersion()

public long getVersion()

Version. Read-only long.

Returns: long

getParent_ISlideComponent()

public final ISlideComponent getParent_ISlideComponent()

Returns: ISlideComponent

getParent_IPresentationComponent()

public final IPresentationComponent getParent_IPresentationComponent()

Returns parent IPresentationComponent. Read-only IPresentationComponent.

Returns: IPresentationComponent