oracle.adfdt.view.dvt.binding.pattern.sparkchart

Class SparkItem

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.sparkchart.SparkItem

All Implemented Interfaces:

ExtendedProperties

public class SparkItem
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of a sparkItem.

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
SparkItem()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBinding() Description: Specifies a binding reference to store a specific instance of UISparkItem from a backing bean.
java.lang.String	getBorderColor() Description: Specifies the border color of the bar or data point.
java.lang.String	getColor() Description: Specifies the color of the bar or data point.
java.util.Date	getDate(java.text.DateFormat dFormat) Description: Specifies the date for this item.
java.lang.String	getDateAsString(java.text.DateFormat dFormat) Description: Specifies the date for this item.
java.lang.Object	getFloatValue() Description: Specifies the float value for this item in a floating bar spark chart.
java.lang.String	getId() Description: Specifies the identifier for the component
java.lang.String	getMarkerShape() Description: Specifies the shape of the data item marker.
java.lang.Number	getMarkerSize() Description: Specifies the size of the data item marker.
java.lang.String	getMarkerSizeAsString() Description: Specifies the size of the data item marker.
java.lang.String	getTagName()
java.lang.Object	getValue() Description: Specifies the value for this spark item.
boolean	isMarkerDisplayed() Description: Specifies whether a marker should be displayed for this data item.
java.lang.String	isMarkerDisplayedAsString() Description: Specifies whether a marker should be displayed for this data item.
boolean	isRendered() Description: Specifies whether the component is rendered.
java.lang.String	isRenderedAsString() Description: Specifies whether the component is rendered.
void	setBinding(java.lang.String binding) Description: Specifies a binding reference to store a specific instance of UISparkItem from a backing bean.
void	setBorderColor(java.lang.String borderColor) Description: Specifies the border color of the bar or data point.
void	setColor(java.lang.String color) Description: Specifies the color of the bar or data point.
void	setDate(java.util.Date date, java.text.DateFormat dFormat) Description: Specifies the date for this item.
void	setDateAsString(java.lang.String date, java.text.DateFormat dFormat) Description: Specifies the date for this item.
void	setFloatValue(java.lang.Object floatValue) Description: Specifies the float value for this item in a floating bar spark chart.
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setMarkerDisplayed(boolean markerDisplayed) Description: Specifies whether a marker should be displayed for this data item.
void	setMarkerDisplayedAsString(java.lang.String markerDisplayed) Description: Specifies whether a marker should be displayed for this data item.
void	setMarkerShape(java.lang.String markerShape) Description: Specifies the shape of the data item marker.
void	setMarkerSize(java.lang.Number markerSize) Description: Specifies the size of the data item marker.
void	setMarkerSizeAsString(java.lang.String markerSize) Description: Specifies the size of the data item marker.
void	setRendered(boolean rendered) Description: Specifies whether the component is rendered.
void	setRenderedAsString(java.lang.String rendered) Description: Specifies whether the component is rendered.
void	setValue(java.lang.Object value) Description: Specifies the value for this spark item.

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

SparkItem

public SparkItem()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getBinding

public java.lang.String getBinding()

Description: Specifies a binding reference to store a specific instance of UISparkItem from a backing bean. Set this attribute only to access code in a backing bean.

Returns:

the value of the binding attribute of the Tag this class represents.

setBinding

public void setBinding(java.lang.String binding)

Description: Specifies a binding reference to store a specific instance of UISparkItem from a backing bean. Set this attribute only to access code in a backing bean.

Parameters:

binding - the value of the binding attribute of the Tag this class represents.

getBorderColor

public java.lang.String getBorderColor()

Description: Specifies the border color of the bar or data point. For line and area chart types, markerDisplayed must be enabled to make the data items visible.

Returns:

the value of the borderColor attribute of the Tag this class represents.

setBorderColor

public void setBorderColor(java.lang.String borderColor)

Description: Specifies the border color of the bar or data point. For line and area chart types, markerDisplayed must be enabled to make the data items visible.

Parameters:

borderColor - the value of the borderColor attribute of the Tag this class represents.

getColor

public java.lang.String getColor()

Description: Specifies the color of the bar or data point. For line and area chart types, markerDisplayed must be enabled to make the data items visible.

Returns:

the value of the color attribute of the Tag this class represents.

setColor

public void setColor(java.lang.String color)

Description: Specifies the color of the bar or data point. For line and area chart types, markerDisplayed must be enabled to make the data items visible.

Parameters:

color - the value of the color attribute of the Tag this class represents.

getDate

public java.util.Date getDate(java.text.DateFormat dFormat)
                       throws java.lang.Exception

Description: Specifies the date for this item. The date should only be specified if the interval between data items is irregular. If the data appears at regular intervals, the date should not be specified.

Parameters:

dFormat - A DateFormat instance used to convert the Date type property.

Returns:

the value of the date attribute of the Tag this class represents.

Throws:

java.lang.Exception

setDate

public void setDate(java.util.Date date,
                    java.text.DateFormat dFormat)

Description: Specifies the date for this item. The date should only be specified if the interval between data items is irregular. If the data appears at regular intervals, the date should not be specified.

Parameters:

date - the value of the date attribute of the Tag this class represents.

dFormat - A DateFormat instance used to convert the Date type property.

getDateAsString

public java.lang.String getDateAsString(java.text.DateFormat dFormat)
                                 throws java.lang.Exception

Description: Specifies the date for this item. The date should only be specified if the interval between data items is irregular. If the data appears at regular intervals, the date should not be specified. This method is provided as a convenience to be able to retrieve an EL that was set on the date attribute.

Parameters:

dFormat - A DateFormat instance used to convert the Date type property.

Returns:

the value of the date attribute of the Tag this class represents.

Throws:

java.lang.Exception

setDateAsString

public void setDateAsString(java.lang.String date,
                            java.text.DateFormat dFormat)

Description: Specifies the date for this item. The date should only be specified if the interval between data items is irregular. If the data appears at regular intervals, the date should not be specified. This method is provided as a convenience to be able to set an EL on the date attribute.

Parameters:

date - the value of the date attribute of the Tag this class represents.

dFormat - A DateFormat instance used to convert the Date type property.

getFloatValue

public java.lang.Object getFloatValue()

Description: Specifies the float value for this item in a floating bar spark chart. If the spark chart subType is not floatingBar, this value is ignored. The value should ideally be specified as a java.lang.Number.

Returns:

the value of the floatValue attribute of the Tag this class represents.

setFloatValue

public void setFloatValue(java.lang.Object floatValue)

Description: Specifies the float value for this item in a floating bar spark chart. If the spark chart subType is not floatingBar, this value is ignored. The value should ideally be specified as a java.lang.Number.

Parameters:

floatValue - the value of the floatValue attribute of the Tag this class represents.

getId

public java.lang.String getId()

Description: Specifies the identifier for the component

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 the component

Parameters:

id - the value of the id attribute of the Tag this class represents.

isMarkerDisplayed

public boolean isMarkerDisplayed()

Description: Specifies whether a marker should be displayed for this data item.

Returns:

the value of the markerDisplayed attribute of the Tag this class represents.

setMarkerDisplayed

public void setMarkerDisplayed(boolean markerDisplayed)

Description: Specifies whether a marker should be displayed for this data item.

Parameters:

markerDisplayed - the value of the markerDisplayed attribute of the Tag this class represents.

isMarkerDisplayedAsString

public java.lang.String isMarkerDisplayedAsString()

Description: Specifies whether a marker should be displayed for this data item. This method is provided as a convenience to be able to retrieve an EL that was set on the markerDisplayed attribute.

Returns:

the value of the markerDisplayed attribute of the Tag this class represents.

setMarkerDisplayedAsString

public void setMarkerDisplayedAsString(java.lang.String markerDisplayed)

Description: Specifies whether a marker should be displayed for this data item. This method is provided as a convenience to be able to set an EL on the markerDisplayed attribute.

Parameters:

markerDisplayed - the value of the markerDisplayed attribute of the Tag this class represents.

getMarkerShape

public java.lang.String getMarkerShape()

Description: Specifies the shape of the data item marker.

Returns:

the value of the markerShape attribute of the Tag this class represents.

setMarkerShape

public void setMarkerShape(java.lang.String markerShape)

Description: Specifies the shape of the data item marker.

Parameters:

markerShape - the value of the markerShape attribute of the Tag this class represents.

getMarkerSize

public java.lang.Number getMarkerSize()

Description: Specifies the size of the data item marker.

Returns:

the value of the markerSize attribute of the Tag this class represents.

setMarkerSize

public void setMarkerSize(java.lang.Number markerSize)

Description: Specifies the size of the data item marker.

Parameters:

markerSize - the value of the markerSize attribute of the Tag this class represents.

getMarkerSizeAsString

public java.lang.String getMarkerSizeAsString()

Description: Specifies the size of the data item marker. This method is provided as a convenience to be able to retrieve an EL that was set on the markerSize attribute.

Returns:

the value of the markerSize attribute of the Tag this class represents.

setMarkerSizeAsString

public void setMarkerSizeAsString(java.lang.String markerSize)

Description: Specifies the size of the data item marker. This method is provided as a convenience to be able to set an EL on the markerSize attribute.

Parameters:

markerSize - the value of the markerSize attribute of the Tag this class represents.

isRendered

public boolean isRendered()

Description: Specifies whether the component is rendered.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRendered

public void setRendered(boolean rendered)

Description: Specifies whether the component is rendered.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Specifies whether the component is rendered. This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: Specifies whether the component is rendered. This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

getValue

public java.lang.Object getValue()

Description: Specifies the value for this spark item. The value should ideally be specified as a java.lang.Number.

Returns:

the value of the value attribute of the Tag this class represents.

setValue

public void setValue(java.lang.Object value)

Description: Specifies the value for this spark item. The value should ideally be specified as a java.lang.Number.

Parameters:

value - the value of the value attribute of the Tag this class represents.