Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.1.0)

E17492-02

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

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

public class UIGeoMapLegend
extends BIComplexAttributeBase

This complex attributes let developers to customize the map legend of a map


Field Summary
static java.lang.String GEOMAPLEGEND_COMPONENT_FAMILY
           
static java.lang.String GEOMAPLEGEND_COMPONENT_TYPE
           
static java.lang.String GEOMAPLEGEND_RENDERER_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey HEIGHT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INITIALSHOWN_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey NUMBEROFCOLUMNS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey POINTTHEMELABEL_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey RENDERED_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY
           
 
Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY
 
Constructor Summary
UIGeoMapLegend()
           
 
Method Summary
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 int getHeight()
          Return the height of the legend
 int getNumberOfColumns()
          Return the number of columns for the legend
 java.lang.String getPointThemeLabel()
          Return the label for the point theme
 int getWidth()
          Return the width of the map legend
 boolean isInitialShown()
          Indicates whether the legend should be shown up initially or not
 boolean isRendered()
          Indicates whether the legend is rendered or not
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setHeight(int height)
          Specifies the height of legend.
 void setInitialShown(boolean isInitialShown)
          Specifies whether the legend should be shown in a popup when the map starts.
 void setNumberOfColumns(int numberOfColumns)
          Specifies the number of columns for the legend of colorTheme.
 void setPointThemeLabel(java.lang.String pointThemeLabel)
          Specifies the label for the point theme.
 void setRendered(boolean bRendered)
          Specifies whether the legend is rendered.
 void setWidth(int width)
          Specifies the width of the legend.
 
Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, 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

GEOMAPLEGEND_COMPONENT_TYPE

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

GEOMAPLEGEND_RENDERER_TYPE

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

GEOMAPLEGEND_COMPONENT_FAMILY

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

TYPE

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

RENDERED_KEY

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

INITIALSHOWN_KEY

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

WIDTH_KEY

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

HEIGHT_KEY

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

POINTTHEMELABEL_KEY

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

NUMBEROFCOLUMNS_KEY

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

UIGeoMapLegend

public UIGeoMapLegend()
Method Detail

setRendered

public void setRendered(boolean bRendered)
Specifies whether the legend is rendered. The default value is true

Parameters:
bRendered - True if the legend is rendered. False, if the legend is hidden

isRendered

public boolean isRendered()
Indicates whether the legend is rendered or not

Returns:
True if the legend is rendered. False, if it is hidden

setWidth

public void setWidth(int width)
Specifies the width of the legend. The default width is 200.

Parameters:
width - The width of the legend dialog.

getWidth

public int getWidth()
Return the width of the map legend

Returns:
The width of the map legend in pixel

setHeight

public void setHeight(int height)
Specifies the height of legend. The default height is 150.

Parameters:
height -

getHeight

public int getHeight()
Return the height of the legend

Returns:
Return the height of the legend in pixel

setPointThemeLabel

public void setPointThemeLabel(java.lang.String pointThemeLabel)
Specifies the label for the point theme. All point themes are shown as one option on the drop down. This attribute let developers to change the label for the point theme. The default value is "Point Theme".

Parameters:
pointThemeLabel - The label for the point Theme

getPointThemeLabel

public java.lang.String getPointThemeLabel()
Return the label for the point theme

Returns:
The label for the point theme

setInitialShown

public void setInitialShown(boolean isInitialShown)
Specifies whether the legend should be shown in a popup when the map starts. The default value is false.

Parameters:
isInitialShown - True if the legend should shown up initially. False, if not.

isInitialShown

public boolean isInitialShown()
Indicates whether the legend should be shown up initially or not

Returns:
True if the legend should be shown up initally. False, otherwise.

setNumberOfColumns

public void setNumberOfColumns(int numberOfColumns)
Specifies the number of columns for the legend of colorTheme. Developers can specify any number of colors for the colorTheme. For example, if a color theme has 15 colors, and the value of this attribute is 3, then the legend will show 5 rows on the legend for the theme, where each row has 3 columns.

Parameters:
numberOfColumns - The number of columns for the legend

getNumberOfColumns

public int getNumberOfColumns()
Return the number of columns for the legend

Returns:
The number of columns for the legend

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class BIComplexAttributeBase

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object stateObj)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class BIComplexAttributeBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Specified by:
getBeanType in class BIComplexAttributeBase

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.1.0)

E17492-02

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