Content Engine Java API: ThumbnailImageColor

java.lang.Object
- com.filenet.api.constants.ThumbnailImageColor

All Implemented Interfaces:

java.io.Serializable
```
public final class ThumbnailImageColor
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants for setting the color of images rendered by the thumbnail generation service.
The thumbnail generation service does not convert between color, grayscale, and black and white. It renders a document thumbnail with the color, gray scale, or black and white as found in the input document. Therefore, these constant settings do not impact the output of the thumbnail generation service.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ThumbnailImageColor`	`BLACK_AND_WHITE` Specifies that the input document is rendered as a black and white thumbnail image.
`static int`	`BLACK_AND_WHITE_AS_INT` An `int` value associated with the BLACK_AND_WHITE instance of this class.
`static ThumbnailImageColor`	`COLOR` Specifies that the input document is rendered as a color thumbnail image.
`static int`	`COLOR_AS_INT` An `int` value associated with the COLOR instance of this class.
`static ThumbnailImageColor`	`GRAY_SCALE` Specifies that the input document is rendered as a grayscale thumbnail image.
`static int`	`GRAY_SCALE_AS_INT` An `int` value associated with the GRAY_SCALE instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static ThumbnailImageColor`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - GRAY_SCALE_AS_INT
```
public static final int GRAY_SCALE_AS_INT
```
    An int value associated with the GRAY_SCALE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - GRAY_SCALE
```
public static final ThumbnailImageColor GRAY_SCALE
```
    Specifies that the input document is rendered as a grayscale thumbnail image.
  - BLACK_AND_WHITE_AS_INT
```
public static final int BLACK_AND_WHITE_AS_INT
```
    An int value associated with the BLACK_AND_WHITE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - BLACK_AND_WHITE
```
public static final ThumbnailImageColor BLACK_AND_WHITE
```
    Specifies that the input document is rendered as a black and white thumbnail image.
  - COLOR_AS_INT
```
public static final int COLOR_AS_INT
```
    An int value associated with the COLOR instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - COLOR
```
public static final ThumbnailImageColor COLOR
```
    Specifies that the input document is rendered as a color thumbnail image.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static ThumbnailImageColor getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    See Also:
    getValue()

Methods inherited from class java.lang.Object

GRAY_SCALE_AS_INT

GRAY_SCALE

BLACK_AND_WHITE_AS_INT

BLACK_AND_WHITE

COLOR_AS_INT

COLOR

getValue

toString

getInstanceFromInt