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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class PointStyleItem
extends BIComplexAttributeBase

This complex attributes defines a point style item of a point theme.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	BUILTINIMAGE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DEFAULTPOINTSTYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HOVERIMAGEURL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	IMAGEURL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINESTYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ITEMVALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAXVALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MINVALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OVERLAYTEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OVERLAYTEXTCLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OVERLAYTEXTSTYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTEDIMAGEURL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORTLABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLECLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

PointStyleItem()

Method Summary

static int	convertOverlayText(java.lang.String overlayText)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getBuiltInImage()
java.lang.String	getHoverImageURL() Return the hover image's URL for this pointStyleItem
java.lang.String	getImageURL() Return the imageURL for this pointStyleItem
java.lang.String	getInlineStyle()
java.lang.String	getItemValue() Return the item value of this point style
double	getMaxValue() Return the upper bound for this point style item.
double	getMinValue() Return the lower bound value for this point style
int	getOverlayText()
java.lang.String	getOverlayTextClass()
java.lang.String	getOverlayTextStyle()
java.lang.Object	getProperty(org.apache.myfaces.trinidad.bean.PropertyKey key) Hidden
java.lang.String	getSelectedImageURL() Return the selected image's URL for this pointStyleItem
java.lang.String	getShortLabel() Return the label for this pointStyleItem
java.lang.String	getStyleClass()
boolean	isValueSet() Hidden
void	setBuiltInImage(java.lang.String builtInImage)
void	setHoverImageURL(java.lang.String imageURL) Specifies the selectedImageURL for this pointStyleItem.
void	setImageURL(java.lang.String imageURL) Specifies the imageURL for this pointStyleItem.
void	setInlineStyle(java.lang.String inlineStyle)
void	setItemValue(java.lang.String itemValue) Specifies the value associated with this point style.
void	setMaxValue(double maxValue) Specifies the upper bound value for this point style.
void	setMinValue(double minValue) Specifies the lower bound value for this point style.
void	setOverlayText(int overlayText)
void	setOverlayTextClass(java.lang.String overlayTextClass)
void	setOverlayTextStyle(java.lang.String textStyleClass)
void	setSelectedImageURL(java.lang.String imageURL) Specifies the selectedImageURL for this pointStyleItem.
void	setShortLabel(java.lang.String shortLabel) Specifies the label of this pointStyleItem on the legend if no itemValue is specified.
void	setStyleClass(java.lang.String styleClass)

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

TYPE

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

ITEMVALUE_KEY

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

MINVALUE_KEY

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

MAXVALUE_KEY

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

IMAGEURL_KEY

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

HOVERIMAGEURL_KEY

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

SELECTEDIMAGEURL_KEY

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

DEFAULTPOINTSTYLE_KEY

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

SHORTLABEL_KEY

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

BUILTINIMAGE_KEY

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

INLINESTYLE_KEY

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

STYLECLASS_KEY

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

OVERLAYTEXT_KEY

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

OVERLAYTEXTCLASS_KEY

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

OVERLAYTEXTSTYLE_KEY

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

Constructor Detail

PointStyleItem

public PointStyleItem()

Method Detail

setShortLabel

public void setShortLabel(java.lang.String shortLabel)

Specifies the label of this pointStyleItem on the legend if no itemValue is specified.

Parameters:

shortLabel - The legend's label for this pointStyleItem

getShortLabel

public java.lang.String getShortLabel()

Return the label for this pointStyleItem

Returns:

The label for this pointStyleItem

setImageURL

public void setImageURL(java.lang.String imageURL)

Specifies the imageURL for this pointStyleItem. If a GeoRowObject of the point theme matches this pointStyleItem, the point of the GeoRowObject will be displayed using the image in this imageURL.

Parameters:

imageURL - The imageURL for this pointStyleItem.

getImageURL

public java.lang.String getImageURL()

Return the imageURL for this pointStyleItem

Returns:

The imageURL for this pointStyleItem

setSelectedImageURL

public void setSelectedImageURL(java.lang.String imageURL)

Specifies the selectedImageURL for this pointStyleItem. If a GeoRowObject of the point theme matches this pointStyleItem, the image will be used as the selected Image for the point of the GeoRowObject. Hence, when the point is lied within the selected region that is defined by the user, the point will be displayed using the image defined in this attribute.

Parameters:

imageURL - The selected image's URL for this pointStyleItem

getSelectedImageURL

public java.lang.String getSelectedImageURL()

Return the selected image's URL for this pointStyleItem

Returns:

The selected image's URL for this pointStyleItem

setHoverImageURL

public void setHoverImageURL(java.lang.String imageURL)

Specifies the selectedImageURL for this pointStyleItem. If a GeoRowObject of the point theme matches this pointStyleItem, the image will be used as the hover Image for the point of the GeoRowObject. Hence, when the user hovers over the point, the image in hoverImageURL will be shown.

Parameters:

imageURL -

getHoverImageURL

public java.lang.String getHoverImageURL()

Return the hover image's URL for this pointStyleItem

Returns:

The hover image's URL for this pointStyleItem

setItemValue

public void setItemValue(java.lang.String itemValue)

Specifies the value associated with this point style. This attribute will used to match with the category of each GeoRowObject of the GeoModel of the pointTheme. Please use minValue and maxValue if the pointTheme's GeoModel does not have any category. The itemValue has higher priority than minValue and maxValue. If the category of a GeoRow Object equals the itemValue of a pointStyle, the pointStyle will be used even if the value of the GeoRowObject lies outside the range of value of the point style.

Parameters:

itemValue - The value associated with this point style.

getItemValue

public java.lang.String getItemValue()

Return the item value of this point style

Returns:

The item value of this point style item.

setMinValue

public void setMinValue(double minValue)

Specifies the lower bound value for this point style. Together with maxValue, this two attributes defines the range of value for this point style. ADF Map will check whether if the value of each GeoRowObject of the pointTheme's GeoModel lies within the range of value of each pointStyle. The itemValue has higher priority than minValue and maxValue. If the category of a GeoRow Object equals the itemValue of a pointStyle, the pointStyle will be used even if the value of the GeoRowObject lies outside the range of value of the point style.

Parameters:

minValue - The lower bound value for this point Style.

getMinValue

public double getMinValue()

Return the lower bound value for this point style

Returns:

The lower bound value for this point style item

setMaxValue

public void setMaxValue(double maxValue)

Specifies the upper bound value for this point style. Together with minValue, this two attributes defines the range of value for this point style. ADF Map will check whether if the value of each GeoRowObject of the pointTheme's GeoModel lies within the range of value of each pointStyle. The itemValue has higher priority than minValue and maxValue. If the category of a GeoRow Object equals the itemValue of a pointStyle, the pointStyle will be used even if the value of the GeoRowObject lies outside the range of value of the point style.

Parameters:

maxValue - The upper bound value for this point style item

getMaxValue

public double getMaxValue()

Return the upper bound for this point style item.

Returns:

The upper bound for this point style item.

setBuiltInImage

public void setBuiltInImage(java.lang.String builtInImage)

getBuiltInImage

public java.lang.String getBuiltInImage()

setOverlayText

public void setOverlayText(int overlayText)

getOverlayText

public int getOverlayText()

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

getInlineStyle

public java.lang.String getInlineStyle()

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getStyleClass

public java.lang.String getStyleClass()

setOverlayTextStyle

public void setOverlayTextStyle(java.lang.String textStyleClass)

getOverlayTextStyle

public java.lang.String getOverlayTextStyle()

setOverlayTextClass

public void setOverlayTextClass(java.lang.String overlayTextClass)

getOverlayTextClass

public java.lang.String getOverlayTextClass()

isValueSet

public boolean isValueSet()

Hidden

For internal use only. Application developers should not use this

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase

convertOverlayText

public static final int convertOverlayText(java.lang.String overlayText)

getProperty

public java.lang.Object getProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)

Hidden

Overrides:

getProperty in class BIComplexAttributeBase

For internal use only. Application developers should not use this