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

java.lang.Object
  oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      oracle.adf.view.faces.bi.component.geoMap.ThemeFOI
          oracle.adf.view.faces.bi.component.geoMap.PointFOI

All Implemented Interfaces:

javax.faces.component.StateHolder

public class PointFOI
extends ThemeFOI

This complex attribute class display points on a map with user defined images or HTML content

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATIONEFFECT_KEY
static java.lang.String	BLINK_AND_FADE_EFFECT
static java.lang.String	BLINK_EFFECT
static java.lang.String	BUILT_IN_IMAGE_LARGE_ORANGEPIN
static java.lang.String	BUILT_IN_IMAGE_MEDIUM_ORANGEPIN
static java.lang.String	BUILT_IN_IMAGE_ORANGEBALL
static java.lang.String	BUILT_IN_IMAGE_SMALL_ORANGEPIN
static java.lang.String	BUILTIN_IMAGE_BALLORANGE
static java.lang.String	BUILTIN_IMAGE_COLOR_BLUE
static java.lang.String	BUILTIN_IMAGE_COLOR_GREEN
static java.lang.String	BUILTIN_IMAGE_COLOR_ORANGE
static java.lang.String	BUILTIN_IMAGE_COLOR_PURPLE
static java.lang.String	BUILTIN_IMAGE_COLOR_RED
static java.lang.String	BUILTIN_IMAGE_PINLARGEORANGE
static java.lang.String	BUILTIN_IMAGE_PINMEDIUMORANGE
static java.lang.String	BUILTIN_IMAGE_PINSMALLORANGE
static java.lang.String	BUILTIN_IMAGE_STYLE_3DCUBE
static java.lang.String	BUILTIN_IMAGE_STYLE_BUBBLE
static java.lang.String	BUILTIN_IMAGE_STYLE_DIAGONALSQUARE
static java.lang.String	BUILTIN_IMAGE_STYLE_FLAG
static java.lang.String	BUILTIN_IMAGE_STYLE_HEXAGON
static java.lang.String	BUILTIN_IMAGE_STYLE_POINTERBUBBLE
static java.lang.String	BUILTIN_IMAGE_STYLE_PUSHPIN
static java.lang.String	BUILTIN_IMAGE_STYLE_SIGNONE
static java.lang.String	BUILTIN_IMAGE_STYLE_SIGNTWO
static java.lang.String	BUILTIN_IMAGE_STYLE_SQUAREBUBBLE
static java.lang.String	BUILTIN_IMAGE_STYLE_TRAFFICSIGN
static java.lang.String	BUILTIN_IMAGE_STYLE_TRAFFICSIGNDIAGONAL
static org.apache.myfaces.trinidad.bean.PropertyKey	BUILTINIMAGE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMLEGENDCALLBACK_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMPOINTCALLBACK_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DEFAULTITEMLABEL_KEY
static java.lang.String	FADE_EFFECT
static org.apache.myfaces.trinidad.bean.PropertyKey	HOVERBEHAVIOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OVERLAYTEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	THEMENAME_KEY
static java.lang.String	THEMETYPE
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.bi.component.geoMap.ThemeFOI

CLICKACTION_KEY, CLICKLISTENER_KEY, INFOWINDOWCALLBACK_KEY, LEFTCLICKBEHAVIOR_KEY, logger, LOGGERCLASS, MAXZOOM_KEY, MENULABEL_KEY, MINZOOM_KEY, RENDERED_KEY, RIGHTCLICKBEHAVIOR_KEY, SELECTIONLISTENER_KEY, SHORTLABEL_KEY, USEWINDOW_KEY, VALUE_KEY, WINDOWHEIGHT_KEY, WINDOWWIDTH_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

PointFOI()

Method Summary

static int	convertHoverBehavior(java.lang.String hoverBehavior)
static java.lang.String	convertHoverBehaviorToString(int hoverBehavior)
java.lang.String	getAnimationEffect() Return the animation effect for this theme
java.lang.String	getBuiltInImage()
LegendContent	getCustomLegendContent() Return the custom legend content for the point theme
javax.el.MethodExpression	getCustomPointCallback() Return the customPointCallback for this point Theme.
java.lang.String	getDefaultItemLabel() Return the label for the default item on the legend
java.lang.Integer	getHoverBehavior() Return the hover Behavior for this point Theme
java.lang.String	getInternalThemeType() Hidden
int	getOverlayText()
PointStyleItem	getPointStyleItemFromValue(java.lang.String category, java.lang.Double value) Hidden
PointStyleSet	getPointStyleSet()
void	setAnimationEffect(java.lang.String animationEffect) Specifies the animationEffect to use for ADS.
void	setBuiltInImage(java.lang.String pointImage)
void	setCustomLegendContent(LegendContent legendContent) Set the custom Legend Content for this point Theme
void	setCustomPointCallback(javax.el.MethodExpression callback) Specifies a callback for overriding the point.
void	setDefaultItemLabel(java.lang.String shortLabel) Specifies the label of the default item on the legend.
void	setHoverBehavior(java.lang.Integer hoverBehavior) Specifies the behavior when user hovers over a point on the pointTheme Valid value of theme are: 0 -- Nothing will happen 1 -- A tooltip will be shown 2 -- An info window will be shown The default value is None.
void	setOverlayText(int overlayText)

Methods inherited from class oracle.adf.view.faces.bi.component.geoMap.ThemeFOI

convertLeftClickBehavior, convertRightClickBehavior, getBeanType, getClickAction, getClickListener, getColorFromStyle, getInfoWindowCallback, getLeftClickBehavior, getMaxZoom, getMenuLabel, getMinZoom, getNumberFormat, getProperty, getRightClickBehavior, getSelectionListener, getShortLabel, getThemeClientSideLeftClickBehavior, getThemeClientSideRightClickBehavior, getWindowHeight, getWindowWidth, isLoaded, isNumberFormatSpecified, isRendered, isToolbarVisible, isUseWindow, setClickAction, setClickListener, setInfoWindowCallback, setLeftClickBehavior, setLoaded, setMaxZoom, setMenuLabel, setMinZoom, setNumberFormat, setRendered, setRightClickBehavior, setSelectionListener, setShortLabel, setToolbarVisible, setUseWindow, setWindowHeight, setWindowWidth

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object

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

Field Detail

BLINK_EFFECT

public static final java.lang.String BLINK_EFFECT

See Also:

Constant Field Values

BLINK_AND_FADE_EFFECT

public static final java.lang.String BLINK_AND_FADE_EFFECT

See Also:

Constant Field Values

FADE_EFFECT

public static final java.lang.String FADE_EFFECT

See Also:

Constant Field Values

THEMETYPE

public static final java.lang.String THEMETYPE

See Also:

Constant Field Values

BUILT_IN_IMAGE_LARGE_ORANGEPIN

public static final java.lang.String BUILT_IN_IMAGE_LARGE_ORANGEPIN

See Also:

Constant Field Values

BUILT_IN_IMAGE_MEDIUM_ORANGEPIN

public static final java.lang.String BUILT_IN_IMAGE_MEDIUM_ORANGEPIN

See Also:

Constant Field Values

BUILT_IN_IMAGE_SMALL_ORANGEPIN

public static final java.lang.String BUILT_IN_IMAGE_SMALL_ORANGEPIN

See Also:

Constant Field Values

BUILT_IN_IMAGE_ORANGEBALL

public static final java.lang.String BUILT_IN_IMAGE_ORANGEBALL

See Also:

Constant Field Values

BUILTIN_IMAGE_BALLORANGE

public static final java.lang.String BUILTIN_IMAGE_BALLORANGE

See Also:

Constant Field Values

BUILTIN_IMAGE_PINLARGEORANGE

public static final java.lang.String BUILTIN_IMAGE_PINLARGEORANGE

See Also:

Constant Field Values

BUILTIN_IMAGE_PINMEDIUMORANGE

public static final java.lang.String BUILTIN_IMAGE_PINMEDIUMORANGE

See Also:

Constant Field Values

BUILTIN_IMAGE_PINSMALLORANGE

public static final java.lang.String BUILTIN_IMAGE_PINSMALLORANGE

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_SQUAREBUBBLE

public static final java.lang.String BUILTIN_IMAGE_STYLE_SQUAREBUBBLE

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_POINTERBUBBLE

public static final java.lang.String BUILTIN_IMAGE_STYLE_POINTERBUBBLE

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_DIAGONALSQUARE

public static final java.lang.String BUILTIN_IMAGE_STYLE_DIAGONALSQUARE

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_BUBBLE

public static final java.lang.String BUILTIN_IMAGE_STYLE_BUBBLE

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_FLAG

public static final java.lang.String BUILTIN_IMAGE_STYLE_FLAG

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_HEXAGON

public static final java.lang.String BUILTIN_IMAGE_STYLE_HEXAGON

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_SIGNONE

public static final java.lang.String BUILTIN_IMAGE_STYLE_SIGNONE

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_PUSHPIN

public static final java.lang.String BUILTIN_IMAGE_STYLE_PUSHPIN

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_SIGNTWO

public static final java.lang.String BUILTIN_IMAGE_STYLE_SIGNTWO

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_TRAFFICSIGNDIAGONAL

public static final java.lang.String BUILTIN_IMAGE_STYLE_TRAFFICSIGNDIAGONAL

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_TRAFFICSIGN

public static final java.lang.String BUILTIN_IMAGE_STYLE_TRAFFICSIGN

See Also:

Constant Field Values

BUILTIN_IMAGE_STYLE_3DCUBE

public static final java.lang.String BUILTIN_IMAGE_STYLE_3DCUBE

See Also:

Constant Field Values

BUILTIN_IMAGE_COLOR_ORANGE

public static final java.lang.String BUILTIN_IMAGE_COLOR_ORANGE

See Also:

Constant Field Values

BUILTIN_IMAGE_COLOR_BLUE

public static final java.lang.String BUILTIN_IMAGE_COLOR_BLUE

See Also:

Constant Field Values

BUILTIN_IMAGE_COLOR_GREEN

public static final java.lang.String BUILTIN_IMAGE_COLOR_GREEN

See Also:

Constant Field Values

BUILTIN_IMAGE_COLOR_RED

public static final java.lang.String BUILTIN_IMAGE_COLOR_RED

See Also:

Constant Field Values

BUILTIN_IMAGE_COLOR_PURPLE

public static final java.lang.String BUILTIN_IMAGE_COLOR_PURPLE

See Also:

Constant Field Values

TYPE

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

DEFAULTITEMLABEL_KEY

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

ANIMATIONEFFECT_KEY

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

CUSTOMPOINTCALLBACK_KEY

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

CUSTOMLEGENDCALLBACK_KEY

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

HOVERBEHAVIOR_KEY

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

THEMENAME_KEY

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

BUILTINIMAGE_KEY

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

OVERLAYTEXT_KEY

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

Constructor Detail

PointFOI

public PointFOI()

Method Detail

setDefaultItemLabel

public void setDefaultItemLabel(java.lang.String shortLabel)

Specifies the label of the default item on the legend.

Parameters:

shortLabel - The label for this theme on the legend.

getDefaultItemLabel

public java.lang.String getDefaultItemLabel()

Return the label for the default item on the legend

Returns:

The label for the default item

setAnimationEffect

public void setAnimationEffect(java.lang.String animationEffect)

Specifies the animationEffect to use for ADS. Valid values are: Blink, Fade, Blink_And_Fade.

Parameters:

animationEffect - The animation Effect to use for ADS.

getAnimationEffect

public java.lang.String getAnimationEffect()

Return the animation effect for this theme

Returns:

The animation effect for this theme

setHoverBehavior

public void setHoverBehavior(java.lang.Integer hoverBehavior)

Specifies the behavior when user hovers over a point on the pointTheme Valid value of theme are: 0 -- Nothing will happen 1 -- A tooltip will be shown 2 -- An info window will be shown The default value is None.

Parameters:

hoverBehavior - The hoverBehavior for this point theme

getHoverBehavior

public java.lang.Integer getHoverBehavior()

Return the hover Behavior for this point Theme

Returns:

The hover Behavior for this point Theme

setCustomLegendContent

public final void setCustomLegendContent(LegendContent legendContent)

Set the custom Legend Content for this point Theme

Parameters:

legendContent - The custom legend content for this point Theme

getCustomLegendContent

public final LegendContent getCustomLegendContent()

Return the custom legend content for the point theme

Returns:

The custom legend content for this point theme

getCustomPointCallback

public final javax.el.MethodExpression getCustomPointCallback()

Return the customPointCallback for this point Theme.

Returns:

The customPointCallback for this point theme.

setCustomPointCallback

public final void setCustomPointCallback(javax.el.MethodExpression callback)

Specifies a callback for overriding the point. By using pointStyleItem, developers can only use images for the points in the pointTheme. This callback lets developer show custom HTML for each point. The DataContent object contains all the necessary information for developers to determine what to show for a point.

Parameters:

callback - The callback for overridding the point

getBuiltInImage

public java.lang.String getBuiltInImage()

setBuiltInImage

public void setBuiltInImage(java.lang.String pointImage)

setOverlayText

public void setOverlayText(int overlayText)

getOverlayText

public int getOverlayText()

getPointStyleItemFromValue

public PointStyleItem getPointStyleItemFromValue(java.lang.String category,
                                                 java.lang.Double value)

Hidden

For internal use only. Application developers should not use this

getPointStyleSet

public PointStyleSet getPointStyleSet()

getInternalThemeType

public java.lang.String getInternalThemeType()

Hidden

Specified by:

getInternalThemeType in class ThemeFOI

For internal use only. Application developers should not use this

convertHoverBehavior

public static final int convertHoverBehavior(java.lang.String hoverBehavior)

convertHoverBehaviorToString

public static final java.lang.String convertHoverBehaviorToString(int hoverBehavior)