MapPointStyleItem (Oracle Fusion Middleware Design Time Java API Reference for Oracle ADF Faces and Data Visualization Components)

java.lang.Object
- oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties
- - oracle.adfdt.view.dvt.binding.pattern.map.MapPointStyleItem

All Implemented Interfaces:

ExtendedProperties
```
public class MapPointStyleItem
extends ComplexExtendedProperties
```
A set of accessor methods that allow the user to change the structure and functionality of a mapPointStyleItem.

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

MapPointStyleItem()

Constructors
Constructor and Description
`MapPointStyleItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBuiltInImage()` Description: Specifies the built-in images for this point style item.
`java.lang.String`	`getHoverImageURL()` Description: Specifies the selectedImageURL for this pointStyleItem.
`java.lang.String`	`getId()` Description: Specifies the identifier for a point style item
`java.lang.String`	`getImageURL()` Description: Specifies the imageURL for this pointStyleItem.
`java.lang.String`	`getInlineStyle()` Description: Specifies the inlineStyle of the image of each point in the pointTheme.
`java.lang.String`	`getItemValue()` Description: Specifies the value associated with this point style.
`double`	`getMaxValue()` Description: Specifies the upper bound value for this point style.
`java.lang.String`	`getMaxValueAsString()` Description: Specifies the upper bound value for this point style.
`double`	`getMinValue()` Description: Specifies the lower bound value for this point style.
`java.lang.String`	`getMinValueAsString()` Description: Specifies the lower bound value for this point style.
`java.lang.String`	`getOverlayClass()` Description: Specifies the style class for the overlayText
`java.lang.String`	`getOverlayStyle()` Description: Attribute for defining the inlineStyle of the overlayText
`java.lang.String`	`getOverlayText()` Description: Specifies what text will appear over the displayed points.
`java.lang.String`	`getSelectedImageURL()` Description: Specifies the selectedImageURL for this pointStyleItem.
`java.lang.String`	`getShortLabel()` Description: Specifies the label of this pointStyleItem on the legend if no itemValue is specified.
`java.lang.String`	`getStyleClass()` Description: Set a CSS style class to use for the points in the pointTheme.
`java.lang.String`	`getTagName()`
`boolean`	`isIsDefault()` Description: Specifies whether this point style item overrides the default style.
`java.lang.String`	`isIsDefaultAsString()` Description: Specifies whether this point style item overrides the default style.
`void`	`setBuiltInImage(java.lang.String builtInImage)` Description: Specifies the built-in images for this point style item.
`void`	`setHoverImageURL(java.lang.String hoverImageURL)` Description: Specifies the selectedImageURL for this pointStyleItem.
`void`	`setId(java.lang.String id)` Description: Specifies the identifier for a point style item
`void`	`setImageURL(java.lang.String imageURL)` Description: Specifies the imageURL for this pointStyleItem.
`void`	`setInlineStyle(java.lang.String inlineStyle)` Description: Specifies the inlineStyle of the image of each point in the pointTheme.
`void`	`setIsDefault(boolean isDefault)` Description: Specifies whether this point style item overrides the default style.
`void`	`setIsDefaultAsString(java.lang.String isDefault)` Description: Specifies whether this point style item overrides the default style.
`void`	`setItemValue(java.lang.String itemValue)` Description: Specifies the value associated with this point style.
`void`	`setMaxValue(double maxValue)` Description: Specifies the upper bound value for this point style.
`void`	`setMaxValueAsString(java.lang.String maxValue)` Description: Specifies the upper bound value for this point style.
`void`	`setMinValue(double minValue)` Description: Specifies the lower bound value for this point style.
`void`	`setMinValueAsString(java.lang.String minValue)` Description: Specifies the lower bound value for this point style.
`void`	`setOverlayClass(java.lang.String overlayClass)` Description: Specifies the style class for the overlayText
`void`	`setOverlayStyle(java.lang.String overlayStyle)` Description: Attribute for defining the inlineStyle of the overlayText
`void`	`setOverlayText(java.lang.String overlayText)` Description: Specifies what text will appear over the displayed points.
`void`	`setSelectedImageURL(java.lang.String selectedImageURL)` Description: Specifies the selectedImageURL for this pointStyleItem.
`void`	`setShortLabel(java.lang.String shortLabel)` Description: Specifies the label of this pointStyleItem on the legend if no itemValue is specified.
`void`	`setStyleClass(java.lang.String styleClass)` Description: Set a CSS style class to use for the points in the pointTheme.

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
  - MapPointStyleItem
```
public MapPointStyleItem()
```
- Method Detail
  - getTagName
```
public java.lang.String getTagName()
```
    Specified by:
    
    getTagName in class ComplexExtendedProperties
  - getBuiltInImage
```
public java.lang.String getBuiltInImage()
```
    Description: Specifies the built-in images for this point style item. Each built in image has a set of normal images, selected images and hovered images Built-in image can take the value of shape_color where shape is one of the following: SquareBubble PointerBubble DiagonalSquare Bubble Flag Hexagon SignOne PushPin SignTwo TrafficSignDiagonal TrafficSign 3DCube whereas color is one of the following: Orange Blue Green Red Purple For example, it can be Bubble_Orange or SignTwo_Blue. Other than those, built-in image can also be one of the following: OrangePinLarge OrangePinMedium OrangePinSmall Ball_Orange Pin_Large_Orange Pin_Medium_Orange Pin_Small_Orange
    
    Returns:
    
    the value of the builtInImage attribute of the Tag this class represents.
  - setBuiltInImage
```
public void setBuiltInImage(java.lang.String builtInImage)
```
    Description: Specifies the built-in images for this point style item. Each built in image has a set of normal images, selected images and hovered images Built-in image can take the value of shape_color where shape is one of the following: SquareBubble PointerBubble DiagonalSquare Bubble Flag Hexagon SignOne PushPin SignTwo TrafficSignDiagonal TrafficSign 3DCube whereas color is one of the following: Orange Blue Green Red Purple For example, it can be Bubble_Orange or SignTwo_Blue. Other than those, built-in image can also be one of the following: OrangePinLarge OrangePinMedium OrangePinSmall Ball_Orange Pin_Large_Orange Pin_Medium_Orange Pin_Small_Orange
    
    Parameters:
    
    builtInImage - the value of the builtInImage attribute of the Tag this class represents.
  - getHoverImageURL
```
public java.lang.String getHoverImageURL()
```
    Description: 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.
    
    Returns:
    
    the value of the hoverImageURL attribute of the Tag this class represents.
  - setHoverImageURL
```
public void setHoverImageURL(java.lang.String hoverImageURL)
```
    Description: 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:
    
    hoverImageURL - the value of the hoverImageURL attribute of the Tag this class represents.
  - getId
```
public java.lang.String getId()
```
    Description: Specifies the identifier for a point style item
    
    Returns:
    
    the value of the id attribute of the Tag this class represents.
  - setId
```
public void setId(java.lang.String id)
```
    Description: Specifies the identifier for a point style item
    
    Parameters:
    
    id - the value of the id attribute of the Tag this class represents.
  - getImageURL
```
public java.lang.String getImageURL()
```
    Description: 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.
    
    Returns:
    
    the value of the imageURL attribute of the Tag this class represents.
  - setImageURL
```
public void setImageURL(java.lang.String imageURL)
```
    Description: 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 value of the imageURL attribute of the Tag this class represents.
  - getInlineStyle
```
public java.lang.String getInlineStyle()
```
    Description: Specifies the inlineStyle of the image of each point in the pointTheme. This attribute accepts any valid CSS style value. Usually, this attribute is used to set horizontal and vertical offset for the images. (e.g. position:relative;top:20px)
    
    Returns:
    
    the value of the inlineStyle attribute of the Tag this class represents.
  - setInlineStyle
```
public void setInlineStyle(java.lang.String inlineStyle)
```
    Description: Specifies the inlineStyle of the image of each point in the pointTheme. This attribute accepts any valid CSS style value. Usually, this attribute is used to set horizontal and vertical offset for the images. (e.g. position:relative;top:20px)
    
    Parameters:
    
    inlineStyle - the value of the inlineStyle attribute of the Tag this class represents.
  - isIsDefault
```
public boolean isIsDefault()
```
    Description: Specifies whether this point style item overrides the default style. For example, to specify a different default image for all the points in the point theme, set this attribute to true, and use the desired imageURL in the imageURL attribute. The default value is false.
    
    Returns:
    
    the value of the isDefault attribute of the Tag this class represents.
  - setIsDefault
```
public void setIsDefault(boolean isDefault)
```
    Description: Specifies whether this point style item overrides the default style. For example, to specify a different default image for all the points in the point theme, set this attribute to true, and use the desired imageURL in the imageURL attribute. The default value is false.
    
    Parameters:
    
    isDefault - the value of the isDefault attribute of the Tag this class represents.
  - isIsDefaultAsString
```
public java.lang.String isIsDefaultAsString()
```
    Description: Specifies whether this point style item overrides the default style. For example, to specify a different default image for all the points in the point theme, set this attribute to true, and use the desired imageURL in the imageURL attribute. The default value is false. This method is provided as a convenience to be able to retrieve an EL that was set on the isDefault attribute.
    
    Returns:
    
    the value of the isDefault attribute of the Tag this class represents.
  - setIsDefaultAsString
```
public void setIsDefaultAsString(java.lang.String isDefault)
```
    Description: Specifies whether this point style item overrides the default style. For example, to specify a different default image for all the points in the point theme, set this attribute to true, and use the desired imageURL in the imageURL attribute. The default value is false. This method is provided as a convenience to be able to set an EL on the isDefault attribute.
    
    Parameters:
    
    isDefault - the value of the isDefault attribute of the Tag this class represents.
  - getItemValue
```
public java.lang.String getItemValue()
```
    Description: 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.
    
    Returns:
    
    the value of the itemValue attribute of the Tag this class represents.
  - setItemValue
```
public void setItemValue(java.lang.String itemValue)
```
    Description: 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 of the itemValue attribute of the Tag this class represents.
  - getMaxValue
```
public double getMaxValue()
                   throws java.lang.NumberFormatException
```
    Description: 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. The default is Double.MAX_VALUE.
    
    Returns:
    
    the value of the maxValue attribute of the Tag this class represents.
    
    Throws:
    
    java.lang.NumberFormatException
  - setMaxValue
```
public void setMaxValue(double maxValue)
```
    Description: 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. The default is Double.MAX_VALUE.
    
    Parameters:
    
    maxValue - the value of the maxValue attribute of the Tag this class represents.
  - getMaxValueAsString
```
public java.lang.String getMaxValueAsString()
                                     throws java.lang.NumberFormatException
```
    Description: 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. The default is Double.MAX_VALUE. This method is provided as a convenience to be able to retrieve an EL that was set on the maxValue attribute.
    
    Returns:
    
    the value of the maxValue attribute of the Tag this class represents.
    
    Throws:
    
    java.lang.NumberFormatException
  - setMaxValueAsString
```
public void setMaxValueAsString(java.lang.String maxValue)
```
    Description: 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. The default is Double.MAX_VALUE. This method is provided as a convenience to be able to set an EL on the maxValue attribute.
    
    Parameters:
    
    maxValue - the value of the maxValue attribute of the Tag this class represents.
  - getMinValue
```
public double getMinValue()
                   throws java.lang.NumberFormatException
```
    Description: 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. The default is Double.MIN_VALUE.
    
    Returns:
    
    the value of the minValue attribute of the Tag this class represents.
    
    Throws:
    
    java.lang.NumberFormatException
  - setMinValue
```
public void setMinValue(double minValue)
```
    Description: 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. The default is Double.MIN_VALUE.
    
    Parameters:
    
    minValue - the value of the minValue attribute of the Tag this class represents.
  - getMinValueAsString
```
public java.lang.String getMinValueAsString()
                                     throws java.lang.NumberFormatException
```
    Description: 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. The default is Double.MIN_VALUE. This method is provided as a convenience to be able to retrieve an EL that was set on the minValue attribute.
    
    Returns:
    
    the value of the minValue attribute of the Tag this class represents.
    
    Throws:
    
    java.lang.NumberFormatException
  - setMinValueAsString
```
public void setMinValueAsString(java.lang.String minValue)
```
    Description: 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. The default is Double.MIN_VALUE. This method is provided as a convenience to be able to set an EL on the minValue attribute.
    
    Parameters:
    
    minValue - the value of the minValue attribute of the Tag this class represents.
  - getOverlayClass
```
public java.lang.String getOverlayClass()
```
    Description: Specifies the style class for the overlayText
    
    Returns:
    
    the value of the overlayClass attribute of the Tag this class represents.
  - setOverlayClass
```
public void setOverlayClass(java.lang.String overlayClass)
```
    Description: Specifies the style class for the overlayText
    
    Parameters:
    
    overlayClass - the value of the overlayClass attribute of the Tag this class represents.
  - getOverlayStyle
```
public java.lang.String getOverlayStyle()
```
    Description: Attribute for defining the inlineStyle of the overlayText
    
    Returns:
    
    the value of the overlayStyle attribute of the Tag this class represents.
  - setOverlayStyle
```
public void setOverlayStyle(java.lang.String overlayStyle)
```
    Description: Attribute for defining the inlineStyle of the overlayText
    
    Parameters:
    
    overlayStyle - the value of the overlayStyle attribute of the Tag this class represents.
  - getOverlayText
```
public java.lang.String getOverlayText()
```
    Description: Specifies what text will appear over the displayed points. Valid values are: None (Default), RowIndex
    
    Returns:
    
    the value of the overlayText attribute of the Tag this class represents.
  - setOverlayText
```
public void setOverlayText(java.lang.String overlayText)
```
    Description: Specifies what text will appear over the displayed points. Valid values are: None (Default), RowIndex
    
    Parameters:
    
    overlayText - the value of the overlayText attribute of the Tag this class represents.
  - getSelectedImageURL
```
public java.lang.String getSelectedImageURL()
```
    Description: 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.
    
    Returns:
    
    the value of the selectedImageURL attribute of the Tag this class represents.
  - setSelectedImageURL
```
public void setSelectedImageURL(java.lang.String selectedImageURL)
```
    Description: 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:
    
    selectedImageURL - the value of the selectedImageURL attribute of the Tag this class represents.
  - getShortLabel
```
public java.lang.String getShortLabel()
```
    Description: Specifies the label of this pointStyleItem on the legend if no itemValue is specified.
    
    Returns:
    
    the value of the shortLabel attribute of the Tag this class represents.
  - setShortLabel
```
public void setShortLabel(java.lang.String shortLabel)
```
    Description: Specifies the label of this pointStyleItem on the legend if no itemValue is specified.
    
    Parameters:
    
    shortLabel - the value of the shortLabel attribute of the Tag this class represents.
  - getStyleClass
```
public java.lang.String getStyleClass()
```
    Description: Set a CSS style class to use for the points in the pointTheme.
    
    Returns:
    
    the value of the styleClass attribute of the Tag this class represents.
  - setStyleClass
```
public void setStyleClass(java.lang.String styleClass)
```
    Description: Set a CSS style class to use for the points in the pointTheme.
    
    Parameters:
    
    styleClass - the value of the styleClass attribute of the Tag this class represents.

Class MapPointStyleItem

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

MapPointStyleItem

Method Detail

getTagName

getBuiltInImage

setBuiltInImage

getHoverImageURL

setHoverImageURL

getId

setId

getImageURL

setImageURL

getInlineStyle

setInlineStyle

isIsDefault

setIsDefault

isIsDefaultAsString

setIsDefaultAsString

getItemValue

setItemValue

getMaxValue

setMaxValue

getMaxValueAsString

setMaxValueAsString

getMinValue

setMinValue

getMinValueAsString

setMinValueAsString

getOverlayClass

setOverlayClass

getOverlayStyle

setOverlayStyle

getOverlayText

setOverlayText

getSelectedImageURL

setSelectedImageURL

getShortLabel

setShortLabel

getStyleClass

setStyleClass