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 UIGeoOverviewMap

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

public class UIGeoOverviewMap
extends BIComplexAttributeBase

This complex attributes let developers to customize the overview map


Field Summary
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 MAPDIFF_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
           
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
UIGeoOverviewMap()
           
 
Method Summary
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 int getHeight()
          Return the height of the overviewMap.
 int getMapDiff()
          Return the scale difference between the map and the overview map
 int getWidth()
          Return the width of the overview Map
 boolean isInitialShown()
          Indicates whether the overview map is expanded initially.
 boolean isVisible()
          Indicates whether the overview map is visible 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 the overviewMap.
 void setInitialShown(boolean bInitialShown)
          Specifies whether the overview map should be expanded when the map is shown.
 void setMapDiff(int mapDiff)
          Specifies the scale difference between the map and the overviewMap.
 void setVisible(boolean bVisible)
          Specifies whether the overview map should be visible.
 void setWidth(int width)
          Specifies the width of the overviewMap.
 
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

TYPE

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

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

MAPDIFF_KEY

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

VISIBLE_KEY

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

INITIALSHOWN_KEY

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

UIGeoOverviewMap

public UIGeoOverviewMap()
Method Detail

setWidth

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

Parameters:
width - The width of the overviewMap in pixel

getWidth

public int getWidth()
Return the width of the overview Map

Returns:
The width of the overviewMap in pixel

setHeight

public void setHeight(int height)
Specifies the height of the overviewMap. The default height is 200.

Parameters:
height - The height of the overviewMap.

getHeight

public int getHeight()
Return the height of the overviewMap.

Returns:
The height of the overviewMap in pixel

setMapDiff

public void setMapDiff(int mapDiff)
Specifies the scale difference between the map and the overviewMap. The default value is 3.

Parameters:
mapDiff - The scale difference between the map and the overview map.

getMapDiff

public int getMapDiff()
Return the scale difference between the map and the overview map

Returns:
The scale difference between the map and the overview map

setVisible

public void setVisible(boolean bVisible)
Specifies whether the overview map should be visible. The default value is true.

Parameters:
bVisible - True if the overview map is visible. False if it is hidden

isVisible

public boolean isVisible()
Indicates whether the overview map is visible or not

Returns:
True if the overview map is visible. False if it is hidden

setInitialShown

public void setInitialShown(boolean bInitialShown)
Specifies whether the overview map should be expanded when the map is shown. The default value is true.

Parameters:
bInitialShown - True if the overview map should be expanded initially. False, if the overview map should be collapsed.

isInitialShown

public boolean isInitialShown()
Indicates whether the overview map is expanded initially.

Returns:
True if the overview map is expanded initially. False if it should be collapsed

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.