Modifier and Type	Class and Description
public static enum	EscherColorRef.SysIndexProcedure The following enum specifies values that indicate special procedural properties that are used to modify the color components of another color.
public static enum	EscherColorRef.SysIndexSource

Field Summary

Modifier and Type	Field and Description
private int	colorRef
private static final BitField	FLAG_BLUE An unsigned integer that specifies the intensity of the blue color channel.
private static final BitField	FLAG_GREEN An unsigned integer that specifies the intensity of the green color channel.
private static final BitField	FLAG_PALETTE_INDEX A bit that specifies whether the current palette will be used to determine the color.
private static final BitField	FLAG_PALETTE_RGB A bit that specifies whether the current palette will be used to determine the color.
private static final BitField	FLAG_RED An unsigned integer that specifies the intensity of the red color channel.
private static final BitField	FLAG_SCHEME_INDEX A bit that specifies whether the current application-defined color scheme will be used to determine the color.
private static final BitField	FLAG_SYS_INDEX A bit that specifies whether the system color scheme will be used to determine the color.
private static final BitField	FLAG_SYSTEM_RGB A bit that specifies whether the color is a standard RGB color.
private int	opid

Constructor Summary

Access	Constructor and Description
public	EscherColorRef(int colorRef)
public	EscherColorRef(byte[] source, int start, int len)

Method Summary

Modifier and Type	Method and Description
private int	getIndex()
public int	Returns: index of current palette (color) or -1 if `hasPaletteIndexFlag()` is `false` getPaletteIndex()
public int[]	getRGB()
public int	Returns: index of the scheme color or -1 if `hasSchemeIndexFlag()` is `false` getSchemeIndex()
public int	Returns: index of system color table or -1 if `hasSysIndexFlag()` is `false` getSysIndex()
public int	Returns: 0 for no invert flag, 1 for `SysIndexProcedure#INVERT_AFTER` and 2 for `SysIndexProcedure#INVERT_HIGHBIT_AFTER` getSysIndexInvert()
public EscherColorRef.SysIndexProcedure	Returns: `SysIndexProcedure` if `hasSysIndexFlag()` is `true`, otherwise null getSysIndexProcedure() Return the `SysIndexProcedure` - for invert flag use `getSysIndexInvert()`
public EscherColorRef.SysIndexSource	Returns: `SysIndexSource` if `hasSysIndexFlag()` is `true`, otherwise null getSysIndexSource()
public boolean	hasPaletteIndexFlag()
public boolean	hasPaletteRGBFlag()
public boolean	hasSchemeIndexFlag()
public boolean	hasSysIndexFlag()
public boolean	hasSystemRGBFlag()
public void	setPaletteIndexFlag(boolean flag)
public void	setPaletteRGBFlag(boolean flag)
public void	setSchemeIndexFlag(boolean flag)
public void	setSysIndexFlag(boolean flag)
public void	setSystemRGBFlag(boolean flag)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

colorRef	back to summary
private int colorRef

FLAG_BLUE	back to summary
private static final BitField FLAG_BLUE An unsigned integer that specifies the intensity of the blue color channel. A value of 0x00 has the minimum blue intensity. A value of 0xFF has the maximum blue intensity.

FLAG_GREEN	back to summary
private static final BitField FLAG_GREEN An unsigned integer that specifies the intensity of the green color channel. A value of 0x00 has the minimum green intensity. A value of 0xFF has the maximum green intensity.

FLAG_PALETTE_INDEX	back to summary
private static final BitField FLAG_PALETTE_INDEX A bit that specifies whether the current palette will be used to determine the color. A value of 0x1 specifies that green and red will be treated as an unsigned 16-bit index into the current color palette. This color MAY be dithered. If this value is 0x1, blue MUST be 0x00.

FLAG_PALETTE_RGB	back to summary
private static final BitField FLAG_PALETTE_RGB A bit that specifies whether the current palette will be used to determine the color. A value of 0x1 specifies that red, green, and blue contain an RGB value that will be matched in the current color palette. This color MUST be solid.

FLAG_RED	back to summary
private static final BitField FLAG_RED An unsigned integer that specifies the intensity of the red color channel. A value of 0x00 has the minimum red intensity. A value of 0xFF has the maximum red intensity.

FLAG_SCHEME_INDEX	back to summary
private static final BitField FLAG_SCHEME_INDEX A bit that specifies whether the current application-defined color scheme will be used to determine the color. A value of 0x1 specifies that red will be treated as an index into the current color scheme table. If this value is 0x1, green and blue MUST be 0x00.

FLAG_SYS_INDEX	back to summary
private static final BitField FLAG_SYS_INDEX A bit that specifies whether the system color scheme will be used to determine the color. A value of 0x1 specifies that green and red will be treated as an unsigned 16-bit index into the system color table. Values less than 0x00F0 map directly to system colors.

FLAG_SYSTEM_RGB	back to summary
private static final BitField FLAG_SYSTEM_RGB A bit that specifies whether the color is a standard RGB color. 0x0 : The RGB color MAY use halftone dithering to display. 0x1 : The color MUST be a solid color.

opid	back to summary
private int opid Annotations @SuppressWarnings:unused

Constructor Detail

EscherColorRef	back to summary
public EscherColorRef(int colorRef)

EscherColorRef	back to summary
public EscherColorRef(byte[] source, int start, int len)

Method Detail

getIndex	back to summary
private int getIndex()

getPaletteIndex	back to summary
public int getPaletteIndex() Returns:int index of current palette (color) or -1 if `hasPaletteIndexFlag()` is `false`

getRGB	back to summary
public int[] getRGB()

getSchemeIndex	back to summary
public int getSchemeIndex() Returns:int index of the scheme color or -1 if `hasSchemeIndexFlag()` is `false` See Also `org.apache.poi.hslf.record.ColorSchemeAtom#getColor(int)`

getSysIndex	back to summary
public int getSysIndex() Returns:int index of system color table or -1 if `hasSysIndexFlag()` is `false` See Also `org.apache.poi.sl.usermodel.PresetColor`

getSysIndexInvert	back to summary
public int getSysIndexInvert() Returns:int 0 for no invert flag, 1 for `SysIndexProcedure#INVERT_AFTER` and 2 for `SysIndexProcedure#INVERT_HIGHBIT_AFTER`

getSysIndexProcedure back to summary

getSysIndexProcedure	back to summary
public EscherColorRef.SysIndexProcedure getSysIndexProcedure() Return the `SysIndexProcedure` - for invert flag use `getSysIndexInvert()` Returns:EscherColorRef.SysIndexProcedure `SysIndexProcedure` if `hasSysIndexFlag()` is `true`, otherwise null

public EscherColorRef.SysIndexProcedure getSysIndexProcedure()

Return the SysIndexProcedure - for invert flag use getSysIndexInvert()

Returns:EscherColorRef.SysIndexProcedure: SysIndexProcedure if hasSysIndexFlag() is true, otherwise null

getSysIndexSource	back to summary
public EscherColorRef.SysIndexSource getSysIndexSource() Returns:EscherColorRef.SysIndexSource `SysIndexSource` if `hasSysIndexFlag()` is `true`, otherwise null

hasPaletteIndexFlag	back to summary
public boolean hasPaletteIndexFlag()

hasPaletteRGBFlag	back to summary
public boolean hasPaletteRGBFlag()

hasSchemeIndexFlag	back to summary
public boolean hasSchemeIndexFlag()

hasSysIndexFlag	back to summary
public boolean hasSysIndexFlag()

hasSystemRGBFlag	back to summary
public boolean hasSystemRGBFlag()

setPaletteIndexFlag	back to summary
public void setPaletteIndexFlag(boolean flag)

setPaletteRGBFlag	back to summary
public void setPaletteRGBFlag(boolean flag)

setSchemeIndexFlag	back to summary
public void setSchemeIndexFlag(boolean flag)

setSysIndexFlag	back to summary
public void setSysIndexFlag(boolean flag)

setSystemRGBFlag	back to summary
public void setSystemRGBFlag(boolean flag)

org.apache.poi.ddf back to summary

public final Enum EscherColorRef.SysIndexProcedure

Class Inheritance

extends Enum<EscherColorRef.SysIndexProcedure>

java.lang.Object
java.lang.Enum
org.apache.poi.ddf.EscherColorRef.SysIndexProcedure

The following enum specifies values that indicate special procedural properties that are used to modify the color components of another color. These values are combined with those of the SysIndexSource enum or with a user-specified color. The first six values are mutually exclusive.

Field Summary

Modifier and Type	Field and Description
public static final EscherColorRef.SysIndexProcedure	ADD_GRAY_LEVEL Add a gray level RGB value.
public static final EscherColorRef.SysIndexProcedure	DARKEN_COLOR Darken the color by the value that is specified in the blue field.
public static final EscherColorRef.SysIndexProcedure	INVERT_AFTER After making other modifications, invert the color.
public static final EscherColorRef.SysIndexProcedure	INVERT_HIGHBIT_AFTER After making other modifications, invert the color by toggling just the high bit of each color channel.
public static final EscherColorRef.SysIndexProcedure	LIGHTEN_COLOR Lighten the color by the value that is specified in the blue field.
private BitField	mask
public static final EscherColorRef.SysIndexProcedure	REVERSE_GRAY_LEVEL Reverse-subtract a gray level RGB value.
public static final EscherColorRef.SysIndexProcedure	SUB_GRAY_LEVEL Subtract a gray level RGB value.
public static final EscherColorRef.SysIndexProcedure	THRESHOLD If the color component being modified is less than the parameter contained in the blue field, set it to the minimum intensity.

Constructor Summary

Access	Constructor and Description
private	SysIndexProcedure(int mask)

Method Summary

Modifier and Type	Method and Description
public static EscherColorRef.SysIndexProcedure	valueOf(String name)
public static EscherColorRef.SysIndexProcedure[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ADD_GRAY_LEVEL	back to summary
public static final EscherColorRef.SysIndexProcedure ADD_GRAY_LEVEL Add a gray level RGB value. The blue field contains the gray level to add: NewColor = SourceColor + gray

DARKEN_COLOR	back to summary
public static final EscherColorRef.SysIndexProcedure DARKEN_COLOR Darken the color by the value that is specified in the blue field. A blue value of 0xFF specifies that the color is to be left unchanged, whereas a blue value of 0x00 specifies that the color is to be completely darkened.

INVERT_AFTER	back to summary
public static final EscherColorRef.SysIndexProcedure INVERT_AFTER After making other modifications, invert the color. This enum value is only for documentation and won't be directly returned.

INVERT_HIGHBIT_AFTER	back to summary
public static final EscherColorRef.SysIndexProcedure INVERT_HIGHBIT_AFTER After making other modifications, invert the color by toggling just the high bit of each color channel. This enum value is only for documentation and won't be directly returned.

LIGHTEN_COLOR	back to summary
public static final EscherColorRef.SysIndexProcedure LIGHTEN_COLOR Lighten the color by the value that is specified in the blue field. A blue value of 0xFF specifies that the color is to be left unchanged, whereas a blue value of 0x00 specifies that the color is to be completely lightened.

mask	back to summary
private BitField mask

REVERSE_GRAY_LEVEL	back to summary
public static final EscherColorRef.SysIndexProcedure REVERSE_GRAY_LEVEL Reverse-subtract a gray level RGB value. The blue field contains the gray level from which to subtract: NewColor = gray - SourceColor

SUB_GRAY_LEVEL	back to summary
public static final EscherColorRef.SysIndexProcedure SUB_GRAY_LEVEL Subtract a gray level RGB value. The blue field contains the gray level to subtract: NewColor = SourceColor - gray

THRESHOLD	back to summary
public static final EscherColorRef.SysIndexProcedure THRESHOLD If the color component being modified is less than the parameter contained in the blue field, set it to the minimum intensity. If the color component being modified is greater than or equal to the parameter, set it to the maximum intensity.

Constructor Detail

SysIndexProcedure	back to summary
private SysIndexProcedure(int mask)

Method Detail

valueOf	back to summary
public static EscherColorRef.SysIndexProcedure valueOf(String name)

values	back to summary
public static EscherColorRef.SysIndexProcedure[] values()

org.apache.poi.ddf back to summary

public final Enum EscherColorRef.SysIndexSource

Class Inheritance

extends Enum<EscherColorRef.SysIndexSource>

java.lang.Object
java.lang.Enum
org.apache.poi.ddf.EscherColorRef.SysIndexSource

Field Summary

Modifier and Type	Field and Description
public static final EscherColorRef.SysIndexSource	CURRENT_OR_LAST_COLOR Use the current, or last-used, color.
public static final EscherColorRef.SysIndexSource	FILL_BACKGROUND_COLOR Use the fill background color of the shape.
public static final EscherColorRef.SysIndexSource	FILL_COLOR Use the fill color of the shape.
public static final EscherColorRef.SysIndexSource	FILL_OR_LINE_COLOR If the shape contains a fill, use the fill color of the shape.
public static final EscherColorRef.SysIndexSource	LINE_BACKGROUND_COLOR Use the line background color of the shape.
public static final EscherColorRef.SysIndexSource	LINE_COLOR Use the line color of the shape.
public static final EscherColorRef.SysIndexSource	LINE_OR_FILL_COLOR If the shape contains a line, use the line color of the shape.
public static final EscherColorRef.SysIndexSource	SHADOW_COLOR Use the shadow color of the shape.
private int	value

Constructor Summary

Access	Constructor and Description
private	SysIndexSource(int value)

Method Summary

Modifier and Type	Method and Description
public static EscherColorRef.SysIndexSource	valueOf(String name)
public static EscherColorRef.SysIndexSource[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CURRENT_OR_LAST_COLOR	back to summary
public static final EscherColorRef.SysIndexSource CURRENT_OR_LAST_COLOR Use the current, or last-used, color.

FILL_BACKGROUND_COLOR	back to summary
public static final EscherColorRef.SysIndexSource FILL_BACKGROUND_COLOR Use the fill background color of the shape.

FILL_COLOR	back to summary
public static final EscherColorRef.SysIndexSource FILL_COLOR Use the fill color of the shape.

FILL_OR_LINE_COLOR	back to summary
public static final EscherColorRef.SysIndexSource FILL_OR_LINE_COLOR If the shape contains a fill, use the fill color of the shape. Otherwise, use the line color.

LINE_BACKGROUND_COLOR	back to summary
public static final EscherColorRef.SysIndexSource LINE_BACKGROUND_COLOR Use the line background color of the shape.

LINE_COLOR	back to summary
public static final EscherColorRef.SysIndexSource LINE_COLOR Use the line color of the shape.

LINE_OR_FILL_COLOR	back to summary
public static final EscherColorRef.SysIndexSource LINE_OR_FILL_COLOR If the shape contains a line, use the line color of the shape. Otherwise, use the fill color.

SHADOW_COLOR	back to summary
public static final EscherColorRef.SysIndexSource SHADOW_COLOR Use the shadow color of the shape.

value	back to summary
private int value

Constructor Detail

SysIndexSource	back to summary
private SysIndexSource(int value)

Method Detail

valueOf	back to summary
public static EscherColorRef.SysIndexSource valueOf(String name)

values	back to summary
public static EscherColorRef.SysIndexSource[] values()

public Class EscherColorRef

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum EscherColorRef.SysIndexProcedure

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum EscherColorRef.SysIndexSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail