oracle.adfdt.view.dvt.binding.pattern.map.extension

Class MapExtendedProperties

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.map.extension.MapExtendedProperties

All Implemented Interfaces:

ExtendedProperties

public class MapExtendedProperties
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of a map.

Field Summary

Fields inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

AF_NS, DVT_NS, F_NS

Constructor Summary

Constructors

Constructor and Description
MapExtendedProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAutoZoomStrategy() Description: This attribute determines how the map will adjust the center and zoom level.
java.lang.String	getAutoZoomThemeId() Description: Specifies the id of the theme where the map will use to set its center and zoom level when the map starts.
java.lang.String	getBaseMapName() Description: Specifies the name of the baseMap for the map.
java.lang.String	getBinding() Description: Binding reference to store the UIGeoMap component
java.lang.String	getCopyrightText() Description: Specifies the copyright text of the map.
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
java.lang.String	getHybridBaseMapName() Description: Specifies the name of the baseMap for the hybrid image map.
java.lang.String	getId() Description: The identifier for the map component
java.lang.String	getInlineStyle() Description: Specifies the inline style of the map's outer DOM element.
MapLegend	getMapLegend() Description: mapLegend is a child tag of the map that lets developer customize different aspects of the legend.
MapOverview	getMapOverview() Description: mapOverview is a child tag of the map that lets developer customize different aspects of the overview Map.
java.lang.String	getMapServerConfigId() Description: Specifies the name of the configuration file that contains the URLs for remote map server and geocoded server
int	getMapZoom() Description: Specifies the beginning zoom level of the map.
java.lang.String	getMapZoomAsString() Description: Specifies the beginning zoom level of the map.
java.lang.String[]	getPartialTriggers() Description: Specifies the ids of the components that should trigger a partial update.
java.lang.String	getSatelliteBaseMapName() Description: Specifies the name of the baseMap for the satellite image map.
java.lang.String	getSelectionFillColor() Description: 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..
int	getSelectionOpacity() Description: 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.
java.lang.String	getSelectionOpacityAsString() Description: 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.
java.lang.String	getSelectionStrokeColor() Description: 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.
int	getSrid() Description: 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.
java.lang.String	getSridAsString() Description: 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.
double	getStartingX() Description: Specifies the X coordinate of the center of the map.
java.lang.String	getStartingXAsString() Description: Specifies the X coordinate of the center of the map.
double	getStartingY() Description: Specifies the Y coordinate of center of the map.
java.lang.String	getStartingYAsString() Description: Specifies the Y coordinate of center of the map.
java.lang.String	getStyleClass() Description: Sets a CSS style class to use for this component.
java.lang.String	getSummary() Description: Sets a summary of this geographical map's purpose and structure for user agents rendering to non-visual media (e.g.
java.lang.String	getTagName()
java.lang.String	getUnit() Description: Specifies the unit of measurement in the information area.
java.lang.String	getZoomBarPosition() Description: Specifies the position of the zoomBar in the map.
boolean	isRendered() Description: Specifies whether the component is rendered
java.lang.String	isRenderedAsString() Description: Specifies whether the component is rendered This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.
boolean	isShowInfoArea() Description: Specifies whether the user can show the information area on the map or not.
java.lang.String	isShowInfoAreaAsString() Description: Specifies whether the user can show the information area on the map or not.
boolean	isShowScaleBar() Description: Specifies whether to show the scale bar on the map or not.
java.lang.String	isShowScaleBarAsString() Description: Specifies whether to show the scale bar on the map or not.
void	setAutoZoomStrategy(java.lang.String autoZoomStrategy) Description: This attribute determines how the map will adjust the center and zoom level.
void	setAutoZoomThemeId(java.lang.String autoZoomThemeId) Description: Specifies the id of the theme where the map will use to set its center and zoom level when the map starts.
void	setBaseMapName(java.lang.String baseMapName) Description: Specifies the name of the baseMap for the map.
void	setBinding(java.lang.String binding) Description: Binding reference to store the UIGeoMap component
void	setCopyrightText(java.lang.String copyrightText) Description: Specifies the copyright text of the map.
void	setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setHybridBaseMapName(java.lang.String hybridBaseMapName) Description: Specifies the name of the baseMap for the hybrid image map.
void	setId(java.lang.String id) Description: The identifier for the map component
void	setInlineStyle(java.lang.String inlineStyle) Description: Specifies the inline style of the map's outer DOM element.
void	setMapLegend(MapLegend mapLegend) Description: mapLegend is a child tag of the map that lets developer customize different aspects of the legend.
void	setMapOverview(MapOverview mapOverview) Description: mapOverview is a child tag of the map that lets developer customize different aspects of the overview Map.
void	setMapServerConfigId(java.lang.String mapServerConfigId) Description: Specifies the name of the configuration file that contains the URLs for remote map server and geocoded server
void	setMapZoom(int mapZoom) Description: Specifies the beginning zoom level of the map.
void	setMapZoomAsString(java.lang.String mapZoom) Description: Specifies the beginning zoom level of the map.
void	setPartialTriggers(java.lang.String[] partialTriggers) Description: Specifies the ids of the components that should trigger a partial update.
void	setRendered(boolean rendered) Description: Specifies whether the component is rendered
void	setRenderedAsString(java.lang.String rendered) Description: Specifies whether the component is rendered This method is provided as a convenience to be able to set an EL on the rendered attribute.
void	setSatelliteBaseMapName(java.lang.String satelliteBaseMapName) Description: Specifies the name of the baseMap for the satellite image map.
void	setSelectionFillColor(java.lang.String selectionFillColor) Description: 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	setSelectionOpacity(int selectionOpacity) Description: 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	setSelectionOpacityAsString(java.lang.String selectionOpacity) Description: 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.lang.String selectionStrokeColor) Description: 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) Description: Specifies whether the user can show the information area on the map or not.
void	setShowInfoAreaAsString(java.lang.String showInfoArea) Description: Specifies whether the user can show the information area on the map or not.
void	setShowScaleBar(boolean showScaleBar) Description: Specifies whether to show the scale bar on the map or not.
void	setShowScaleBarAsString(java.lang.String showScaleBar) Description: Specifies whether to show the scale bar on the map or not.
void	setSrid(int srid) Description: 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	setSridAsString(java.lang.String srid) Description: 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 startingX) Description: Specifies the X coordinate of the center of the map.
void	setStartingXAsString(java.lang.String startingX) Description: Specifies the X coordinate of the center of the map.
void	setStartingY(double startingY) Description: Specifies the Y coordinate of center of the map.
void	setStartingYAsString(java.lang.String startingY) Description: Specifies the Y coordinate of center of the map.
void	setStyleClass(java.lang.String styleClass) Description: Sets a CSS style class to use for this component.
void	setSummary(java.lang.String summary) Description: Sets a summary of this geographical map's purpose and structure for user agents rendering to non-visual media (e.g.
void	setUnit(java.lang.String unit) Description: Specifies the unit of measurement in the information area.
void	setZoomBarPosition(java.lang.String zoomBarPosition) Description: Specifies the position of the zoomBar in the map.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList

Methods inherited from class java.lang.Object

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

Constructor Detail

MapExtendedProperties

public MapExtendedProperties()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getAutoZoomStrategy

public java.lang.String getAutoZoomStrategy()

Description: This attribute determines how the map will adjust the center and zoom level. Valid values are: MAXZOOM - The map will zoom down to the maximum level where all objects in autoZoomThemeId is visible. This is the default value. CENTERATZOOMLEVEL - The map will center on the theme in autoZoomThemeId, and will use the value in the mapZoom attribute as the starting zoom level.

Returns:

the value of the autoZoomStrategy attribute of the Tag this class represents.

setAutoZoomStrategy

public void setAutoZoomStrategy(java.lang.String autoZoomStrategy)

Description: This attribute determines how the map will adjust the center and zoom level. Valid values are: MAXZOOM - The map will zoom down to the maximum level where all objects in autoZoomThemeId is visible. This is the default value. CENTERATZOOMLEVEL - The map will center on the theme in autoZoomThemeId, and will use the value in the mapZoom attribute as the starting zoom level.

Parameters:

autoZoomStrategy - the value of the autoZoomStrategy attribute of the Tag this class represents.

getAutoZoomThemeId

public java.lang.String getAutoZoomThemeId()

Description: Specifies the id of the theme where the map will use to set its center and zoom level when the map starts. If the autoZoomStrategy is MAXZOOM, the map will zoom down to the maximum level where all objects in the theme is visible. If the autoZoomStrategy is CENTERATZOOMLEVEL, the map will center on the theme, and will use the value in the mapZoom attribute as the starting zoom level.

Returns:

the value of the autoZoomThemeId attribute of the Tag this class represents.

setAutoZoomThemeId

public void setAutoZoomThemeId(java.lang.String autoZoomThemeId)

Description: Specifies the id of the theme where the map will use to set its center and zoom level when the map starts. If the autoZoomStrategy is MAXZOOM, the map will zoom down to the maximum level where all objects in the theme is visible. If the autoZoomStrategy is CENTERATZOOMLEVEL, the map will center on the theme, and will use the value in the mapZoom attribute as the starting zoom level.

Parameters:

autoZoomThemeId - the value of the autoZoomThemeId attribute of the Tag this class represents.

getBaseMapName

public java.lang.String getBaseMapName()

Description: 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. Refer to mapviewer's documentation for detail.

Returns:

the value of the baseMapName attribute of the Tag this class represents.

setBaseMapName

public void setBaseMapName(java.lang.String baseMapName)

Description: 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. Refer to mapviewer's documentation for detail.

Parameters:

baseMapName - the value of the baseMapName attribute of the Tag this class represents.

getBinding

public java.lang.String getBinding()

Description: Binding reference to store the UIGeoMap component

Returns:

the value of the binding attribute of the Tag this class represents.

setBinding

public void setBinding(java.lang.String binding)

Description: Binding reference to store the UIGeoMap component

Parameters:

binding - the value of the binding attribute of the Tag this class represents.

getCopyrightText

public java.lang.String getCopyrightText()

Description: Specifies the copyright text of the map.

Returns:

the value of the copyrightText attribute of the Tag this class represents.

setCopyrightText

public void setCopyrightText(java.lang.String copyrightText)

Description: Specifies the copyright text of the map.

Parameters:

copyrightText - the value of the copyrightText attribute of the Tag this class represents.

getCustomizationId

@Deprecated
public java.lang.String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Description: This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the value of the customizationId attribute of the Tag this class represents.

setCustomizationId

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

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Description: This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the value of the customizationId attribute of the Tag this class represents.

getHybridBaseMapName

public java.lang.String getHybridBaseMapName()

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

Returns:

the value of the hybridBaseMapName attribute of the Tag this class represents.

setHybridBaseMapName

public void setHybridBaseMapName(java.lang.String hybridBaseMapName)

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

Parameters:

hybridBaseMapName - the value of the hybridBaseMapName attribute of the Tag this class represents.

getId

public java.lang.String getId()

Description: The identifier for the map component

Returns:

the value of the id attribute of the Tag this class represents.

setId

public void setId(java.lang.String id)

Description: The identifier for the map component

Parameters:

id - the value of the id attribute of the Tag this class represents.

getInlineStyle

public java.lang.String getInlineStyle()

Description: 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.

Returns:

the value of the inlineStyle attribute of the Tag this class represents.

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Description: 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 value of the inlineStyle attribute of the Tag this class represents.

getMapServerConfigId

public java.lang.String getMapServerConfigId()

Description: Specifies the name of the configuration file that contains the URLs for remote map server and geocoded server

Returns:

the value of the mapServerConfigId attribute of the Tag this class represents.

setMapServerConfigId

public void setMapServerConfigId(java.lang.String mapServerConfigId)

Description: Specifies the name of the configuration file that contains the URLs for remote map server and geocoded server

Parameters:

mapServerConfigId - the value of the mapServerConfigId attribute of the Tag this class represents.

getMapZoom

public int getMapZoom()
               throws java.lang.NumberFormatException

Description: Specifies the beginning zoom level of the map. The zoom levels are defined in the map cache instance as part of the base map. The default zoom level is 0.

Returns:

the value of the mapZoom attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setMapZoom

public void setMapZoom(int mapZoom)

Description: Specifies the beginning zoom level of the map. The zoom levels are defined in the map cache instance as part of the base map. The default zoom level is 0.

Parameters:

mapZoom - the value of the mapZoom attribute of the Tag this class represents.

getMapZoomAsString

public java.lang.String getMapZoomAsString()
                                    throws java.lang.NumberFormatException

Description: Specifies the beginning zoom level of the map. The zoom levels are defined in the map cache instance as part of the base map. The default zoom level is 0. This method is provided as a convenience to be able to retrieve an EL that was set on the mapZoom attribute.

Returns:

the value of the mapZoom attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setMapZoomAsString

public void setMapZoomAsString(java.lang.String mapZoom)

Description: Specifies the beginning zoom level of the map. The zoom levels are defined in the map cache instance as part of the base map. The default zoom level is 0. This method is provided as a convenience to be able to set an EL on the mapZoom attribute.

Parameters:

mapZoom - the value of the mapZoom attribute of the Tag this class represents.

getPartialTriggers

public java.lang.String[] getPartialTriggers()

Description: 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.

Returns:

the value of the partialTriggers attribute of the Tag this class represents.

setPartialTriggers

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

Description: 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:

partialTriggers - the value of the partialTriggers attribute of the Tag this class represents.

isRendered

public boolean isRendered()

Description: Specifies whether the component is rendered

Returns:

the value of the rendered attribute of the Tag this class represents.

setRendered

public void setRendered(boolean rendered)

Description: Specifies whether the component is rendered

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Specifies whether the component is rendered This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: Specifies whether the component is rendered This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

getSatelliteBaseMapName

public java.lang.String getSatelliteBaseMapName()

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

Returns:

the value of the satelliteBaseMapName attribute of the Tag this class represents.

setSatelliteBaseMapName

public void setSatelliteBaseMapName(java.lang.String satelliteBaseMapName)

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

Parameters:

satelliteBaseMapName - the value of the satelliteBaseMapName attribute of the Tag this class represents.

getSelectionFillColor

public java.lang.String getSelectionFillColor()

Description: 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

Returns:

the value of the selectionFillColor attribute of the Tag this class represents.

setSelectionFillColor

public void setSelectionFillColor(java.lang.String selectionFillColor)

Description: 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:

selectionFillColor - the value of the selectionFillColor attribute of the Tag this class represents.

getSelectionOpacity

public int getSelectionOpacity()
                        throws java.lang.NumberFormatException

Description: 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.

Returns:

the value of the selectionOpacity attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setSelectionOpacity

public void setSelectionOpacity(int selectionOpacity)

Description: 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:

selectionOpacity - the value of the selectionOpacity attribute of the Tag this class represents.

getSelectionOpacityAsString

public java.lang.String getSelectionOpacityAsString()
                                             throws java.lang.NumberFormatException

Description: 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. This method is provided as a convenience to be able to retrieve an EL that was set on the selectionOpacity attribute.

Returns:

the value of the selectionOpacity attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setSelectionOpacityAsString

public void setSelectionOpacityAsString(java.lang.String selectionOpacity)

Description: 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. This method is provided as a convenience to be able to set an EL on the selectionOpacity attribute.

Parameters:

selectionOpacity - the value of the selectionOpacity attribute of the Tag this class represents.

getSelectionStrokeColor

public java.lang.String getSelectionStrokeColor()

Description: 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

Returns:

the value of the selectionStrokeColor attribute of the Tag this class represents.

setSelectionStrokeColor

public void setSelectionStrokeColor(java.lang.String selectionStrokeColor)

Description: 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:

selectionStrokeColor - the value of the selectionStrokeColor attribute of the Tag this class represents.

isShowInfoArea

public boolean isShowInfoArea()

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

Returns:

the value of the showInfoArea attribute of the Tag this class represents.

setShowInfoArea

public void setShowInfoArea(boolean showInfoArea)

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

Parameters:

showInfoArea - the value of the showInfoArea attribute of the Tag this class represents.

isShowInfoAreaAsString

public java.lang.String isShowInfoAreaAsString()

Description: Specifies whether the user can show the information area on the map or not. The default value is true. This method is provided as a convenience to be able to retrieve an EL that was set on the showInfoArea attribute.

Returns:

the value of the showInfoArea attribute of the Tag this class represents.

setShowInfoAreaAsString

public void setShowInfoAreaAsString(java.lang.String showInfoArea)

Description: Specifies whether the user can show the information area on the map or not. The default value is true. This method is provided as a convenience to be able to set an EL on the showInfoArea attribute.

Parameters:

showInfoArea - the value of the showInfoArea attribute of the Tag this class represents.

isShowScaleBar

public boolean isShowScaleBar()

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

Returns:

the value of the showScaleBar attribute of the Tag this class represents.

setShowScaleBar

public void setShowScaleBar(boolean showScaleBar)

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

Parameters:

showScaleBar - the value of the showScaleBar attribute of the Tag this class represents.

isShowScaleBarAsString

public java.lang.String isShowScaleBarAsString()

Description: Specifies whether to show the scale bar on the map or not. The default value is false. This method is provided as a convenience to be able to retrieve an EL that was set on the showScaleBar attribute.

Returns:

the value of the showScaleBar attribute of the Tag this class represents.

setShowScaleBarAsString

public void setShowScaleBarAsString(java.lang.String showScaleBar)

Description: Specifies whether to show the scale bar on the map or not. The default value is false. This method is provided as a convenience to be able to set an EL on the showScaleBar attribute.

Parameters:

showScaleBar - the value of the showScaleBar attribute of the Tag this class represents.

getSrid

public int getSrid()
            throws java.lang.NumberFormatException

Description: 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. Refer to Oracle Spatial documentation for all the valid values and their meaning. The default value is 8307. For mercator projection, the value is 54004.

Returns:

the value of the srid attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setSrid

public void setSrid(int srid)

Description: 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. Refer to Oracle Spatial documentation for all the valid values and their meaning. The default value is 8307. For mercator projection, the value is 54004.

Parameters:

srid - the value of the srid attribute of the Tag this class represents.

getSridAsString

public java.lang.String getSridAsString()
                                 throws java.lang.NumberFormatException

Description: 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. Refer to Oracle Spatial documentation for all the valid values and their meaning. The default value is 8307. For mercator projection, the value is 54004. This method is provided as a convenience to be able to retrieve an EL that was set on the srid attribute.

Returns:

the value of the srid attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setSridAsString

public void setSridAsString(java.lang.String srid)

Description: 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. Refer to Oracle Spatial documentation for all the valid values and their meaning. The default value is 8307. For mercator projection, the value is 54004. This method is provided as a convenience to be able to set an EL on the srid attribute.

Parameters:

srid - the value of the srid attribute of the Tag this class represents.

getStartingX

public double getStartingX()
                    throws java.lang.NumberFormatException

Description: Specifies the X coordinate of the center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the longitude of the center of the map.

Returns:

the value of the startingX attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setStartingX

public void setStartingX(double startingX)

Description: Specifies the X coordinate of the center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the longitude of the center of the map.

Parameters:

startingX - the value of the startingX attribute of the Tag this class represents.

getStartingXAsString

public java.lang.String getStartingXAsString()
                                      throws java.lang.NumberFormatException

Description: Specifies the X coordinate of the center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the longitude of the center of the map. This method is provided as a convenience to be able to retrieve an EL that was set on the startingX attribute.

Returns:

the value of the startingX attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setStartingXAsString

public void setStartingXAsString(java.lang.String startingX)

Description: Specifies the X coordinate of the center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the longitude of the center of the map. This method is provided as a convenience to be able to set an EL on the startingX attribute.

Parameters:

startingX - the value of the startingX attribute of the Tag this class represents.

getStartingY

public double getStartingY()
                    throws java.lang.NumberFormatException

Description: Specifies the Y coordinate of center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the latitude of the center of the map.

Returns:

the value of the startingY attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setStartingY

public void setStartingY(double startingY)

Description: Specifies the Y coordinate of center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the latitude of the center of the map.

Parameters:

startingY - the value of the startingY attribute of the Tag this class represents.

getStartingYAsString

public java.lang.String getStartingYAsString()
                                      throws java.lang.NumberFormatException

Description: Specifies the Y coordinate of center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the latitude of the center of the map. This method is provided as a convenience to be able to retrieve an EL that was set on the startingY attribute.

Returns:

the value of the startingY attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setStartingYAsString

public void setStartingYAsString(java.lang.String startingY)

Description: Specifies the Y coordinate of center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the latitude of the center of the map. This method is provided as a convenience to be able to set an EL on the startingY attribute.

Parameters:

startingY - the value of the startingY attribute of the Tag this class represents.

getStyleClass

public java.lang.String getStyleClass()

Description: Sets a CSS style class to use for this component.

Returns:

the value of the styleClass attribute of the Tag this class represents.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Description: Sets a CSS style class to use for this component.

Parameters:

styleClass - the value of the styleClass attribute of the Tag this class represents.

getSummary

public java.lang.String getSummary()

Description: Sets a summary of this geographical map's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).

Returns:

the value of the summary attribute of the Tag this class represents.

setSummary

public void setSummary(java.lang.String summary)

Description: Sets a summary of this geographical map's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).

Parameters:

summary - the value of the summary attribute of the Tag this class represents.

getUnit

public java.lang.String getUnit()

Description: Specifies the unit of measurement in the information area. MILES - the information area will show distance in miles, and area in square miles. This is the default value. METERS - the information area will show distance in meters, and area in square meters.

Returns:

the value of the unit attribute of the Tag this class represents.

setUnit

public void setUnit(java.lang.String unit)

Description: Specifies the unit of measurement in the information area. MILES - the information area will show distance in miles, and area in square miles. This is the default value. METERS - the information area will show distance in meters, and area in square meters.

Parameters:

unit - the value of the unit attribute of the Tag this class represents.

getZoomBarPosition

public java.lang.String getZoomBarPosition()

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

Returns:

the value of the zoomBarPosition attribute of the Tag this class represents.

setZoomBarPosition

public void setZoomBarPosition(java.lang.String zoomBarPosition)

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

Parameters:

zoomBarPosition - the value of the zoomBarPosition attribute of the Tag this class represents.

getMapOverview

public MapOverview getMapOverview()

Description: mapOverview is a child tag of the map that lets developer customize different aspects of the overview Map. The overview map appears in the lower right corner of the map. Each map should have at most one mapOverview tag.

Returns:

the MapOverview of the Tag this class represents.

setMapOverview

public void setMapOverview(MapOverview mapOverview)

Description: mapOverview is a child tag of the map that lets developer customize different aspects of the overview Map. The overview map appears in the lower right corner of the map. Each map should have at most one mapOverview tag.

Parameters:

mapOverview - the MapOverview of the Tag this class represents.

getMapLegend

public MapLegend getMapLegend()

Description: mapLegend is a child tag of the map that lets developer customize different aspects of the legend. To view the legend, the user has to use the mapToolbar to show/hide the legend.

Returns:

the MapLegend of the Tag this class represents.

setMapLegend

public void setMapLegend(MapLegend mapLegend)

Description: mapLegend is a child tag of the map that lets developer customize different aspects of the legend. To view the legend, the user has to use the mapToolbar to show/hide the legend.

Parameters:

mapLegend - the MapLegend of the Tag this class represents.