Skip navigation links

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

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
oracle.adf.view.faces.bi.component.geoMap.UIGeoMap

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIGeoMap

extends org.apache.myfaces.trinidad.component.UIXComponentBase

implements javax.faces.component.NamingContainer, javax.faces.component.ValueHolder, javax.faces.component.StateHolder, javax.faces.component.ActionSource, javax.faces.component.ActionSource2

ADF Faces Custom component - Map The map supports the display of business data on a geographic map with multiple layers of information as theme. The map supports ColorTheme, BarGraphTheme, PieGraphTheme, PointTheme and Predefined Theme. The example belows show how to retrieve themes, and its data from the UIGeoMap. UIGeoMap m_map; ArrayList themeList = m_map.getThemeList(); if (themeList != null) { for (int i=0; i < themeList.size(); i++) { ThemeFOI theme = (ThemeFOI) themeList.get(i); GeoMapDataModel model = (GeoMapDataModel) theme.getProperty(ThemeFOI.VALUE_KEY); } }

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ACTIVETHEMEID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AUTOZOOMSTRATEGY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AUTOZOOMTHEMEID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BASEMAPNAME_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	COPYRIGHTTEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HYBRIDBASEMAPNAME_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINESTYLE_KEY
protected static oracle.adf.share.logging.ADFLogger	logger
protected static java.lang.String	LOGGERCLASS
protected static java.util.Locale	m_locale
static org.apache.myfaces.trinidad.bean.PropertyKey	MAPCONFIGURATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAPLEGEND_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAPSERVERCONFIGID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAPZOOM_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OVERVIEWMAP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SATELLITEBASEMAPNAME_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTIONFILLCOLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTIONLISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTIONOPACITY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTIONSTROKECOLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWINFOAREA_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWSCALEBAR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SRID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STARTINGX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STARTINGY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLECLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SUMMARY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	THEMELIST_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNIT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ZOOMBARPOSITION_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIGeoMap()

Method Summary

void	addActionListener(javax.faces.event.ActionListener actionListener) For internal use only.
void	broadcast(javax.faces.event.FacesEvent event)
static int	convertUnitToInt(java.lang.String unit) For internal use only.
static int	convertZoomBarPositionToInt(java.lang.String position) For internal use only.
static java.lang.String	convertZoomBarPositionToString(int pos) For internal use only.
static int	convertZoomStrategyToInt(java.lang.String strategy) For internal use only.
void	decode(javax.faces.context.FacesContext context)
protected void	fireEventToAppListener(javax.faces.context.FacesContext context, javax.faces.event.FacesEvent event) For internal use only.
javax.faces.el.MethodBinding	getAction() For internal use only.
javax.el.MethodExpression	getActionExpression() For internal use only.
javax.faces.el.MethodBinding	getActionListener() For internal use only.
javax.faces.event.ActionListener[]	getActionListeners() For internal use only.
ThemeFOI	getActiveTheme() For internal use only.
java.lang.String	getActiveThemeId()
java.lang.Integer	getAutoZoomStrategy() Retrieves the auto zoom strategy.
java.lang.String	getAutoZoomThemeId() Return the id of the theme where the map is bounded to
java.lang.String	getBaseMapName() Return the name of the baseMap for the map
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
oracle.adf.view.rich.event.ClientListenerSet	getClientListeners() Gets a set of client listeners.
javax.faces.convert.Converter	getConverter()
java.lang.String	getCopyrightText() Return the copyright text of the map.
java.lang.String	getCurrentCenterSrid() For internal use only.
java.lang.Double	getCurrentCenterX() For internal use only.
java.lang.Double	getCurrentCenterY() For internal use only.
java.lang.Integer	getCurrentZoom() For internal use only.
java.lang.String	getCustomizationId() Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
java.lang.String	getDataSource() For internal use only.
java.lang.String	getFamily()
java.lang.String	getHybrdBaseMapName() Return the name of the base map of the hybrid image map.
java.lang.String	getInlineStyle() Return the inline style of the map's outer DOM element.
java.lang.Object	getLocalValue() For internal use only.
MapConfiguration	getMapConfig()
UIGeoMapLegend	getMapLegend()
java.lang.String	getMapServerServerConfigId() Return the server configuration id that contains the URL of the map server and the Geocoder
int	getMapZoom() Return the zoom level when the map starts.
UIGeoOverviewMap	getOverviewMap()
java.lang.String[]	getPartialTriggers() Return the ids of the components that should trigger a partial update.
java.lang.String	getRendererType()
java.lang.String	getSatelliteBaseMapName() Return the name of the baseMap for the satellite image map.
java.awt.Color	getSelectionFillColor() Return the fill color of the selected region
javax.el.MethodExpression	getSelectionListener()
int	getSelectionOpacity() Return the opacity of the fill color for the selected region
java.awt.Color	getSelectionStrokeColor() Return the stroke color of the selected region
java.lang.String	getSRID() Return the srid (spatial reference id) of all the coordinates of the map.
double	getStartingX() Return the x coordinate of the center of the map when the map starts.
double	getStartingY() Return the y coordinate of the center of the map when the map starts.
java.lang.String	getStyleClass() Return the CSS style class for this component
java.lang.String	getSummary() Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.
ThemeFOI	getThemeFOIById(java.lang.String themeId) For internal use only.
java.util.ArrayList	getThemeList()
java.lang.Integer	getUnit() Return the unit of measurement for the information area
java.lang.Object	getValue() For internal use only.
java.lang.String	getVisibleBarPieThemeId() For internal use only.
java.lang.String	getVisibleColorThemeId() For internal use only.
java.util.ArrayList	getVisibleThemeList(boolean isToolbar) For internal use only.
int	getZoomBarPosition() Returns the zoombar position
boolean	hasLeftClickPopup() For internal use only.
boolean	hasRightClickPopup() For internal use only.
boolean	isImmediate() For internal use only.
boolean	isLegendInitiallyShown() For internal use only.
boolean	isShowInfoArea() Indicates whether the information area is visible or not
boolean	isShowScaleBar() Indicates whether the scale bar is visible or not
void	queueEvent(javax.faces.event.FacesEvent e)
void	removeActionListener(javax.faces.event.ActionListener actionListener) For internal use only.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj) For internal use only.
java.lang.Object	saveState(javax.faces.context.FacesContext context) For internal use only.
void	setAction(javax.faces.el.MethodBinding action) For internal use only.
void	setActionExpression(javax.el.MethodExpression action) For internal use only.
void	setActionListener(javax.faces.el.MethodBinding methodBinding) For internal use only.
void	setActiveThemeId(java.lang.String activeThemeId)
void	setAutoZoomStrategy(java.lang.Integer strategy) Specifies the auto zoom strategy.
void	setAutoZoomStrategy(java.lang.String strategy) Specifies the auto zoom strategy.
void	setAutoZoomThemeId(java.lang.String autoZoomThemeId) Specifies the id of the theme where the map is bounded to.
void	setBaseMapName(java.lang.String baseMapName) Specifies the name of the baseMap for the map.
void	setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners) Sets a set of client listeners.
void	setConverter(javax.faces.convert.Converter converter)
void	setCopyrightText(java.lang.String copyrightText) Specifies the copyright text of the map.
void	setCurrentCenterSrid(java.lang.String centerSrid) For internal use only.
void	setCurrentCenterX(java.lang.Double centerX) For internal use only.
void	setCurrentCenterY(java.lang.Double centerY) For internal use only.
void	setCurrentZoom(java.lang.Integer curZoom) For internal use only.
void	setCustomizationId(java.lang.String customizationId) Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
void	setHybridBaseMapName(java.lang.String hybridBaseMapName) Specifies the name of the baseMap for the hybrid image map.
void	setImmediate(boolean b) For internal use only.
void	setInlineStyle(java.lang.String inlineStyle) Specifies the inline style of the map's outer DOM element.
void	setMapConfig(MapConfiguration mapConfig)
void	setMapLegend(UIGeoMapLegend mapLegend)
void	setMapServerConfigId(java.lang.String mapServerConfigId) Specifies the server configuration id that contains the URL of the map server and the the Geocoder
void	setMapZoom(int mapZoom) Specifies the beginning zoom level of the map.
void	setOverviewMap(UIGeoOverviewMap overview)
void	setPartialTriggers(java.lang.String[] ids) Specifies the ids of the components that should trigger a partial update.
void	setSatelliteBaseMapName(java.lang.String satelliteBaseMapName) Specifies the name of the baseMap for the satellite image map.
void	setSelectionFillColor(java.awt.Color fillColor) Specifies the fill color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar.
void	setSelectionListener(javax.el.MethodExpression selectionListener)
void	setSelectionOpacity(int opacity) Specifies the opacity of the fill color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar.
void	setSelectionStrokeColor(java.awt.Color strokeColor) Specifies the stroke color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar.
void	setShowInfoArea(boolean showInfoArea) Specifies whether the user can show the information area on the map or not.
void	setShowScaleBar(boolean showScaleBar) Specifies whether to show the scale bar on the map or not.
void	setSRID(java.lang.String srid) Specifies the srid (spatial reference id) of all the coordinates of the map, which includes the center of the map -- which defined by starting X and startingY -- and all the points in the point theme.
void	setStartingX(double x) Specifies the X coordinate of the center of the map when the map starts.
void	setStartingY(double y) Specifies the Y coordinate of the center of the map when the map starts.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component
void	setSummary(java.lang.String summary) Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.
void	setThemeList(java.util.ArrayList themeList)
void	setUnit(java.lang.Integer unit) Specifies the unit of measurement in the information area.
void	setUnit(java.lang.String unit) Specifies the unit of measurement in the information area.
void	setValue(java.lang.Object object) For internal use only.
void	setVisibleBarPieThemeId(java.lang.String colorThemeId) For internal use only.
void	setVisibleColorThemeId(java.lang.String colorThemeId) For internal use only.
void	setZoomBarPosition(int zoomBarPosition) Specifies the position of the zoomBar in the map.
void	setZoomBarPosition(java.lang.String zoomBarPosition) Specifies the position of the zoomBar in the map.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.faces.component.StateHolder

isTransient, setTransient

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

TYPE

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

STARTINGX_KEY

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

STARTINGY_KEY

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

SRID_KEY

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

MAPZOOM_KEY

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

ZOOMBARPOSITION_KEY

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

SHOWSCALEBAR_KEY

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

SHOWINFOAREA_KEY

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

AUTOZOOMTHEMEID_KEY

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

AUTOZOOMSTRATEGY_KEY

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

SELECTIONLISTENER_KEY

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

BASEMAPNAME_KEY

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

SATELLITEBASEMAPNAME_KEY

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

HYBRIDBASEMAPNAME_KEY

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

MAPSERVERCONFIGID_KEY

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

SELECTIONFILLCOLOR_KEY

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

SELECTIONSTROKECOLOR_KEY

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

SELECTIONOPACITY_KEY

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

INLINESTYLE_KEY

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

MAPLEGEND_KEY

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

OVERVIEWMAP_KEY

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

CLIENT_LISTENERS_KEY

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

ACTIVETHEMEID_KEY

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

UNIT_KEY

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

COPYRIGHTTEXT_KEY

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

STYLECLASS_KEY

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

PARTIAL_TRIGGERS_KEY

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

THEMELIST_KEY

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

MAPCONFIGURATION_KEY

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

CUSTOMIZATION_ID_KEY

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

SUMMARY_KEY

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

m_locale

protected static transient java.util.Locale m_locale

LOGGERCLASS

protected static java.lang.String LOGGERCLASS

logger

protected static oracle.adf.share.logging.ADFLogger logger

Constructor Detail

UIGeoMap

public UIGeoMap()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getRendererType

public java.lang.String getRendererType()

Overrides:

getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getSelectionListener

public final javax.el.MethodExpression getSelectionListener()

setSelectionListener

public final void setSelectionListener(javax.el.MethodExpression selectionListener)

setSRID

public void setSRID(java.lang.String srid)

Specifies the srid (spatial reference id) of all the coordinates of the map, which includes the center of the map -- which defined by starting X and startingY -- and all the points in the point theme. Please refer to Oracle spatial's documentation for all the valid values and its meaning. The default value is 8307. For mercator projection, the value is 54004.

Parameters:

srid - The srid of all the coordinates of the map

getSRID

public java.lang.String getSRID()

Return the srid (spatial reference id) of all the coordinates of the map. The default value is 8307. For mercator projection, the value is 54004.

Returns:

The srid of all the coordinates of the map

setStartingX

public void setStartingX(double x)

Specifies the X coordinate of the center of the map when the map starts. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute will assume to be the longitude of the center of the map.

Parameters:

x - The x coordinate of the center of the map when the map starts

getStartingX

public double getStartingX()

Return the x coordinate of the center of the map when the map starts.

Returns:

The x coordinate of the center of the map.

setStartingY

public void setStartingY(double y)

Specifies the Y coordinate of the center of the map when the map starts. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute will assume to be the longitude of the center of the map.

Parameters:

y - The y coordinate of the center of the map when the map starts

getStartingY

public double getStartingY()

Return the y coordinate of the center of the map when the map starts.

Returns:

The y coordinate of the center of the map when the map starts

setMapZoom

public void setMapZoom(int mapZoom)

Specifies the beginning zoom level of the map. The zoom levels are defined in the map cache instance as part of the base map

Parameters:

mapZoom - the zoom level where the map starts

getMapZoom

public int getMapZoom()

Return the zoom level when the map starts.

Returns:

The zoom level when the map starts

setZoomBarPosition

public void setZoomBarPosition(int zoomBarPosition)

Specifies the position of the zoomBar in the map. Valid values are: EAST -- the zoomBar will be placed on the right side of the map. WEST -- the zoomBar will be placed on the left side of the map. NONE -- no zoomBar will be shown

Parameters:

zoomBarPosition - The position of the zoomBar

setZoomBarPosition

public void setZoomBarPosition(java.lang.String zoomBarPosition)

Specifies the position of the zoomBar in the map. Valid values are: EAST -- the zoomBar will be placed on the right side of the map. WEST -- the zoomBar will be placed on the left side of the map. NONE -- no zoomBar will be shown

Parameters:

zoomBarPosition - The position of the zoomBar

getZoomBarPosition

public int getZoomBarPosition()

Returns the zoombar position

Returns:

The zoomBarPosition on the map

setShowScaleBar

public void setShowScaleBar(boolean showScaleBar)

Specifies whether to show the scale bar on the map or not. The default value is false.

Parameters:

showScaleBar - true if scaleBar should be visible, false if scaleBar should be hidden.

isShowScaleBar

public boolean isShowScaleBar()

Indicates whether the scale bar is visible or not

Returns:

true if the scale bar is visible, false if the scale bar is hidden.

setShowInfoArea

public void setShowInfoArea(boolean showInfoArea)

Specifies whether the user can show the information area on the map or not. The default value is true.

Parameters:

showInfoArea - true if the information area should be visible, false if it should be hidden

isShowInfoArea

public boolean isShowInfoArea()

Indicates whether the information area is visible or not

Returns:

true if the information area is visible, false if it is hidden

setAutoZoomStrategy

public void setAutoZoomStrategy(java.lang.Integer strategy)

Specifies the auto zoom strategy. Possible values are: MapConstants.ZOOMSTRATEGY_MAXZOOM and MapConstants.ZOOMSTRATEGY_CENTERATZOOMLEVEL

Parameters:

strategy -

setAutoZoomStrategy

public void setAutoZoomStrategy(java.lang.String strategy)

Specifies the auto zoom strategy. Possible values are: maxZoom and centerAtZoomLevel

Parameters:

strategy -

getAutoZoomStrategy

public java.lang.Integer getAutoZoomStrategy()

Retrieves the auto zoom strategy. Possible values are: MapConstants.ZOOMSTRATEGY_MAXZOOM and MapConstants.ZOOMSTRATEGY_CENTERATZOOMLEVEL

Returns:

the auto zoom strategy.

setAutoZoomThemeId

public void setAutoZoomThemeId(java.lang.String autoZoomThemeId)

Specifies the id of the theme where the map is bounded to. When the map starts, it will automatically adjust the center and zoom level of the map such that all of the objects in the theme will be visible

Parameters:

autoZoomThemeId - The themeId where the map is bounded to

getAutoZoomThemeId

public java.lang.String getAutoZoomThemeId()

Return the id of the theme where the map is bounded to

Returns:

The id of the theme where the map is bounded to

setBaseMapName

public void setBaseMapName(java.lang.String baseMapName)

Specifies the name of the baseMap for the map. The name is in the form of data-source-name.cache-instance-name. Cache-instance-name specifes the name of the map cache instance, and data-source-name specifies the name of the MapViewer data source. Please refer to mapviewer's documentation for detail.

Parameters:

baseMapName - The name of the baseMap for the map

getBaseMapName

public java.lang.String getBaseMapName()

Return the name of the baseMap for the map

Returns:

The name of the baseMap for the map

setActiveThemeId

public void setActiveThemeId(java.lang.String activeThemeId)

getActiveThemeId

public java.lang.String getActiveThemeId()

setUnit

public void setUnit(java.lang.Integer unit)

Specifies the unit of measurement in the information area. MILES -- the information area will show distance in miles, and area in square miles. METERS -- the information area will show distance in meters, and area in square meters.

Parameters:

unit - The unit of measurement for the information area.

setUnit

public void setUnit(java.lang.String unit)

Specifies the unit of measurement in the information area. MILES -- the information area will show distance in miles, and area in square miles. METERS -- the information area will show distance in meters, and area in square meters.

Parameters:

unit - The unit of measurement for the information area.

getUnit

public java.lang.Integer getUnit()

Return the unit of measurement for the information area

Returns:

The unit of measurement for the information area

setSatelliteBaseMapName

public void setSatelliteBaseMapName(java.lang.String satelliteBaseMapName)

Specifies the name of the baseMap for the satellite image map. The name is in the same format as baseMapName.

Parameters:

satelliteBaseMapName - The name of the baseMap for the satellite image map.

getSatelliteBaseMapName

public java.lang.String getSatelliteBaseMapName()

Return the name of the baseMap for the satellite image map.

Returns:

The name of the baseMap for the satellite image map.

setHybridBaseMapName

public void setHybridBaseMapName(java.lang.String hybridBaseMapName)

Specifies the name of the baseMap for the hybrid image map. The name is in the same format as baseMapName.

Parameters:

hybridBaseMapName - The name of the baseMap for the hybrid image map.

getHybrdBaseMapName

public java.lang.String getHybrdBaseMapName()

Return the name of the base map of the hybrid image map.

Returns:

The name of the base map of the hybrid image map.

setMapServerConfigId

public void setMapServerConfigId(java.lang.String mapServerConfigId)

Specifies the server configuration id that contains the URL of the map server and the the Geocoder

Parameters:

mapServerConfigId - The id of the server configuration that contains the URL of the map server and the Geocoder

getMapServerServerConfigId

public java.lang.String getMapServerServerConfigId()

Return the server configuration id that contains the URL of the map server and the Geocoder

Returns:

The server configuration id that contains thae URL of the map server and the Geocoder

setSelectionFillColor

public void setSelectionFillColor(java.awt.Color fillColor)

Specifies the fill color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar. Valid values are RGB hexadecimal. For example, color="#000000" for black. The default value is #49E0F6

Parameters:

fillColor - The color to fill the selected region

getSelectionFillColor

public java.awt.Color getSelectionFillColor()

Return the fill color of the selected region

Returns:

The fill color of the selected region

setSelectionStrokeColor

public void setSelectionStrokeColor(java.awt.Color strokeColor)

Specifies the stroke color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar. Valid values are RGB hexadecimal. For example, color="#000000" for black. The default value is #000000

Parameters:

strokeColor - The stroke color of the selected region

getSelectionStrokeColor

public java.awt.Color getSelectionStrokeColor()

Return the stroke color of the selected region

Returns:

The stroke color of the selected region

setSelectionOpacity

public void setSelectionOpacity(int opacity)

Specifies the opacity of the fill color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar. Valid values are 0 to 100. 0 means 100% transparent, and 100 means no transparency. The default value is 40.

Parameters:

opacity - The Opacity of the selected region

getSelectionOpacity

public int getSelectionOpacity()

Return the opacity of the fill color for the selected region

Returns:

The opacity of the fill color of the selected region

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Specifies the inline style of the map's outer DOM element. It can be used to control the size/position, or background color of the map.

Parameters:

inlineStyle - The inlineStyle for the map

getInlineStyle

public java.lang.String getInlineStyle()

Return the inline style of the map's outer DOM element.

Returns:

The inline style for the map's DOM.

setCopyrightText

public void setCopyrightText(java.lang.String copyrightText)

Specifies the copyright text of the map.

Parameters:

copyrightText -

getCopyrightText

public java.lang.String getCopyrightText()

Return the copyright text of the map.

Returns:

Copyright text of the map.

setPartialTriggers

public void setPartialTriggers(java.lang.String[] ids)

Specifies the ids of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:

ids - The ids of the component

getPartialTriggers

public java.lang.String[] getPartialTriggers()

Return the ids of the components that should trigger a partial update.

Returns:

The ids of the components that would trigger a parital update.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component

Parameters:

styleClass - The styleClass for this component

getStyleClass

public java.lang.String getStyleClass()

Return the CSS style class for this component

Returns:

The styleClass of this component

setSummary

public void setSummary(java.lang.String summary)

Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Parameters:

summary - the new summary value

getSummary

public java.lang.String getSummary()

Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Returns:

the new summary value

setThemeList

public void setThemeList(java.util.ArrayList themeList)

getThemeList

public java.util.ArrayList getThemeList()

setMapLegend

public void setMapLegend(UIGeoMapLegend mapLegend)

getMapLegend

public UIGeoMapLegend getMapLegend()

setOverviewMap

public void setOverviewMap(UIGeoOverviewMap overview)

getOverviewMap

public UIGeoOverviewMap getOverviewMap()

setMapConfig

public void setMapConfig(MapConfiguration mapConfig)

getMapConfig

public MapConfiguration getMapConfig()

getConverter

public javax.faces.convert.Converter getConverter()

Specified by:

getConverter in interface javax.faces.component.ValueHolder

setConverter

public void setConverter(javax.faces.convert.Converter converter)

Specified by:

setConverter in interface javax.faces.component.ValueHolder

setCustomizationId

@Deprecated
public void setCustomizationId(java.lang.String customizationId)

Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

getCustomizationId

@Deprecated
public java.lang.String getCustomizationId()

Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCurrentCenterX

public void setCurrentCenterX(java.lang.Double centerX)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getCurrentCenterX

public java.lang.Double getCurrentCenterX()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

setCurrentCenterY

public void setCurrentCenterY(java.lang.Double centerY)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getCurrentCenterY

public java.lang.Double getCurrentCenterY()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

setCurrentCenterSrid

public void setCurrentCenterSrid(java.lang.String centerSrid)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getCurrentCenterSrid

public java.lang.String getCurrentCenterSrid()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

setCurrentZoom

public void setCurrentZoom(java.lang.Integer curZoom)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getCurrentZoom

public java.lang.Integer getCurrentZoom()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

setVisibleColorThemeId

public void setVisibleColorThemeId(java.lang.String colorThemeId)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getVisibleColorThemeId

public java.lang.String getVisibleColorThemeId()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

setVisibleBarPieThemeId

public void setVisibleBarPieThemeId(java.lang.String colorThemeId)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getVisibleBarPieThemeId

public java.lang.String getVisibleBarPieThemeId()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getClientListeners

public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getActiveTheme

public ThemeFOI getActiveTheme()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getThemeFOIById

public ThemeFOI getThemeFOIById(java.lang.String themeId)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

hasLeftClickPopup

public boolean hasLeftClickPopup()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

hasRightClickPopup

public boolean hasRightClickPopup()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getVisibleThemeList

public java.util.ArrayList getVisibleThemeList(boolean isToolbar)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

isLegendInitiallyShown

public boolean isLegendInitiallyShown()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getDataSource

public java.lang.String getDataSource()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

convertZoomBarPositionToString

public static final java.lang.String convertZoomBarPositionToString(int pos)

For internal use only. Application developers should not use this.

Parameters:

pos -

Returns:

For internal use only. Application developers should not use this

converts the zoom bar position to string

convertZoomBarPositionToInt

public static final int convertZoomBarPositionToInt(java.lang.String position)

For internal use only. Application developers should not use this.

Parameters:

position -

Returns:

For internal use only. Application developers should not use this

converts the zoom bar position string to int

convertUnitToInt

public static final int convertUnitToInt(java.lang.String unit)

For internal use only. Application developers should not use this.

Parameters:

unit -

Returns:

For internal use only. Application developers should not use this

converts the unit string to int

convertZoomStrategyToInt

public static final int convertZoomStrategyToInt(java.lang.String strategy)

For internal use only. Application developers should not use this.

Parameters:

strategy -

Returns:

For internal use only. Application developers should not use this

converts the zoom strategy string to int

fireEventToAppListener

protected void fireEventToAppListener(javax.faces.context.FacesContext context,
                                      javax.faces.event.FacesEvent event)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getActionExpression

public javax.el.MethodExpression getActionExpression()

For internal use only. Application developers should not use this.

Specified by:

getActionExpression in interface javax.faces.component.ActionSource2

For internal use only. Application developers should not use this

setAction

public void setAction(javax.faces.el.MethodBinding action)

For internal use only. Application developers should not use this.

Specified by:

setAction in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

setActionExpression

public void setActionExpression(javax.el.MethodExpression action)

For internal use only. Application developers should not use this.

Specified by:

setActionExpression in interface javax.faces.component.ActionSource2

For internal use only. Application developers should not use this

decode

public void decode(javax.faces.context.FacesContext context)

Overrides:

decode in class org.apache.myfaces.trinidad.component.UIXComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)

Overrides:

queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

For internal use only. Application developers should not use this.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class org.apache.myfaces.trinidad.component.UIXComponentBase

For internal use only. Application developers should not use this

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object stateObj)

For internal use only. Application developers should not use this.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class org.apache.myfaces.trinidad.component.UIXComponentBase

For internal use only. Application developers should not use this

getAction

public javax.faces.el.MethodBinding getAction()

For internal use only. Application developers should not use this.

Specified by:

getAction in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

getActionListener

public javax.faces.el.MethodBinding getActionListener()

For internal use only. Application developers should not use this.

Specified by:

getActionListener in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

setActionListener

public void setActionListener(javax.faces.el.MethodBinding methodBinding)

For internal use only. Application developers should not use this.

Specified by:

setActionListener in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

isImmediate

public boolean isImmediate()

For internal use only. Application developers should not use this.

Specified by:

isImmediate in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

setImmediate

public void setImmediate(boolean b)

For internal use only. Application developers should not use this.

Specified by:

setImmediate in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

addActionListener

public void addActionListener(javax.faces.event.ActionListener actionListener)

For internal use only. Application developers should not use this.

Specified by:

addActionListener in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()

For internal use only. Application developers should not use this.

Specified by:

getActionListeners in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener actionListener)

For internal use only. Application developers should not use this.

Specified by:

removeActionListener in interface javax.faces.component.ActionSource

For internal use only. Application developers should not use this

getLocalValue

public java.lang.Object getLocalValue()

For internal use only. Application developers should not use this.

Specified by:

getLocalValue in interface javax.faces.component.ValueHolder

For internal use only. Application developers should not use this

getValue

public java.lang.Object getValue()

For internal use only. Application developers should not use this.

Specified by:

getValue in interface javax.faces.component.ValueHolder

For internal use only. Application developers should not use this

setValue

public void setValue(java.lang.Object object)

For internal use only. Application developers should not use this.

Specified by:

setValue in interface javax.faces.component.ValueHolder

For internal use only. Application developers should not use this

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase

Skip navigation links