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

Class SparkChartExtendedProperties

java.lang.Object

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

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

All Implemented Interfaces:

ExtendedProperties

public class SparkChartExtendedProperties
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of an sparkChart.

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

Method Summary

Methods

Modifier and Type	Method and Description
int	getAnimationDuration() Description: Specifies the animation duration in milliseconds.
java.lang.String	getAnimationDurationAsString() Description: Specifies the animation duration in milliseconds.
java.lang.String	getAnimationOnDataChange() Description: Specifies the type of animation to apply on data change.
java.lang.String	getAnimationOnDisplay() Description: Specifies the type of animation to apply when the component is initially displayed.
AttributeFormat	getAttributeFormat() Description: Specifies formatting for an attribute matching the name property.
java.lang.String	getAxisScaledFromBaseline() Description: Specifies whether the axis is scaled to include the baseline value of zero.
java.lang.String	getBinding() Description: Specifies a binding reference to store a specific instance of RichSparkChart from a backing bean.
java.lang.String	getClickAction() Description: Refers to a backing bean method that performs navigation processing for the graph and returns an outcome String.
java.lang.String	getClickListener() Description:
java.lang.String	getColor() Description: Specifies the color of the bars, line, or area in the sparkchart.
java.lang.String	getContentDelivery() Description: Specifies whether to fetch content with page load or after page load.
java.lang.String	getFirstMarkerColor() Description: Specifies the color of the first marker of the sparkchart.
java.lang.String	getHighMarkerColor() Description: Specifies the color of the high value marker of the sparkchart.
java.lang.String	getId() Description: Specifies the identifier for the component
java.lang.String	getInlineStyle() Description: Style of the outer element(enclosing div) of the component
java.lang.String	getLastMarkerColor() Description: Specifies the color of the last marker of the sparkchart.
java.lang.String	getLowMarkerColor() Description: Specifies the color of the low value marker of the sparkchart.
java.lang.String	getMarkers() Description: Specifies the markers to display on a sparkchart.
java.lang.String	getNoDataErrorText() Description: Specifies error text to display when graph has no data.
java.lang.String[]	getPartialTriggers() Description: the IDs of the components that should trigger a partial update.
ReferenceObjectSet	getReferenceObjectSet() Description: Wraps an unlimited number of reference objects for a given graph.
java.lang.String	getShortDesc() Description: Specifies the short description of the graph.
java.util.List<SparkItem>	getSparkItem() Description: Use the sparkItem tag to represent and provide data for a bar or marker in an ADF spark chart.
java.lang.String	getStyleClass() Description: Sets a CSS style class to use for this component.
java.lang.String	getSubType() Description: Specifies the type of spark chart.
java.lang.String	getTagName()
ThresholdSet	getThresholdSet() Description: Use the thresholdSet tag to wrap all the threshold tags for a gauge or spark chart.
java.lang.String	getTooltip() Description: Specifies the tooltip text to display for this sparkchart.
boolean	isRendered() Description: Specifies whether the component is rendered.
java.lang.String	isRenderedAsString() Description: Specifies whether the component is rendered.
void	setAnimationDuration(int animationDuration) Description: Specifies the animation duration in milliseconds.
void	setAnimationDurationAsString(java.lang.String animationDuration) Description: Specifies the animation duration in milliseconds.
void	setAnimationOnDataChange(java.lang.String animationOnDataChange) Description: Specifies the type of animation to apply on data change.
void	setAnimationOnDisplay(java.lang.String animationOnDisplay) Description: Specifies the type of animation to apply when the component is initially displayed.
void	setAttributeFormat(AttributeFormat attributeFormat) Description: Specifies formatting for an attribute matching the name property.
void	setAxisScaledFromBaseline(java.lang.String axisScaledFromBaseline) Description: Specifies whether the axis is scaled to include the baseline value of zero.
void	setBinding(java.lang.String binding) Description: Specifies a binding reference to store a specific instance of RichSparkChart from a backing bean.
void	setClickAction(java.lang.String clickAction) Description: Refers to a backing bean method that performs navigation processing for the graph and returns an outcome String.
void	setClickListener(java.lang.String clickListener) Description:
void	setColor(java.lang.String color) Description: Specifies the color of the bars, line, or area in the sparkchart.
void	setContentDelivery(java.lang.String contentDelivery) Description: Specifies whether to fetch content with page load or after page load.
void	setFirstMarkerColor(java.lang.String firstMarkerColor) Description: Specifies the color of the first marker of the sparkchart.
void	setHighMarkerColor(java.lang.String highMarkerColor) Description: Specifies the color of the high value marker of the sparkchart.
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setInlineStyle(java.lang.String inlineStyle) Description: Style of the outer element(enclosing div) of the component
void	setLastMarkerColor(java.lang.String lastMarkerColor) Description: Specifies the color of the last marker of the sparkchart.
void	setLowMarkerColor(java.lang.String lowMarkerColor) Description: Specifies the color of the low value marker of the sparkchart.
void	setMarkers(java.lang.String markers) Description: Specifies the markers to display on a sparkchart.
void	setNoDataErrorText(java.lang.String noDataErrorText) Description: Specifies error text to display when graph has no data.
void	setPartialTriggers(java.lang.String[] partialTriggers) Description: the IDs of the components that should trigger a partial update.
void	setReferenceObjectSet(ReferenceObjectSet referenceObjectSet) Description: Wraps an unlimited number of reference objects for a given graph.
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	setShortDesc(java.lang.String shortDesc) Description: Specifies the short description of the graph.
void	setSparkItem(java.util.List<SparkItem> sparkItem) Description: Use the sparkItem tag to represent and provide data for a bar or marker in an ADF spark chart.
void	setStyleClass(java.lang.String styleClass) Description: Sets a CSS style class to use for this component.
void	setSubType(java.lang.String subType) Description: Specifies the type of spark chart.
void	setThresholdSet(ThresholdSet thresholdSet) Description: Use the thresholdSet tag to wrap all the threshold tags for a gauge or spark chart.
void	setTooltip(java.lang.String tooltip) Description: Specifies the tooltip text to display for this sparkchart.

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

SparkChartExtendedProperties

public SparkChartExtendedProperties()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getAnimationDuration

public int getAnimationDuration()
                         throws java.lang.NumberFormatException

Description: Specifies the animation duration in milliseconds. The default value is 500. For data change animations with multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value.

Returns:

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

Throws:

java.lang.NumberFormatException

setAnimationDuration

public void setAnimationDuration(int animationDuration)

Description: Specifies the animation duration in milliseconds. The default value is 500. For data change animations with multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value.

Parameters:

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

getAnimationDurationAsString

public java.lang.String getAnimationDurationAsString()
                                              throws java.lang.NumberFormatException

Description: Specifies the animation duration in milliseconds. The default value is 500. For data change animations with multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value. This method is provided as a convenience to be able to retrieve an EL that was set on the animationDuration attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setAnimationDurationAsString

public void setAnimationDurationAsString(java.lang.String animationDuration)

Description: Specifies the animation duration in milliseconds. The default value is 500. For data change animations with multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value. This method is provided as a convenience to be able to set an EL on the animationDuration attribute.

Parameters:

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

getAnimationOnDataChange

public java.lang.String getAnimationOnDataChange()

Description: Specifies the type of animation to apply on data change. Valid values are "none" (Default) and "auto".

Returns:

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

setAnimationOnDataChange

public void setAnimationOnDataChange(java.lang.String animationOnDataChange)

Description: Specifies the type of animation to apply on data change. Valid values are "none" (Default) and "auto".

Parameters:

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

getAnimationOnDisplay

public java.lang.String getAnimationOnDisplay()

Description: Specifies the type of animation to apply when the component is initially displayed. Valid values are: none - (Default) Does not apply any initial rendering effect auto alphaFade

Returns:

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

setAnimationOnDisplay

public void setAnimationOnDisplay(java.lang.String animationOnDisplay)

Description: Specifies the type of animation to apply when the component is initially displayed. Valid values are: none - (Default) Does not apply any initial rendering effect auto alphaFade

Parameters:

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

getAxisScaledFromBaseline

public java.lang.String getAxisScaledFromBaseline()

Description: Specifies whether the axis is scaled to include the baseline value of zero. Valid values are on (default) and off.

Returns:

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

setAxisScaledFromBaseline

public void setAxisScaledFromBaseline(java.lang.String axisScaledFromBaseline)

Description: Specifies whether the axis is scaled to include the baseline value of zero. Valid values are on (default) and off.

Parameters:

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

getBinding

public java.lang.String getBinding()

Description: Specifies a binding reference to store a specific instance of RichSparkChart from a backing bean. Set this attribute only to access code in a backing bean. For example, to reference a spark chart component in the sampleGraph managed bean, use the following code: binding="#{sampleGraph.sparkChart}"

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 RichSparkChart from a backing bean. Set this attribute only to access code in a backing bean. For example, to reference a spark chart component in the sampleGraph managed bean, use the following code: binding="#{sampleGraph.sparkChart}"

Parameters:

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

getClickAction

public java.lang.String getClickAction()

Description: Refers to a backing bean method that performs navigation processing for the graph and returns an outcome String. A static outcome String can also be specified. The JSF NavigationHandler selects the page to display next by matching the outcome String against the navigation rules in the application configuration resource file. The application writes the Navigation rules.

Returns:

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

setClickAction

public void setClickAction(java.lang.String clickAction)

Description: Refers to a backing bean method that performs navigation processing for the graph and returns an outcome String. A static outcome String can also be specified. The JSF NavigationHandler selects the page to display next by matching the outcome String against the navigation rules in the application configuration resource file. The application writes the Navigation rules.

Parameters:

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

getClickListener

public java.lang.String getClickListener()

Description:

Returns:

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

setClickListener

public void setClickListener(java.lang.String clickListener)

Description:

Parameters:

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

getColor

public java.lang.String getColor()

Description: Specifies the color of the bars, line, or area in the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

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 bars, line, or area in the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Parameters:

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

getContentDelivery

public java.lang.String getContentDelivery()

Description: Specifies whether to fetch content with page load or after page load. Valid values are lazy (default) and immediate.

Returns:

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

setContentDelivery

public void setContentDelivery(java.lang.String contentDelivery)

Description: Specifies whether to fetch content with page load or after page load. Valid values are lazy (default) and immediate.

Parameters:

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

getFirstMarkerColor

public java.lang.String getFirstMarkerColor()

Description: Specifies the color of the first marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Returns:

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

setFirstMarkerColor

public void setFirstMarkerColor(java.lang.String firstMarkerColor)

Description: Specifies the color of the first marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Parameters:

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

getHighMarkerColor

public java.lang.String getHighMarkerColor()

Description: Specifies the color of the high value marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Returns:

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

setHighMarkerColor

public void setHighMarkerColor(java.lang.String highMarkerColor)

Description: Specifies the color of the high value marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Parameters:

highMarkerColor - the value of the highMarkerColor 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.

getInlineStyle

public java.lang.String getInlineStyle()

Description: Style of the outer element(enclosing div) of the component

Returns:

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

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Description: Style of the outer element(enclosing div) of the component

Parameters:

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

getLastMarkerColor

public java.lang.String getLastMarkerColor()

Description: Specifies the color of the last marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Returns:

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

setLastMarkerColor

public void setLastMarkerColor(java.lang.String lastMarkerColor)

Description: Specifies the color of the last marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Parameters:

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

getLowMarkerColor

public java.lang.String getLowMarkerColor()

Description: Specifies the color of the low value marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Returns:

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

setLowMarkerColor

public void setLowMarkerColor(java.lang.String lowMarkerColor)

Description: Specifies the color of the low value marker of the sparkchart. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Parameters:

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

getMarkers

public java.lang.String getMarkers()

Description: Specifies the markers to display on a sparkchart. Valid values are combinations of the following constants, separated by spaces. For example, markers="auto high last". The default value is "auto". none - does not display markers auto - the graph decides whether to display markers and which markers to display high - displays a marker at the greatest value low - displays a marker at the smallest value first - displays a marker at the first value last - displays a marker at the last value

Returns:

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

setMarkers

public void setMarkers(java.lang.String markers)

Description: Specifies the markers to display on a sparkchart. Valid values are combinations of the following constants, separated by spaces. For example, markers="auto high last". The default value is "auto". none - does not display markers auto - the graph decides whether to display markers and which markers to display high - displays a marker at the greatest value low - displays a marker at the smallest value first - displays a marker at the first value last - displays a marker at the last value

Parameters:

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

getNoDataErrorText

public java.lang.String getNoDataErrorText()

Description: Specifies error text to display when graph has no data.

Returns:

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

setNoDataErrorText

public void setNoDataErrorText(java.lang.String noDataErrorText)

Description: Specifies error text to display when graph has no data.

Parameters:

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

getPartialTriggers

public java.lang.String[] getPartialTriggers()

Description: the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Returns:

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

setPartialTriggers

public void setPartialTriggers(java.lang.String[] partialTriggers)

Description: the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:

partialTriggers - the value of the partialTriggers 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.

getShortDesc

public java.lang.String getShortDesc()

Description: Specifies the short description of the graph. This is particularly useful in the screen reader mode.

Returns:

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

setShortDesc

public void setShortDesc(java.lang.String shortDesc)

Description: Specifies the short description of the graph. This is particularly useful in the screen reader mode.

Parameters:

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

getStyleClass

public java.lang.String getStyleClass()

Description: Sets a CSS style class to use for this component. Note that width and height should be set using the inlineStyle property.

Returns:

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

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Description: Sets a CSS style class to use for this component. Note that width and height should be set using the inlineStyle property.

Parameters:

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

getSubType

public java.lang.String getSubType()

Description: Specifies the type of spark chart. Valid values are: area - Absolute area graph bar - Vertical bar graph floatingBar - Vertical floating stacked bar graph line (Default) - Absolute line graph

Returns:

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

setSubType

public void setSubType(java.lang.String subType)

Description: Specifies the type of spark chart. Valid values are: area - Absolute area graph bar - Vertical bar graph floatingBar - Vertical floating stacked bar graph line (Default) - Absolute line graph

Parameters:

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

getTooltip

public java.lang.String getTooltip()

Description: Specifies the tooltip text to display for this sparkchart.

Returns:

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

setTooltip

public void setTooltip(java.lang.String tooltip)

Description: Specifies the tooltip text to display for this sparkchart.

Parameters:

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

getAttributeFormat

public AttributeFormat getAttributeFormat()

Description: Specifies formatting for an attribute matching the name property.

Returns:

the AttributeFormat of the Tag this class represents.

setAttributeFormat

public void setAttributeFormat(AttributeFormat attributeFormat)

Description: Specifies formatting for an attribute matching the name property.

Parameters:

attributeFormat - the AttributeFormat of the Tag this class represents.

getThresholdSet

public ThresholdSet getThresholdSet()

Description: Use the thresholdSet tag to wrap all the threshold tags for a gauge or spark chart. An infinite number of thresholds can be included in a thresholdSet tag.

Returns:

the ThresholdSet of the Tag this class represents.

setThresholdSet

public void setThresholdSet(ThresholdSet thresholdSet)

Description: Use the thresholdSet tag to wrap all the threshold tags for a gauge or spark chart. An infinite number of thresholds can be included in a thresholdSet tag.

Parameters:

thresholdSet - the ThresholdSet of the Tag this class represents.

getReferenceObjectSet

public ReferenceObjectSet getReferenceObjectSet()

Description: Wraps an unlimited number of reference objects for a given graph.

Returns:

the ReferenceObjectSet of the Tag this class represents.

setReferenceObjectSet

public void setReferenceObjectSet(ReferenceObjectSet referenceObjectSet)

Description: Wraps an unlimited number of reference objects for a given graph.

Parameters:

referenceObjectSet - the ReferenceObjectSet of the Tag this class represents.

getSparkItem

public java.util.List<SparkItem> getSparkItem()

Description: Use the sparkItem tag to represent and provide data for a bar or marker in an ADF spark chart.

Returns:

a list of SparkItem objects.

setSparkItem

public void setSparkItem(java.util.List<SparkItem> sparkItem)

Description: Use the sparkItem tag to represent and provide data for a bar or marker in an ADF spark chart.

Parameters:

sparkItem - a list of SparkItem objects.