Package org.apache.poi.ddf
Enum Class EscherColorRef.SysIndexProcedure
java.lang.Object
java.lang.Enum<EscherColorRef.SysIndexProcedure>
org.apache.poi.ddf.EscherColorRef.SysIndexProcedure
- All Implemented Interfaces:
Serializable
,Comparable<EscherColorRef.SysIndexProcedure>
,Constable
- Enclosing class:
EscherColorRef
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
EscherColorRef.SysIndexSource
enum or with a user-specified color.
The first six values are mutually exclusive.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAdd a gray level RGB value.Darken the color by the value that is specified in the blue field.After making other modifications, invert the color.After making other modifications, invert the color by toggling just the high bit of each color channel.Lighten the color by the value that is specified in the blue field.Reverse-subtract a gray level RGB value.Subtract a gray level RGB value.If the color component being modified is less than the parameter contained in the blue field, set it to the minimum intensity. -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.static EscherColorRef.SysIndexProcedure[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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. -
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. -
ADD_GRAY_LEVEL
Add a gray level RGB value. The blue field contains the gray level to add: NewColor = SourceColor + gray -
SUB_GRAY_LEVEL
Subtract a gray level RGB value. The blue field contains the gray level to subtract: NewColor = SourceColor - gray -
REVERSE_GRAY_LEVEL
Reverse-subtract a gray level RGB value. The blue field contains the gray level from which to subtract: NewColor = gray - SourceColor -
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. -
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
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.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-