TPTP 4.6.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.chart.svg.internal.part
Class SVGColorPalettes

java.lang.Object
  extended by org.eclipse.tptp.platform.report.chart.svg.internal.part.SVGColorPalettes

public class SVGColorPalettes
extends java.lang.Object

SVGColorPalettes is a container that contains a number of Color Palettes. $Revision: 1.3 $


Constructor Summary
SVGColorPalettes(DefaultResources defaultResources, com.ibm.icu.util.ULocale locale)
          Constructor
 
Method Summary
 java.lang.String getDataSetColor(java.lang.String dataSetId)
          Gets the color given a data set ID.
 java.util.HashMap getGraphicColorPalettes()
          Returns the set of color palettes.
 java.lang.String[] getPalette()
          Gets the palette.
 java.lang.String getPaletteColor(int colorIndex)
          Gets a color from the palette given an index
 java.lang.String getPaletteDisplayName()
           
 java.lang.String getPaletteDisplayName(java.lang.String paletteId)
           
 java.lang.String getPaletteId()
          Gets the palette.
 void setCustomPalettes(java.lang.String palettesLocation, java.lang.String paletteId, java.lang.String paletteSetId)
          Load customized palettes from a file.
 void setDataSetColors(java.util.List colorList)
          Assign colors to datasets to override the palettes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SVGColorPalettes

public SVGColorPalettes(DefaultResources defaultResources,
                        com.ibm.icu.util.ULocale locale)
Constructor

Method Detail

getGraphicColorPalettes

public java.util.HashMap getGraphicColorPalettes()
Returns the set of color palettes.

Returns:
HashMap

getPalette

public java.lang.String[] getPalette()
Gets the palette. Use this palette for during generation.

Returns:

getPaletteColor

public java.lang.String getPaletteColor(int colorIndex)
Gets a color from the palette given an index

Parameters:
colorIndex - the index of the color to return
Returns:
the selected color

getPaletteId

public java.lang.String getPaletteId()
Gets the palette. Use this palette for during generation.

Returns:

getPaletteDisplayName

public java.lang.String getPaletteDisplayName()

getPaletteDisplayName

public java.lang.String getPaletteDisplayName(java.lang.String paletteId)

setDataSetColors

public void setDataSetColors(java.util.List colorList)
Assign colors to datasets to override the palettes.

Parameters:
colorList - a list of color for datasets. type of object is DataSetColor

getDataSetColor

public java.lang.String getDataSetColor(java.lang.String dataSetId)
Gets the color given a data set ID.

Parameters:
dataSetId -
Returns:

setCustomPalettes

public void setCustomPalettes(java.lang.String palettesLocation,
                              java.lang.String paletteId,
                              java.lang.String paletteSetId)
Load customized palettes from a file. These palettes are only used for this chart.

Parameters:
palettesLocation -

TPTP 4.6.0 Platform Project
Internal API Specification