Oracle Fusion Middleware Java API Reference for Oracle ADF Data Visualization Components
11g Release 1 (11.1.1.1.0)

E12063-02

oracle.adf.view.faces.bi.component.geoMap
Class ColorThemeFOI

java.lang.Object
  extended by oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      extended by oracle.adf.view.faces.bi.component.geoMap.ThemeFOI
          extended by oracle.adf.view.faces.bi.component.geoMap.NSDPTheme
              extended by oracle.adf.view.faces.bi.component.geoMap.ColorThemeFOI
All Implemented Interfaces:
javax.faces.component.StateHolder

public class ColorThemeFOI
extends NSDPTheme

This complex attributes class will display a color theme on the map. ADF map uses the value of this theme to color regions on the map.


Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey BUCKETCOUNT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey COLORLIST_KEY
           
static java.lang.String DEFAULT_MAX_COLOR
           
static java.lang.String DEFAULT_MIN_COLOR
           
static int DEFAULT_NUM_BUCKETS
           
static int DEFAULT_OPACITY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LEGENDLABELS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey MAXCOLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey MINCOLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey OPACITY_KEY
           
static java.lang.String THEMETYPE
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
 
Fields inherited from class oracle.adf.view.faces.bi.component.geoMap.NSDPTheme
LOCATIONCOLUMN_KEY, THEMENAME_KEY
 
Fields inherited from class oracle.adf.view.faces.bi.component.geoMap.ThemeFOI
CLICKACTION_KEY, CLICKLISTENER_KEY, INFOWINDOWCALLBACK_KEY, LEFTCLICKBEHAVIOR_KEY, logger, LOGGERCLASS, MAXZOOM_KEY, MENULABEL_KEY, MINZOOM_KEY, RENDERED_KEY, RIGHTCLICKBEHAVIOR_KEY, SELECTIONLISTENER_KEY, SHORTLABEL_KEY, USEWINDOW_KEY, VALUE_KEY, WINDOWHEIGHT_KEY, WINDOWWIDTH_KEY
 
Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY
 
Constructor Summary
ColorThemeFOI()
           
 
Method Summary
 java.util.ArrayList getColorList()
          Return an array list of the color for each bucket in RGB hexadecimal form.
 java.util.ArrayList getColors()
          Hidden
 java.lang.String getInternalThemeType()
          Hidden
 java.util.ArrayList getLegendLabels()
          Return the labels for each bucket in the legend
 java.awt.Color getMaxColor()
          Return the color of the bucket with the largest value
 java.awt.Color getMinColor()
          Return the color of the bucket with the smallest value
 int getNumberOfBucket()
          Return the number of buckets for the colorTheme
 int getOpacity()
          Return the opacity of the theme
 void setColorList(java.util.ArrayList colorList)
          Specifies the color for each bucket.
 void setLegendLabels(java.util.ArrayList legendLabels)
          Specifies the labels for each bucket in the legend.
 void setMaxColor(java.awt.Color maxColor)
          Specifies the color for the bucket with the largest value.
 void setMinColor(java.awt.Color minColor)
          Specifies the color for the bucket with the smallest value.
 void setNumberOfBucket(int numBucket)
          Specifies the number of buckets for the colorTheme.
 void setOpacity(int opacity)
          Specifies the opacity of the color of the theme.
 
Methods inherited from class oracle.adf.view.faces.bi.component.geoMap.NSDPTheme
getLocationColumn, getThemeName, setLocationColumn, setThemeName
 
Methods inherited from class oracle.adf.view.faces.bi.component.geoMap.ThemeFOI
convertLeftClickBehavior, convertRightClickBehavior, getBeanType, getClickAction, getClickListener, getColorFromStyle, getInfoWindowCallback, getLeftClickBehavior, getMaxZoom, getMenuLabel, getMinZoom, getNumberFormat, getProperty, getRightClickBehavior, getSelectionListener, getShortLabel, getThemeClientSideLeftClickBehavior, getThemeClientSideRightClickBehavior, getWindowHeight, getWindowWidth, isLoaded, isNumberFormatSpecified, isRendered, isToolbarVisible, isUseWindow, setClickAction, setClickListener, setInfoWindowCallback, setLeftClickBehavior, setLoaded, setMaxZoom, setMenuLabel, setMinZoom, setNumberFormat, setRendered, setRightClickBehavior, setSelectionListener, setShortLabel, setToolbarVisible, setUseWindow, setWindowHeight, setWindowWidth
 
Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_MAX_COLOR

public static final java.lang.String DEFAULT_MAX_COLOR
See Also:
Constant Field Values

DEFAULT_MIN_COLOR

public static final java.lang.String DEFAULT_MIN_COLOR
See Also:
Constant Field Values

DEFAULT_NUM_BUCKETS

public static final int DEFAULT_NUM_BUCKETS
See Also:
Constant Field Values

DEFAULT_OPACITY

public static final int DEFAULT_OPACITY
See Also:
Constant Field Values

THEMETYPE

public static final java.lang.String THEMETYPE
See Also:
Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

MINCOLOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MINCOLOR_KEY

MAXCOLOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXCOLOR_KEY

BUCKETCOUNT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey BUCKETCOUNT_KEY

OPACITY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey OPACITY_KEY

COLORLIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLORLIST_KEY

LEGENDLABELS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LEGENDLABELS_KEY
Constructor Detail

ColorThemeFOI

public ColorThemeFOI()
Method Detail

setMinColor

public void setMinColor(java.awt.Color minColor)
Specifies the color for the bucket with the smallest value. Valid values are RGB hexadecimal. For example, color="#000000" specifies black color. The default value is #33FF33. This attribute will be ignored if the user specifies a value for colorList. The ADF map uses the value of minColor, maxColor and bucketCount to determine the color for each bucket. For example, if minColor = #000000, maxColor = #ffffff and bucketCount = 5, then the color for the four buckets are: #000000, #444444, #888888, #bbbbbb, #ffffff.

Parameters:
minColor - The color for the bucket with the smallest value.

getMinColor

public java.awt.Color getMinColor()
Return the color of the bucket with the smallest value

Returns:
The color of the bucket with the smallest value

setMaxColor

public void setMaxColor(java.awt.Color maxColor)
Specifies the color for the bucket with the largest value. Valid values are RGB hexadecimal. For example, color="#000000" specifies black color. The default value is #FF3333. This attribute will be ignored if the user specifies a value for colorList. The ADF map uses the value of minColor, maxColor and bucketCount to determine the color for each bucket. For example, if minColor = #000000, maxColor = #ffffff and bucketCount = 5, then the color for the four buckets are: #000000, #444444, #888888, #bbbbbb, #ffffff.

Parameters:
maxColor - The color of the bucket with the largest value

getMaxColor

public java.awt.Color getMaxColor()
Return the color of the bucket with the largest value

Returns:
The color of the bucket with the largest value

setNumberOfBucket

public void setNumberOfBucket(int numBucket)
Specifies the number of buckets for the colorTheme. The ADF map will automatically divide data into a set of buckets based on the value of this attribute. For example, if the data in the theme has a minum value of 10 and a maximum value of 50, and the value of this attribute is 4, then the range for the four buckets will be: 10-20, 20-30, 30-40 and 40-50.

Parameters:
numBucket - The number of buckets for the colorTheme.

getNumberOfBucket

public int getNumberOfBucket()
Return the number of buckets for the colorTheme

Returns:
The number of buckets for the colorTheme

setOpacity

public void setOpacity(int opacity)
Specifies the opacity of the color of the theme. Valid values are 0 to 100. 0 means the color is totally tranparent while 100 means the color is not transparent. The default value is 40.

Parameters:
opacity - The opacity of the theme. Valid value is from 0 to 100.

getOpacity

public int getOpacity()
Return the opacity of the theme

Returns:
The opacity of the theme. Valid value is from 0 to 100

setColorList

public void setColorList(java.util.ArrayList colorList)
Specifies the color for each bucket. Valid values should be an arrayList of String. Color is specified using RGB hexadecimal. For example, red is #FF0000, green is #00FF00 and blue is #0000FF


getColorList

public java.util.ArrayList getColorList()
Return an array list of the color for each bucket in RGB hexadecimal form. For example, #ff0000 for red

Returns:
An array list of color for each bucket in RGB hexadecimal form.

setLegendLabels

public void setLegendLabels(java.util.ArrayList legendLabels)
Specifies the labels for each bucket in the legend.

Parameters:
legendLabels - An array list of String that specifies the label for each bucket in the legend.

getLegendLabels

public java.util.ArrayList getLegendLabels()
Return the labels for each bucket in the legend

Returns:
An arraylist of String that contains the label for each bucket in the legend.

getColors

public java.util.ArrayList getColors()
Hidden

For internal use only. Application developers should not use this

getInternalThemeType

public java.lang.String getInternalThemeType()
Hidden

Specified by:
getInternalThemeType in class ThemeFOI
For internal use only. Application developers should not use this

Oracle Fusion Middleware Java API Reference for Oracle ADF Data Visualization Components
11g Release 1 (11.1.1.1.0)

E12063-02

Copyright © 1997, 2009, Oracle. All rights reserved.