|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.1.0) E17492-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class UIThematicMap
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.
Field Summary | |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ANIMATION_DURATION_KEY
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ANIMATION_ON_DISPLAY_KEY
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ANIMATION_ON_DRILL_KEY
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ANIMATION_ON_MAPCHANGE_KEY
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
BASEMAP_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 boolean |
DEFAULT_MAINTAIN_DRILL
|
protected static java.lang.String |
DEFAULT_SELECTION_BEHAVIOR
|
protected static java.lang.String |
DEFAULT_SELECTION_MODE
|
protected static java.lang.String |
DEFAULT_TOOLTIP_DISPLAY
|
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
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
IMAGE_FORMAT_KEY
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
MAINTAIN_DRILL_KEY
|
static java.lang.String |
PAN
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_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.FacesBean.Type |
TYPE
|
static java.lang.String |
ZOOM
|
static java.lang.String |
ZOOM_TO_FIT
|
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 | |
---|---|
UIThematicMap()
Constructs an instance of UIThematicMap |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event)
|
int |
getAnimationDuration()
Gets the animation duration in milliseconds. |
java.lang.String |
getAnimationOnDisplay()
Gets the type of animation to apply when the component is initially displayed. |
java.lang.String |
getAnimationOnDrill()
Gets the type of animation to apply for drilling. |
java.lang.String |
getAnimationOnMapChange()
Gets the type of animation to apply when the value of the basemap changes. |
java.lang.String |
getBasemap()
Gets the name of the basemap displayed by the thematic map |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType()
|
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()
Gets List of features attributes that are turned off. |
java.lang.String |
getImageFormat()
Gets the format of the map image. |
java.lang.String |
getInlineStyle()
Gets the inline style of the thematic map's outer DOM element |
java.lang.String[] |
getPartialTriggers()
Retrieves the ids of the partial triggers for the thematic map |
java.lang.String |
getRendererType()
|
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. |
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)
Specifies the type of animation to apply when the component is initially displayed. |
void |
setAnimationOnDrill(java.lang.String animationOnDrill)
Specifies the type of animation to apply for drilling. |
void |
setAnimationOnMapChange(java.lang.String animationOnMapChange)
Specifies the type of animation to apply when the value of the basemap changes. |
void |
setBasemap(java.lang.String basemap)
Sets the name of the basemap displayed by the thematic map |
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)
Sets List of features attributes that are turned off. |
void |
setImageFormat(java.lang.String imageFormat)
Sets the format of the map image. |
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 |
setPartialTriggers(java.lang.String[] ids)
Specifies the ids of the partial triggers for the thematic map |
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. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, 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, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, 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 |
Field Detail |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey BASEMAP_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_FORMAT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TOOLTIP_DISPLAY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILLING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DRILL_BEHAVIOR_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAINTAIN_DRILL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTROL_PANEL_BEHAVIOR_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FEATURES_OFF_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SUMMARY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_ON_DISPLAY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_ON_MAPCHANGE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_DURATION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_ON_DRILL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey EFFECTOFF_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
protected static final java.lang.String DEFAULT_IMAGE_FORMAT
protected static final java.lang.String DEFAULT_SELECTION_MODE
protected static final java.lang.String DEFAULT_SELECTION_BEHAVIOR
protected static final java.lang.String DEFAULT_TOOLTIP_DISPLAY
protected static final java.lang.String DEFAULT_DRILLING
protected static final java.lang.String DEFAULT_DRILL_BEHAVIOR
protected static final boolean DEFAULT_MAINTAIN_DRILL
protected static final java.lang.String DEFAULT_CONTROL_PANEL_BEHAVIOR
protected static final java.lang.String DEFAULT_ANIMATIONONDISPLAY
protected static final java.lang.String DEFAULT_ANIMATIONONMAPCHANGE
protected static final java.lang.String DEFAULT_ANIMATIONONDRILL
public static final java.lang.String PAN
public static final java.lang.String ZOOM
public static final java.lang.String ZOOM_TO_FIT
Constructor Detail |
---|
public UIThematicMap()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getRendererType()
getRendererType
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.event.AbortProcessingException
public final java.lang.String getBasemap()
public final void setBasemap(java.lang.String basemap)
basemap
- basemap namepublic java.lang.String getInlineStyle()
public void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the thematic map's inline stylepublic java.lang.String getStyleClass()
public void setStyleClass(java.lang.String styleClass)
styleClass
- the thematic map's style classpublic java.lang.String[] getPartialTriggers()
public void setPartialTriggers(java.lang.String[] ids)
ids
- the ids of the partial triggers for this componentpublic java.lang.String getImageFormat()
public void setImageFormat(java.lang.String imageFormat)
imageFormat
- the image format of the mappublic java.lang.String getTooltipDisplay()
public void setTooltipDisplay(java.lang.String tooltipDisplay)
tooltipDisplay
- tooltip display behavior of the thematic mappublic java.lang.String getDrilling()
public void setDrilling(java.lang.String drilling)
drilling
- drilling value for this thematic mappublic java.lang.String getDrillBehavior()
public void setDrillBehavior(java.lang.String drillBehavior)
drillBehavior
- public boolean isMaintainDrill()
true
if drilled areas should be maintained on subsequent drills
false
if drilled areas should be reset on subsequent drillspublic void setMaintainDrill(boolean maintainDrill)
maintainDrill
- true
if drilled areas should be maintained on subsequent drills
false
if drilled areas should be reset on subsequent drillspublic java.lang.String getControlPanelBehavior()
public void setControlPanelBehavior(java.lang.String cbehavior)
cbehavior
- the behavior of the control panelpublic final java.util.Set getFeaturesOff()
public final void setFeaturesOff(java.util.Set featuresOff)
featuresOff
- the new features valuepublic void setAnimationOnDisplay(java.lang.String animationOnDisplay)
animationOnDisplay
- type of animation to apply on displaypublic java.lang.String getAnimationOnDisplay()
public void setAnimationOnMapChange(java.lang.String animationOnMapChange)
animationOnMapChange
- animation to apply on map changepublic java.lang.String getAnimationOnMapChange()
public void setAnimationOnDrill(java.lang.String animationOnDrill)
animationOnDrill
- animation to apply on drillpublic java.lang.String getAnimationOnDrill()
public void setAnimationDuration(int animationDuration)
animationDuration
- animation duration in millisecondspublic int getAnimationDuration()
public void setEffectOff(java.lang.String effect)
public java.lang.String getEffectOff()
public void setSummary(java.lang.String summary)
summary
- the new summary valuepublic java.lang.String getSummary()
public void saveToSessionChangeManager(java.lang.String attributeName, java.lang.Object attributeValue)
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.1.0) E17492-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |