public class ColorFormat extends PVIObject implements IColorFormat
Represents a color used in a presentation.
Modifier and Type | Method and Description |
---|---|
void |
copyFrom(IColorFormat color)
Copy color format from "color".
|
boolean |
equals(java.lang.Object obj)
Checks for equality with specified object.
|
byte |
getB()
Returns or sets the blue component of a color.
|
java.lang.Integer |
getColor()
Returns resulting color (with all color transformations applied).
|
IColorOperationCollection |
getColorTransform()
Returns the collection of color transformations applied to a color.
|
int |
getColorType()
Returns or sets the color definition method.
|
float |
getFloatB()
Returns or sets the blue component of a color.
|
float |
getFloatG()
Returns or sets the green component of a color.
|
float |
getFloatR()
Returns or sets the red component of a color.
|
byte |
getG()
Returns or sets the green component of a color.
|
float |
getHue()
Returns or sets the hue component of a color in HSL representation.
|
float |
getLuminance()
Returns or sets the luminance component of a color in HSL representation.
|
IPresentationComponent |
getParent_IPresentationComponent()
Returns parent IPresentationComponent.
|
ISlideComponent |
getParent_ISlideComponent() |
int |
getPresetColor()
Returns or sets the color preset.
|
byte |
getR()
Returns or sets the red component of a color.
|
float |
getSaturation()
Returns or sets the saturation component of a color in HSL representation.
|
int |
getSchemeColor()
Returns or sets the color identified by a color scheme.
|
int |
getSystemColor()
Returns or sets the color identified by the system color table.
|
int |
hashCode()
Returns hash code.
|
void |
setB(byte value)
Returns or sets the blue component of a color.
|
void |
setColor(java.lang.Integer value)
Returns resulting color (with all color transformations applied).
|
void |
setColorType(int value)
Returns or sets the color definition method.
|
void |
setFloatB(float value)
Returns or sets the blue component of a color.
|
void |
setFloatG(float value)
Returns or sets the green component of a color.
|
void |
setFloatR(float value)
Returns or sets the red component of a color.
|
void |
setG(byte value)
Returns or sets the green component of a color.
|
void |
setHue(float value)
Returns or sets the hue component of a color in HSL representation.
|
void |
setLuminance(float value)
Returns or sets the luminance component of a color in HSL representation.
|
void |
setPresetColor(int value)
Returns or sets the color preset.
|
void |
setR(byte value)
Returns or sets the red component of a color.
|
void |
setSaturation(float value)
Returns or sets the saturation component of a color in HSL representation.
|
void |
setSchemeColor(int value)
Returns or sets the color identified by a color scheme.
|
void |
setSystemColor(int value)
Returns or sets the color identified by the system color table.
|
java.lang.String |
toString(int format)
Returns a
String that represents the current color format. |
getParent_Immediate, getPresentation, getSlide, getVersion, reset_Parent_IPresentationComponent
public final int getColorType()
Returns or sets the color definition method.
Read/write ColorType
.
getColorType
in interface IColorFormat
public final void setColorType(int value)
Returns or sets the color definition method.
Read/write ColorType
.
setColorType
in interface IColorFormat
public final java.lang.Integer getColor()
Returns resulting color (with all color transformations applied).
Sets RGB colors and clears all color transformations.
Read/write Integer
.
getColor
in interface IColorFormat
public final void setColor(java.lang.Integer value)
Returns resulting color (with all color transformations applied).
Sets RGB colors and clears all color transformations.
Read/write Integer
.
setColor
in interface IColorFormat
public final int getPresetColor()
Returns or sets the color preset.
Read/write PresetColor
.
getPresetColor
in interface IColorFormat
public final void setPresetColor(int value)
Returns or sets the color preset.
Read/write PresetColor
.
setPresetColor
in interface IColorFormat
public final int getSystemColor()
Returns or sets the color identified by the system color table.
Read/write SystemColor
.
getSystemColor
in interface IColorFormat
public final void setSystemColor(int value)
Returns or sets the color identified by the system color table.
Read/write SystemColor
.
setSystemColor
in interface IColorFormat
public final int getSchemeColor()
Returns or sets the color identified by a color scheme.
Read/write SchemeColor
.
getSchemeColor
in interface IColorFormat
public final void setSchemeColor(int value)
Returns or sets the color identified by a color scheme.
Read/write SchemeColor
.
setSchemeColor
in interface IColorFormat
public final byte getR()
Returns or sets the red component of a color. All color transformations are ignored.
Read/write byte
.
getR
in interface IColorFormat
public final void setR(byte value)
Returns or sets the red component of a color. All color transformations are ignored.
Read/write byte
.
setR
in interface IColorFormat
public final byte getG()
Returns or sets the green component of a color. All color transformations are ignored.
getG
in interface IColorFormat
public final void setG(byte value)
Returns or sets the green component of a color. All color transformations are ignored.
setG
in interface IColorFormat
public final byte getB()
Returns or sets the blue component of a color. All color transformations are ignored.
Read/write byte
.
getB
in interface IColorFormat
public final void setB(byte value)
Returns or sets the blue component of a color. All color transformations are ignored.
Read/write byte
.
setB
in interface IColorFormat
public final float getFloatR()
Returns or sets the red component of a color. All color transformations are ignored.
Read/write float
.
getFloatR
in interface IColorFormat
public final void setFloatR(float value)
Returns or sets the red component of a color. All color transformations are ignored.
Read/write float
.
setFloatR
in interface IColorFormat
public final float getFloatG()
Returns or sets the green component of a color. All color transformations are ignored.
Read/write float
.
getFloatG
in interface IColorFormat
public final void setFloatG(float value)
Returns or sets the green component of a color. All color transformations are ignored.
Read/write float
.
setFloatG
in interface IColorFormat
public final float getFloatB()
Returns or sets the blue component of a color. All color transformations are ignored.
Read/write float
.
getFloatB
in interface IColorFormat
public final void setFloatB(float value)
Returns or sets the blue component of a color. All color transformations are ignored.
Read/write float
.
setFloatB
in interface IColorFormat
public final float getHue()
Returns or sets the hue component of a color in HSL representation.
All color transformations are ignored.
Read/write float
.
getHue
in interface IColorFormat
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
.
setHue
in interface IColorFormat
public final float getSaturation()
Returns or sets the saturation component of a color in HSL representation.
All color transformations are ignored.
Read/write float
.
getSaturation
in interface IColorFormat
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
.
setSaturation
in interface IColorFormat
public final float getLuminance()
Returns or sets the luminance component of a color in HSL representation.
All color transformations are ignored.
Read/write float
.
getLuminance
in interface IColorFormat
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
.
setLuminance
in interface IColorFormat
public final IColorOperationCollection getColorTransform()
Returns the collection of color transformations applied to a color.
Read-only IColorOperationCollection
.
getColorTransform
in interface IColorFormat
public final java.lang.String toString(int format)
Returns a String
that represents the current color format.
toString
in interface IColorFormat
format
- A type of color string format.public final void copyFrom(IColorFormat color)
Copy color format from "color".
copyFrom
in interface IColorFormat
public boolean equals(java.lang.Object obj)
Checks for equality with specified object.
public int hashCode()
Returns hash code.
public final ISlideComponent getParent_ISlideComponent()
getParent_ISlideComponent
in class PVIObject
public final IPresentationComponent getParent_IPresentationComponent()
Returns parent IPresentationComponent.
Read-only IPresentationComponent
.
getParent_IPresentationComponent
in class PVIObject