Style Intelligence v12.0

inetsoft.graph.aesthetic
Class ColorFrame

java.lang.Object
  extended by inetsoft.graph.aesthetic.VisualFrame
      extended by inetsoft.graph.aesthetic.ColorFrame
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
CategoricalColorFrame, CompositeColorFrame, LinearColorFrame, StaticColorFrame

public abstract class ColorFrame
extends VisualFrame

This class defines the common API for all color frames.

See Also:
Serialized Form

Constructor Summary
ColorFrame()
           
 
Method Summary
 boolean equals(Object obj)
          Check if equals another object.
 double getBrightness()
          Get the brightness adjustment factor.
abstract  Color getColor(DataSet data, String col, int row)
          Get the color for the specified cell.
abstract  Color getColor(Object val)
          Get the color for the specified value.
 boolean isGrayscale()
          Check whether to convert color to grayscale.
protected  Color process(Color c)
          Process the return color to apply any adjustments.
 void setBrightness(double bright)
          Set the brightness.
 void setGrayscale(boolean grayscale)
          Set whether to convert color to grayscale.
 
Methods inherited from class inetsoft.graph.aesthetic.VisualFrame
clone, createComparator, getField, getLabels, getLegendFrame, getLegendSpec, getScale, getScaleOption, getTitle, getValues, hashCode, init, isValid, isVisible, setField, setLegendFrame, setLegendSpec, setScale, setScaleOption, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ColorFrame

public ColorFrame()
Method Detail

getColor

public abstract Color getColor(DataSet data,
                               String col,
                               int row)
Get the color for the specified cell.

Parameters:
data - the specified dataset.
col - the specified column name.
row - the specified row index.

getColor

public abstract Color getColor(Object val)
Get the color for the specified value.


setBrightness

public void setBrightness(double bright)
Set the brightness. The return color is adjusted by multiplying the brightness value. A value of one (1) doesn't change the color.


getBrightness

public double getBrightness()
Get the brightness adjustment factor.


setGrayscale

public void setGrayscale(boolean grayscale)
Set whether to convert color to grayscale.


isGrayscale

public boolean isGrayscale()
Check whether to convert color to grayscale.


process

protected Color process(Color c)
Process the return color to apply any adjustments. This method should be called by the implementation of getColor() before returning a color value.


equals

public boolean equals(Object obj)
Description copied from class: VisualFrame
Check if equals another object. The default implementation will just test whether class is equal.

Overrides:
equals in class VisualFrame

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.