oracle.adfdt.view.dvt.binding.pattern.graph

Class StockGraphOptions

java.lang.Object

oracle.adfdt.view.common.binding.creator.v2.PatternOptions

oracle.adfdt.view.common.binding.creator.v2.ExtendedPatternOptions

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

oracle.adfdt.view.dvt.binding.pattern.graph.GraphOptions

oracle.adfdt.view.dvt.binding.pattern.graph.StockGraphOptions

public class StockGraphOptions
extends GraphOptions

Method Summary

Modifier and Type	Method and Description
static StockGraphOptions	cloneFrom(GraphOptions options) Creates an options class from the specified options class, transferring any common properties
int	getAnimationOnDataChange() Retrieves the type of data change animation to apply.
int	getAnimationOnDisplay() Retrieves the type of initial rendering effect to apply.
GraphBindingOptions	getBindingOptions() Returns the BindingOptions of this pattern if present.
StockGraphExtendedProperties	getExtendedProperties() Returns the ExtendedProperties of this pattern if present.
java.lang.String	getGraphSubType() Retrieves the subtype of graph.Valid values are:
java.lang.String	getGraphType() Retrieves the primary graph type
java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition>	getGroupsEdge() Retrieves the layers for the groups edge
int	getImageFormat() Retrieves the format of graph image.
java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition>	getSeriesEdge() Retrieves the layers for the series edge
boolean	isRowSelection() Retrieves whether iterator currency should be set in response to graph selection
boolean	isThreeDEffect() Deprecated. The "threeDEffect" attribute is not a valid attribute for the dvt:stockGraph tag.
void	setAnimationOnDataChange(int animationOnDataChange) Specifies the type of data change animation to apply.
void	setAnimationOnDisplay(int animationOnDisplay) Specifies the type of initial rendering effect to apply.
void	setGraphSubType(java.lang.String graphSubType) Specifies the subtype of graph.
void	setGroupsEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> groupsEdge) Specifies the layers for the groups edge
void	setImageFormat(int imageFormat) Specifies the format of graph image.
void	setRowSelection(boolean rowSelection) Specifies whether iterator currency should be set in response to graph selection
void	setSeriesEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> seriesEdge) Specifies the layers for the series edge
void	setThreeDEffect(boolean threeDEffect) Deprecated. The "threeDEffect" attribute is not a valid attribute for the dvt:stockGraph tag.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.graph.GraphOptions

getProperty, setProperty

Methods inherited from class oracle.adfdt.view.common.binding.creator.v2.PatternOptions

merge

Methods inherited from class java.lang.Object

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

Method Detail

getExtendedProperties

public StockGraphExtendedProperties getExtendedProperties()

Description copied from class: ExtendedPatternOptions

Returns the ExtendedProperties of this pattern if present. Properties may be set on the extended properties until the component is bound.

Specified by:

getExtendedProperties in class ExtendedPatternOptions

getBindingOptions

public GraphBindingOptions getBindingOptions()

Description copied from class: DvtExtendedPatternOptions

Returns the BindingOptions of this pattern if present. Binding related properties may be set on the BindingOptions class until the component is bound.

Specified by:

getBindingOptions in class DvtExtendedPatternOptions

getGraphType

public final java.lang.String getGraphType()

Retrieves the primary graph type

Returns:

the primary graph type

setGraphSubType

public void setGraphSubType(java.lang.String graphSubType)

Specifies the subtype of graph. Valid values are: STOCK_CANDLE - Candle open-close stock graph STOCK_CANDLE_VOLUME - Candle open-close stock with volume STOCK_HILO_CLOSE - High-low-close stock graph STOCK_HILO_CLOSE_VOLUME - High-low-close stock graph with volume STOCK_OHLC_CANDLE - Candle open-high-low-close stock graph STOCK_OHLC_CANDLE_VOLUME - Candle open-high-low-close stock graph with volume STOCK_OPEN_HILO_CLOSE - Open-high-low-close stock graph STOCK_VOLUME - Open-high-low-close stock graph with volume

Parameters:

graphSubType - the type of graph

getGraphSubType

public java.lang.String getGraphSubType()

Retrieves the subtype of graph.Valid values are:

STOCK_CANDLE - Candle open-close stock graph STOCK_CANDLE_VOLUME - Candle open-close stock with volume STOCK_HILO_CLOSE - High-low-close stock graph STOCK_HILO_CLOSE_VOLUME - High-low-close stock graph with volume STOCK_OHLC_CANDLE - Candle open-high-low-close stock graph STOCK_OHLC_CANDLE_VOLUME - Candle open-high-low-close stock graph with volume STOCK_OPEN_HILO_CLOSE - Open-high-low-close stock graph STOCK_VOLUME - Open-high-low-close stock graph with volume

Returns:

the type of graph

setThreeDEffect

public void setThreeDEffect(boolean threeDEffect)

Deprecated. The "threeDEffect" attribute is not a valid attribute for the dvt:stockGraph tag.

Specifies whether a graph appears to have depth.

Parameters:

threeDEffect - true if the graph should have depth, false otherwise

isThreeDEffect

public boolean isThreeDEffect()

Deprecated. The "threeDEffect" attribute is not a valid attribute for the dvt:stockGraph tag.

Retrieves whether a graph appears to have depth.

Returns:

true if the graph should have depth, false otherwise

setGroupsEdge

public void setGroupsEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> groupsEdge)

Specifies the layers for the groups edge

Parameters:

groupsEdge - the list of groups edge layers

getGroupsEdge

public java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> getGroupsEdge()

Retrieves the layers for the groups edge

Returns:

the list of groups edge layers

setSeriesEdge

public void setSeriesEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> seriesEdge)

Specifies the layers for the series edge

Parameters:

seriesEdge - the list of series edge layers

getSeriesEdge

public java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> getSeriesEdge()

Retrieves the layers for the series edge

Returns:

the list of series edge layers

setRowSelection

public void setRowSelection(boolean rowSelection)

Specifies whether iterator currency should be set in response to graph selection

Parameters:

rowSelection - true if iterator currency should be set, false otherwise

isRowSelection

public boolean isRowSelection()

Retrieves whether iterator currency should be set in response to graph selection

Returns:

true if iterator currency should be set, false otherwise

setAnimationOnDataChange

public void setAnimationOnDataChange(int animationOnDataChange)

Specifies the type of data change animation to apply. Valid values are:

• DataviewConstants.ADC_NONE - Apply no data change animation effects
• DataviewConstants.ADC_AUTO - (Default) Apply Active Data Service (ADS) data change animation events.
• DataviewConstants.ADC_ON - Apply data change animation events for Partial Page Refresh events and ADS animations.

Parameters:

animationOnDataChange - the type of data change animation to apply

getAnimationOnDataChange

public int getAnimationOnDataChange()

Retrieves the type of data change animation to apply. Valid values are:

• DataviewConstants.ADC_NONE - Apply no data change animation effects
• DataviewConstants.ADC_AUTO - (Default) Apply Active Data Service (ADS) data change animation events.
• DataviewConstants.ADC_ON - Apply data change animation events for Partial Page Refresh events and ADS animations.

Returns:

the type of data change animation to apply

setAnimationOnDisplay

public void setAnimationOnDisplay(int animationOnDisplay)

Specifies the type of initial rendering effect to apply. Valid values are:

• DataviewConstants.AD_NONE - (Default) Do not show any initial rendering effect
• DataviewConstants.AD_AUTO - Apply an initial rendering effect automatically chosen based on the graph type

Parameters:

animationOnDisplay - the type of initial rendering effect to apply

getAnimationOnDisplay

public int getAnimationOnDisplay()

Retrieves the type of initial rendering effect to apply. Valid values are:

• DataviewConstants.AD_NONE - (Default) Do not show any initial rendering effect
• DataviewConstants.AD_AUTO - Apply an initial rendering effect automatically chosen based on the graph type

Returns:

the type of initial rendering effect to apply

setImageFormat

public void setImageFormat(int imageFormat)

Specifies the format of graph image. Valid values are:

• UIDataView.IMAGE_FORMAT_PNG - PNG image format.
• UIDataView.IMAGE_FORMAT_FLASH - FLASH image format.
• UIDataView.IMAGE_FORMAT_PNG_STAMPED - PNG image with no javascript. This must be used when using graph in ADF table cells via stamping.
• UIDataView.IMAGE_FORMAT_AUTO - (Default) Generates Flash if a supported Flash player is found on the client. Otherwise, PNG image will be generated.

Parameters:

imageFormat - the format of graph image.

getImageFormat

public int getImageFormat()

Retrieves the format of graph image. Valid values are:

• UIDataView.IMAGE_FORMAT_PNG - PNG image format.
• UIDataView.IMAGE_FORMAT_FLASH - FLASH image format.
• UIDataView.IMAGE_FORMAT_PNG_STAMPED - PNG image with no javascript. This must be used when using graph in ADF table cells via stamping.
• UIDataView.IMAGE_FORMAT_AUTO - (Default) Generates Flash if a supported Flash player is found on the client. Otherwise, PNG image will be generated.

Returns:

the format of graph image

cloneFrom

public static StockGraphOptions cloneFrom(GraphOptions options)

Creates an options class from the specified options class, transferring any common properties

Parameters:

options - the options class that properties will be transferred from