IltColorModifier.MultiColor (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.tgo.grprim.IltColorModifier
- - ilog.tgo.grprim.IltColorModifier.MultiColor

Enclosing class:

IltColorModifier
```
public static class IltColorModifier.MultiColor
extends IltColorModifier
```
This class is a color modifier that produces a green representation, when the value is below 0.5, a yellow representation when the value is below 0.75, and a red representation when the value is above 0.75.
Note: The foreground color is only modified if it is red, green or blue.

Nested Class Summary
- Nested classes/interfaces inherited from class ilog.tgo.grprim.IltColorModifier
  IltColorModifier.MultiColor, IltColorModifier.Shade

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BLUE` The blue color is modified.
`static int`	`GREEN` The green color is modified.
`static int`	`RED` The red color is modified.
`static int`	`USE_BAR_VALUE` The relevant value is the current bar value.
`static int`	`USE_LAST_VALUE` The relevant value is the last value of the chart.
`static int`	`USE_MAX_VALUE` The relevant value is the maximum value of the chart.
`static int`	`USE_PIXEL_VALUE` The relevant value is the current pixel value.

Fields inherited from class ilog.tgo.grprim.IltColorModifier
Standard

Constructor Summary

Constructors
Constructor and Description
`MultiColor()` Creates a new color modifier.
`MultiColor(int relevantValue)` Creates a new color modifier.
`MultiColor(int relevantValue, int modifiedColor)` Creates a new color modifier.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getRelevantValue()` Returns the value that is used as the color threshold.
`int`	`modify(int backgroundColor, int foregroundColor, IltColorModifierContext context)` This method is invoked for each animated pixel of the gauge or chart.
`void`	`setModifiedColor(int modifiedColor)` Sets the color to be modified.
`void`	`setRelevantValue(int relevantValue)` Sets the relevant value used to modify the current color.

Methods inherited from class ilog.tgo.grprim.IltColorModifier
Blue, Color, compose, Green, Red, UseForegroundColor

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

- Field Detail
  - USE_PIXEL_VALUE
```
public static final int USE_PIXEL_VALUE
```
    The relevant value is the current pixel value.
    
    See Also:
    
    Constant Field Values
  - USE_BAR_VALUE
```
public static final int USE_BAR_VALUE
```
    The relevant value is the current bar value.
    
    See Also:
    
    Constant Field Values
  - USE_LAST_VALUE
```
public static final int USE_LAST_VALUE
```
    The relevant value is the last value of the chart.
    
    See Also:
    
    Constant Field Values
  - USE_MAX_VALUE
```
public static final int USE_MAX_VALUE
```
    The relevant value is the maximum value of the chart.
    
    See Also:
    
    Constant Field Values
  - RED
```
public static final int RED
```
    The red color is modified.
    
    See Also:
    
    Constant Field Values
  - GREEN
```
public static final int GREEN
```
    The green color is modified.
    
    See Also:
    
    Constant Field Values
  - BLUE
```
public static final int BLUE
```
    The blue color is modified.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MultiColor
```
public MultiColor(int relevantValue)
```
    Creates a new color modifier.
    The foreground color is modified if it is red, green or blue. This constructor is equivalent to using new MultiColor(relevantValue,MultiColor.RED && MultiColor.GREEN && MultiColor.BLUE);.
    Parameters:
    relevantValue - The value to be used as the color threshold. This parameter can be:
    
    USE_PIXEL_VALUE,
    USE_BAR_VALUE,
    USE_LAST_VALUE, or
    USE_MAX_VALUE.
    See Also:
    
    USE_PIXEL_VALUE, USE_BAR_VALUE, USE_LAST_VALUE, USE_MAX_VALUE
  - MultiColor
```
public MultiColor(int relevantValue,
                  int modifiedColor)
```
    Creates a new color modifier.
    The foreground color is modified if it is red, green or blue according to the modifiedColor flag.
    Parameters:
    relevantValue - The value to be used as the color threshold. This parameter can be:
    
    USE_PIXEL_VALUE,
    USE_BAR_VALUE,
    USE_LAST_VALUE, or
    USE_MAX_VALUE.
    modifiedColor - The color to be modified. This parameter can be: RED, GREEN, BLUE, or more than one combined using &.
    
    See Also:
    
    RED, GREEN, BLUE, USE_PIXEL_VALUE, USE_BAR_VALUE, USE_LAST_VALUE, USE_MAX_VALUE
  - MultiColor
```
public MultiColor()
```
    Creates a new color modifier. The foreground color is modified if it is red, green or blue. Calling this constructor is equivalent to using new MultiColor(USE_PIXEL_VALUE,MultiColor.RED && MultiColor.GREEN && MultiColor.BLUE);.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    USE_PIXEL_VALUE, USE_BAR_VALUE, USE_LAST_VALUE, USE_MAX_VALUE
- Method Detail
  - setRelevantValue
```
public final void setRelevantValue(int relevantValue)
```
    Sets the relevant value used to modify the current color.
    Parameters:
    relevantValue - The value to be used as the color threshold. This parameter can be one of the following:
    
    USE_PIXEL_VALUE
    
    USE_BAR_VALUE
    
    USE_LAST_VALUE
    
    USE_MAX_VALUE
    Since:
    
    JViews 8.1
  - getRelevantValue
```
public final int getRelevantValue()
```
    Returns the value that is used as the color threshold. This value can be one of the following:
    - USE_PIXEL_VALUE
    - USE_BAR_VALUE
    - USE_LAST_VALUE
    - USE_MAX_VALUE
    Since:
    
    JViews 8.1
  - setModifiedColor
```
public void setModifiedColor(int modifiedColor)
```
    Sets the color to be modified. The color can be one of the following:
    - RED
    - GREEN
    - BLUE
    - more than one of these colors combined using the AND (&) operator.
    Parameters:
    
    modifiedColor - The color to be modified.
    
    Since:
    
    JViews 8.1
  - modify
```
public int modify(int backgroundColor,
                  int foregroundColor,
                  IltColorModifierContext context)
```
    Description copied from class: IltColorModifier
    
    This method is invoked for each animated pixel of the gauge or chart. Any color can be returned. The color format is the default RGB color model. The format for the RGB values is an integer with 8 bits each of alpha, red, green, and blue color components ordered correspondingly from the most significant byte to the least significant byte, as in: 0xAARRGGBB. Color components are not premultiplied by the alpha component. This format does not necessarily represent the native nor the most efficient ColorModel for a particular device or for all images. It is merely used as a common color model format.
    This method is supposed to be overridden to implement the appropriate color modification.
    
    Specified by:
    
    modify in class IltColorModifier
    
    Parameters:
    
    backgroundColor - The background color of the chart for this pixel.
    
    foregroundColor - The foreground color of the chart for this pixel.
    
    context - The context for this pixel.
    
    See Also:
    
    ColorModel.getRGBdefault(), IltColorModifierContext

Class IltColorModifier.MultiColor

Nested Class Summary

Nested classes/interfaces inherited from class ilog.tgo.grprim.IltColorModifier

Field Summary

Fields inherited from class ilog.tgo.grprim.IltColorModifier

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.grprim.IltColorModifier

Methods inherited from class java.lang.Object

Field Detail

USE_PIXEL_VALUE

USE_BAR_VALUE

USE_LAST_VALUE

USE_MAX_VALUE

RED

GREEN

BLUE

Constructor Detail

MultiColor

MultiColor

MultiColor

Method Detail

setRelevantValue

getRelevantValue

setModifiedColor

modify