oracle.adf.view.faces.bi.component.thematicMap

Class UIThematicMap

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.thematicMap.UIThematicMap

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIThematicMap
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements javax.faces.component.NamingContainer

The Thematic Map component is used for displaying data that is associated with a geographic location. One of the primary uses of this component is to show trends or patterns in data with a spatial element to it. The thematic map does this by using the data to stylize a region (e.g. assigning fill color based on data values), associating a marker with the region, or both.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_DURATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_ON_DISPLAY_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_ON_DRILL_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_ON_MAPCHANGE_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	BASEMAP_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	CONTROL_PANEL_BEHAVIOR_KEY
protected static java.lang.String	DEFAULT_ANIMATIONONDISPLAY
protected static java.lang.String	DEFAULT_ANIMATIONONDRILL
protected static java.lang.String	DEFAULT_ANIMATIONONMAPCHANGE
protected static java.lang.String	DEFAULT_CONTROL_PANEL_BEHAVIOR
protected static java.lang.String	DEFAULT_DRILL_BEHAVIOR
protected static java.lang.String	DEFAULT_DRILLING
protected static java.lang.String	DEFAULT_IMAGE_FORMAT
protected static java.lang.String	DEFAULT_INITIAL_ZOOMING
protected static boolean	DEFAULT_MAINTAIN_DRILL
protected static java.lang.String	DEFAULT_MARKER_ZOOM_BEHAVIOR
protected static java.lang.String	DEFAULT_PANNING
protected static java.lang.String	DEFAULT_SELECTION_BEHAVIOR
protected static java.lang.String	DEFAULT_SELECTION_MODE
protected static java.lang.String	DEFAULT_TOOLTIP_DISPLAY
protected static java.lang.String	DEFAULT_ZOOMING
static org.apache.myfaces.trinidad.bean.PropertyKey	DRILL_BEHAVIOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DRILLING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EFFECTOFF_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FEATURES_OFF_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	IMAGE_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INITIAL_ZOOMING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAINTAIN_DRILL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAP_PROVIDER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MARKER_ZOOM_BEHAVIOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAX_ZOOM_KEY
static java.lang.String	PAN Deprecated. don't use featuresOff="pan" use panning="none" instead
static org.apache.myfaces.trinidad.bean.PropertyKey	PANNING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SOURCE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SUMMARY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TOOLTIP_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TRANSITIONS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static java.lang.String	ZOOM Deprecated. don't use featuresOff="zoom" use zooming="none" instead
static java.lang.String	ZOOM_TO_FIT Deprecated. don't use featuresOff="zoomToFit" use zooming="none" instead
static org.apache.myfaces.trinidad.bean.PropertyKey	ZOOMING_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

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UIThematicMap() Constructs an instance of UIThematicMap

Method Summary

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
int	getAnimationDuration() Gets the animation duration in milliseconds.
java.lang.String	getAnimationOnDisplay() Deprecated. See getTransitions()
java.lang.String	getAnimationOnDrill() Deprecated. See getTransitions()
java.lang.String	getAnimationOnMapChange() Deprecated. See getTransitions()
java.lang.String	getBasemap() Gets the name of the basemap displayed by the thematic map
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
oracle.adf.view.rich.event.ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getControlPanelBehavior() Gets the behavior of the control panel.
java.lang.String	getDrillBehavior() Gets the drilling behavior of the thematic map.
java.lang.String	getDrilling() Retrieves whether drilling should be on or off for this thematic map.
java.lang.String	getEffectOff() For internal use only
java.lang.String	getFamily()
java.util.Set	getFeaturesOff() Deprecated.
java.lang.String	getImageFormat() Deprecated. The image format should be decided based on the browser capabilities
java.lang.String	getInitialZooming() Gets the initialZooming behavior.
java.lang.String	getInlineStyle() Gets the inline style of the thematic map's outer DOM element
MapProvider	getMapProvider() Gets the MapProvider for this component
java.lang.String	getMarkerZoomBehavior() Gets marker behavior on zoom.
double	getMaxZoom() Gets the maximum zoom level for this component.
java.lang.String	getPanning() Gets the panning behavior.
java.lang.String[]	getPartialTriggers() Retrieves the ids of the partial triggers for the thematic map
java.lang.String	getRendererType()
java.lang.String	getSource() Gets the path for the custom base map metadata xml file.
java.lang.String	getStyleClass() Gets the CSS style class to use 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.
java.lang.String	getTooltipDisplay() Gets the tooltip display behavior of the thematic map.
oracle.adf.view.rich.render.TransitionInfo[]	getTransitions() Retrieves the array of animation transitions applied to this component.
java.lang.String	getZooming() Gets the zooming behavior.
boolean	isMaintainDrill() Indicates whether or not to maintain previously drilled areas in the same layer when a new area is drilled.
void	saveToSessionChangeManager(java.lang.String attributeName, java.lang.Object attributeValue) For internal use only
void	setAnimationDuration(int animationDuration) Specifies the animation duration in milliseconds.
void	setAnimationOnDisplay(java.lang.String animationOnDisplay) Deprecated. See #setTransitions()
void	setAnimationOnDrill(java.lang.String animationOnDrill) Deprecated. See #setTransitions()
void	setAnimationOnMapChange(java.lang.String animationOnMapChange) Deprecated. See #setTransitions()
void	setBasemap(java.lang.String basemap) Sets the name of the basemap displayed by the thematic map
void	setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners) Sets a set of client listeners.
void	setControlPanelBehavior(java.lang.String cbehavior) Sets the behavior of the control panel.
void	setDrillBehavior(java.lang.String drillBehavior) Sets the drilling behavior of the thematic map.
void	setDrilling(java.lang.String drilling) Specifies whether drilling should be on or off for this thematic map.
void	setEffectOff(java.lang.String effect) For internal use only
void	setFeaturesOff(java.util.Set featuresOff) Deprecated.
void	setImageFormat(java.lang.String imageFormat) Deprecated. The image format should be decided based on the browser capabilities
void	setInitialZooming(java.lang.String initialZooming) Sets the initialZooming behavior.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline style of the thematic map's outer DOM element
void	setMaintainDrill(boolean maintainDrill) Specifies whether or not to maintain previously drilled areas in the same layer when a new area is drilled.
void	setMapProvider(MapProvider mapProvider) Sets the MapProvider for this component
void	setMarkerZoomBehavior(java.lang.String behavior) Sets whether markers maitain their current size or grow and shrink on zoom.
void	setMaxZoom(double maxZoom) Sets the maximum zoom level for this component.
void	setPanning(java.lang.String panning) Sets the panning behavior.
void	setPartialTriggers(java.lang.String[] ids) Specifies the ids of the partial triggers for the thematic map
void	setSource(java.lang.String source) Sets the path for the custom base map metadata xml file.
void	setStyleClass(java.lang.String styleClass) Sets the 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	setTooltipDisplay(java.lang.String tooltipDisplay) Sets the tooltip display behavior of the thematic map.
void	setTransitions(oracle.adf.view.rich.render.TransitionInfo[] transitionInfo) Sets the array of animation transitions to be applied to this component.
void	setZooming(java.lang.String zooming) Sets the zooming behavior.

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

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

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

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, 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, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

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

BASEMAP_KEY

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

PARTIAL_TRIGGERS_KEY

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

INLINE_STYLE_KEY

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

STYLE_CLASS_KEY

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

IMAGE_FORMAT_KEY

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

TOOLTIP_DISPLAY_KEY

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

DRILLING_KEY

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

DRILL_BEHAVIOR_KEY

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

MAINTAIN_DRILL_KEY

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

CONTROL_PANEL_BEHAVIOR_KEY

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

FEATURES_OFF_KEY

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

Deprecated.

SUMMARY_KEY

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

SOURCE_KEY

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

PANNING_KEY

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

ZOOMING_KEY

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

INITIAL_ZOOMING_KEY

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

ANIMATION_ON_DISPLAY_KEY

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

Deprecated.

ANIMATION_ON_MAPCHANGE_KEY

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

Deprecated.

ANIMATION_DURATION_KEY

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

ANIMATION_ON_DRILL_KEY

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

Deprecated.

EFFECTOFF_KEY

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

MARKER_ZOOM_BEHAVIOR_KEY

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

MAP_PROVIDER_KEY

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

CLIENT_LISTENERS_KEY

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

TRANSITIONS_KEY

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

MAX_ZOOM_KEY

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

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

DEFAULT_IMAGE_FORMAT

protected static final java.lang.String DEFAULT_IMAGE_FORMAT

See Also:

Constant Field Values

DEFAULT_SELECTION_MODE

protected static final java.lang.String DEFAULT_SELECTION_MODE

See Also:

Constant Field Values

DEFAULT_SELECTION_BEHAVIOR

protected static final java.lang.String DEFAULT_SELECTION_BEHAVIOR

See Also:

Constant Field Values

DEFAULT_TOOLTIP_DISPLAY

protected static final java.lang.String DEFAULT_TOOLTIP_DISPLAY

See Also:

Constant Field Values

DEFAULT_DRILLING

protected static final java.lang.String DEFAULT_DRILLING

See Also:

Constant Field Values

DEFAULT_DRILL_BEHAVIOR

protected static final java.lang.String DEFAULT_DRILL_BEHAVIOR

See Also:

Constant Field Values

DEFAULT_MAINTAIN_DRILL

protected static final boolean DEFAULT_MAINTAIN_DRILL

See Also:

Constant Field Values

DEFAULT_CONTROL_PANEL_BEHAVIOR

protected static final java.lang.String DEFAULT_CONTROL_PANEL_BEHAVIOR

See Also:

Constant Field Values

DEFAULT_ZOOMING

protected static final java.lang.String DEFAULT_ZOOMING

See Also:

Constant Field Values

DEFAULT_PANNING

protected static final java.lang.String DEFAULT_PANNING

See Also:

Constant Field Values

DEFAULT_INITIAL_ZOOMING

protected static final java.lang.String DEFAULT_INITIAL_ZOOMING

See Also:

Constant Field Values

DEFAULT_ANIMATIONONDISPLAY

protected static final java.lang.String DEFAULT_ANIMATIONONDISPLAY

See Also:

Constant Field Values

DEFAULT_ANIMATIONONMAPCHANGE

protected static final java.lang.String DEFAULT_ANIMATIONONMAPCHANGE

See Also:

Constant Field Values

DEFAULT_ANIMATIONONDRILL

protected static final java.lang.String DEFAULT_ANIMATIONONDRILL

See Also:

Constant Field Values

DEFAULT_MARKER_ZOOM_BEHAVIOR

protected static final java.lang.String DEFAULT_MARKER_ZOOM_BEHAVIOR

See Also:

Constant Field Values

PAN

public static final java.lang.String PAN

Deprecated. don't use featuresOff="pan" use panning="none" instead

See Also:

Constant Field Values

ZOOM

public static final java.lang.String ZOOM

Deprecated. don't use featuresOff="zoom" use zooming="none" instead

See Also:

Constant Field Values

ZOOM_TO_FIT

public static final java.lang.String ZOOM_TO_FIT

Deprecated. don't use featuresOff="zoomToFit" use zooming="none" instead

See Also:

Constant Field Values

Constructor Detail

UIThematicMap

public UIThematicMap()

Constructs an instance of UIThematicMap

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

getBeanType

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

Overrides:

getBeanType 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

getBasemap

public final java.lang.String getBasemap()

Gets the name of the basemap displayed by the thematic map

Returns:

basemap name

setBasemap

public final void setBasemap(java.lang.String basemap)

Sets the name of the basemap displayed by the thematic map

Parameters:

basemap - basemap name

getInlineStyle

public java.lang.String getInlineStyle()

Gets the inline style of the thematic map's outer DOM element

Returns:

the thematic map's inline style

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Sets the inline style of the thematic map's outer DOM element

Parameters:

inlineStyle - the thematic map's inline style

getStyleClass

public java.lang.String getStyleClass()

Gets the CSS style class to use for this component

Returns:

the thematic map's style class

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style class to use for this component

Parameters:

styleClass - the thematic map's style class

getPartialTriggers

public java.lang.String[] getPartialTriggers()

Retrieves the ids of the partial triggers for the thematic map

Returns:

the ids of the partial triggers for this component

setPartialTriggers

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

Specifies the ids of the partial triggers for the thematic map

Parameters:

ids - the ids of the partial triggers for this component

getImageFormat

@Deprecated
public java.lang.String getImageFormat()

Deprecated. The image format should be decided based on the browser capabilities

Gets the format of the map image. Valid values are: "flash" - (default) Displays the map in Flash "png" - Displays the map as a PNG image

Returns:

the image format of the map

setImageFormat

@Deprecated
public void setImageFormat(java.lang.String imageFormat)

Deprecated. The image format should be decided based on the browser capabilities

Sets the format of the map image. Valid values are: "flash" - (default) Displays the map in Flash "png" - Displays the map as a PNG image

Parameters:

imageFormat - the image format of the map

getTooltipDisplay

public java.lang.String getTooltipDisplay()

Gets the tooltip display behavior of the thematic map. Valid values are: "auto" - (default) Show basemap location labels in tooltips. If there is data, concatenate the location labels with the shortDesc coming from the stamps "shortDescOnly" - Only show tooltips associated with the shortDesc coming from the stamps, and do not include the location names coming from the basemap. "none" - Show no tooltips on the map. This includes tooltips coming from the basemap as well as the data layers.

Returns:

tooltip display behavior of the thematic map

setTooltipDisplay

public void setTooltipDisplay(java.lang.String tooltipDisplay)

Sets the tooltip display behavior of the thematic map. Valid values are: "auto" - (default) Show basemap location labels in tooltips. If there is data, concatenate the location labels with the shortDesc coming from the stamps "shortDescOnly" - Only show tooltips associated with the shortDesc coming from the stamps, and do not include the location names coming from the basemap. "none" - Show no tooltips on the map. This includes tooltips coming from the basemap as well as the data layers.

Parameters:

tooltipDisplay - tooltip display behavior of the thematic map

getDrilling

public java.lang.String getDrilling()

Retrieves whether drilling should be on or off for this thematic map. The default value is off.

Returns:

drilling value for this thematic map

setDrilling

public void setDrilling(java.lang.String drilling)

Specifies whether drilling should be on or off for this thematic map. The default value is off.

Parameters:

drilling - drilling value for this thematic map

getDrillBehavior

public java.lang.String getDrillBehavior()

Gets the drilling behavior of the thematic map. Valid values are: "none" - (default) no additional effect on drill "zoomToFit" - zoom to fit the drilled region

Returns:

drilling behavior of the thematic map

setDrillBehavior

public void setDrillBehavior(java.lang.String drillBehavior)

Sets the drilling behavior of the thematic map. Valid values are: "none" - (default) no additional effect on drill "zoomToFit" - zoom to fit the drilled region

Parameters:

drillBehavior -

isMaintainDrill

public boolean isMaintainDrill()

Indicates whether or not to maintain previously drilled areas in the same layer when a new area is drilled. The default value is false.

Returns:

true if drilled areas should be maintained on subsequent drills false if drilled areas should be reset on subsequent drills

setMaintainDrill

public void setMaintainDrill(boolean maintainDrill)

Specifies whether or not to maintain previously drilled areas in the same layer when a new area is drilled. The default value is false.

Parameters:

maintainDrill - true if drilled areas should be maintained on subsequent drills false if drilled areas should be reset on subsequent drills

getControlPanelBehavior

public java.lang.String getControlPanelBehavior()

Gets the behavior of the control panel. Valid values are: "initCollapsed" - initially collapsed "initExpanded" - initially expanded "hidden" - hidden from view

Returns:

the behavior of the control panel

setControlPanelBehavior

public void setControlPanelBehavior(java.lang.String cbehavior)

Sets the behavior of the control panel. Valid values are: "initCollapsed" - initially collapsed "initExpanded" - initially expanded "hidden" - hidden from view

Parameters:

cbehavior - the behavior of the control panel

getFeaturesOff

public final java.util.Set getFeaturesOff()

Deprecated.

Gets List of features attributes that are turned off.

Returns:

the new features value

setFeaturesOff

public final void setFeaturesOff(java.util.Set featuresOff)

Deprecated.

Sets List of features attributes that are turned off.

Parameters:

featuresOff - the new features value

setZooming

public final void setZooming(java.lang.String zooming)

Sets the zooming behavior. Valid values are: "auto" "none"

Parameters:

zooming - The zooming attribute

getZooming

public final java.lang.String getZooming()

Gets the zooming behavior. Valid values are: "auto" "none"

Returns:

The zooming behavior

setPanning

public final void setPanning(java.lang.String panning)

Sets the panning behavior. Valid values are: "auto" "none"

Parameters:

panning - The panning attribute

getPanning

public java.lang.String getPanning()

Gets the panning behavior. Valid values are: "auto" "noneh

Returns:

The panning behavior

setInitialZooming

public final void setInitialZooming(java.lang.String initialZooming)

Sets the initialZooming behavior. Valid values are: "auto" "none"

Parameters:

initialZooming - The initialZooming attribute

getInitialZooming

public final java.lang.String getInitialZooming()

Gets the initialZooming behavior. Valid values are: "auto" "none"

Returns:

The initialZooming behavior

setAnimationOnDisplay

public void setAnimationOnDisplay(java.lang.String animationOnDisplay)

Deprecated. See #setTransitions()

Specifies the type of animation to apply when the component is initially displayed. Valid values are: "none" "alphaFade" "conveyorFromLeft" "conveyorFromRight" "cubeToLeft" "cubeToRight" "flipLeft" "flipRight" "slideToLeft" "slideToRight" "transitionToLeft" "transitionToRight" "zoom"

Parameters:

animationOnDisplay - type of animation to apply on display

getAnimationOnDisplay

public java.lang.String getAnimationOnDisplay()

Deprecated. See getTransitions()

Gets the type of animation to apply when the component is initially displayed. Valid values are: "none" "alphaFade" "conveyorFromLeft" "conveyorFromRight" "cubeToLeft" "cubeToRight" "flipLeft" "flipRight" "slideToLeft" "slideToRight" "transitionToLeft" "transitionToRight" "zoom"

Returns:

the type of animation to apply on display

setAnimationOnMapChange

public void setAnimationOnMapChange(java.lang.String animationOnMapChange)

Deprecated. See #setTransitions()

Specifies the type of animation to apply when the value of the basemap changes. Valid values are: "none" "alphaFade" "conveyorFromLeft" "conveyorFromRight" "cubeToLeft" "cubeToRight" "flipLeft" "flipRight" "slideToLeft" "slideToRight" "transitionToLeft" "transitionToRight" "zoom"

Parameters:

animationOnMapChange - animation to apply on map change

getAnimationOnMapChange

public java.lang.String getAnimationOnMapChange()

Deprecated. See getTransitions()

Gets the type of animation to apply when the value of the basemap changes. Valid values are: "none" "alphaFade" "conveyorFromLeft" "conveyorFromRight" "cubeToLeft" "cubeToRight" "flipLeft" "flipRight" "slideToLeft" "slideToRight" "transitionToLeft" "transitionToRight" "zoom"

Returns:

animation to apply on map change

setAnimationOnDrill

public void setAnimationOnDrill(java.lang.String animationOnDrill)

Deprecated. See #setTransitions()

Specifies the type of animation to apply for drilling. Valid values are: "none" "alphaFade" "flip"

Parameters:

animationOnDrill - animation to apply on drill

getAnimationOnDrill

public java.lang.String getAnimationOnDrill()

Deprecated. See getTransitions()

Gets the type of animation to apply for drilling. Valid values are: "none" "alphaFade" "flip"

Returns:

animation to apply on drill

setAnimationDuration

public void setAnimationDuration(int animationDuration)

Specifies the animation duration in milliseconds.

Parameters:

animationDuration - animation duration in milliseconds

getAnimationDuration

public int getAnimationDuration()

Gets the animation duration in milliseconds. The default value is 1000.

Returns:

animation duration in milliseconds

setEffectOff

@Concealed
public void setEffectOff(java.lang.String effect)

For internal use only

For internal use only. Application developers should not use this

getEffectOff

@Concealed
public java.lang.String getEffectOff()

For internal use only

For internal use only. Application developers should not use this

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

setSource

public void setSource(java.lang.String source)

Sets the path for the custom base map metadata xml file.

Parameters:

source - the custom base map metadata xml file path

getSource

public java.lang.String getSource()

Gets the path for the custom base map metadata xml file.

Returns:

the custom base map metadata xml file path

setMarkerZoomBehavior

public void setMarkerZoomBehavior(java.lang.String behavior)

Sets whether markers maitain their current size or grow and shrink on zoom. Valid values are: "fixed" - (default) Markers will remain the same size on zoom "zoom" - Markers will grow and shrink on zoom

Parameters:

behavior - The marker behavior on zoom

getMarkerZoomBehavior

public java.lang.String getMarkerZoomBehavior()

Gets marker behavior on zoom. Markers can either maintain their current size or grow and shrink on zoom.

Returns:

The marker behavior on zoom

setMapProvider

public void setMapProvider(MapProvider mapProvider)

Sets the MapProvider for this component

Parameters:

mapProvider - the MapProvider for this component

getMapProvider

public MapProvider getMapProvider()

Gets the MapProvider for this component

Returns:

the MapProvider

setClientListeners

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

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getClientListeners

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

Gets a set of client listeners.

Returns:

the new clientListeners value

getMaxZoom

public final double getMaxZoom()

Gets the maximum zoom level for this component. This can be any number greater than 1.0 which indicates the maximum point to which the map can be scaled. A value of 2.0 implies that the map can be zoomed in until it reaches twice the viewport size. A maxZoom of 1.0 indicates that the user cannot zoom the map beyond the viewport size. By default, maxZoom is 6.0.

Returns:

the maximum zoom level

setMaxZoom

public final void setMaxZoom(double maxZoom)

Sets the maximum zoom level for this component. This can be any number greater than 1.0 which indicates the maximum point to which the map can be scaled. A value of 2.0 implies that the map can be zoomed in until it reaches twice the viewport size. A maxZoom of 1.0 indicates that the user cannot zoom the map beyond the viewport size. By default, maxZoom is 6.0.

Parameters:

maxZoom - the maximum zoom level

saveToSessionChangeManager

@Concealed
public void saveToSessionChangeManager(java.lang.String attributeName,
                                                  java.lang.Object attributeValue)

For internal use only

For internal use only. Application developers should not use this

getTransitions

public final oracle.adf.view.rich.render.TransitionInfo[] getTransitions()

Retrieves the array of animation transitions applied to this component. Supported trigger type is display. Supported transitions are none (default) and auto.

setTransitions

public final void setTransitions(oracle.adf.view.rich.render.TransitionInfo[] transitionInfo)

Sets the array of animation transitions to be applied to this component. Supported trigger types are dataChange and display. Supported transitions are none (default) and auto.