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

Class PieGraphOptions

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.PieGraphOptions

public class PieGraphOptions
extends GraphOptions

Binding options that allow the user to change the structure and functionality of a Pie graph.

Since:

release specific (what release of product did this appear in)

Method Summary

Modifier and Type	Method and Description
static PieGraphOptions	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.
PieGraphExtendedProperties	getExtendedProperties() Returns the BarGraphExtendedProperties of this pattern if present.
GraphFootnote	getGraphFootnote() Deprecated. use getGraphFootnote in PieGraphExtendedProperties class.
GraphSubtitle	getGraphSubtitle() Deprecated. use getGraphSubtitle in PieGraphExtendedProperties class.
java.lang.String	getGraphSubType() Retrieves the type of graph (PIE by default).
GraphTitle	getGraphTitle() Deprecated. use getGraphTitle in PieGraphExtendedProperties class.
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.lang.String	getInlineStyle() Deprecated. use getInlineStyle in PieGraphExtendedProperties class.
LegendArea	getLegendArea() Deprecated. use getLegendArea in PieGraphExtendedProperties class.
LegendTitle	getLegendTitle() Deprecated. use getLegendTitle in PieGraphExtendedProperties class.
PieLabel	getPieLabel() Deprecated. use getPieLabel in PieGraphExtendedProperties class.
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() Retrieves whether a graph appears to have depth.
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	setGraphFootnote(GraphFootnote graphFootnote) Deprecated. use setGraphFootnote in PieGraphExtendedProperties class.
void	setGraphSubtitle(GraphSubtitle graphSubtitle) Deprecated. use setGraphSubtitle in PieGraphExtendedProperties class.
void	setGraphSubType(java.lang.String graphSubType) Specifies the type of graph (PIE by default).
void	setGraphTitle(GraphTitle graphTitle) Deprecated. use setGraphTitle in PieGraphExtendedProperties class.
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	setInlineStyle(java.lang.String inlineStyle) Deprecated. use setInlineStyle in PieGraphExtendedProperties class.
void	setLegendArea(LegendArea legendArea) Deprecated. use setLegendArea in PieGraphExtendedProperties class.
void	setLegendTitle(LegendTitle legendTitle) Deprecated. use setLegendTitle in PieGraphExtendedProperties class.
void	setPieLabel(PieLabel pieLabel) Deprecated. use setPieLabel in PieGraphExtendedProperties class.
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) Specifies whether a graph appears to have depth.

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 PieGraphExtendedProperties getExtendedProperties()

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

Specified by:

getExtendedProperties in class ExtendedPatternOptions

Returns:

extended properties

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

Returns:

An instance of a BindingOptions that contains component specific options used by the binding task. Check the component's options class for the specific implementation of BindingOptions used by that component. For instance: charts are using ChartBindingOptions

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 type of graph (PIE by default). Valid values are:

• PIE - Pie graph
• PIE_BAR - Pie-Bar graph
• PIE_MULTI - Multiple pie graph
• RING - Ring graph
• RING_BAR - Ring-Bar graph
• RING_MULTI - Multiple ring graph

Parameters:

graphSubType - the type of graph

getGraphSubType

public java.lang.String getGraphSubType()

Retrieves the type of graph (PIE by default). Valid values are:

• PIE - Pie graph
• PIE_BAR - Pie-Bar graph
• PIE_MULTI - Multiple pie graph
• RING - Ring graph
• RING_BAR - Ring-Bar graph
• RING_MULTI - Multiple ring graph

Returns:

the type of graph

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Deprecated. use setInlineStyle in PieGraphExtendedProperties class.

Specifies the style of the outer element(enclosing div) of the component

Parameters:

inlineStyle - the inline style

getInlineStyle

public java.lang.String getInlineStyle()

Deprecated. use getInlineStyle in PieGraphExtendedProperties class.

Retrieves the style of the outer element(enclosing div) of the component

Returns:

the inline style

setThreeDEffect

public void setThreeDEffect(boolean threeDEffect)

Specifies whether a graph appears to have depth.

Parameters:

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

isThreeDEffect

public boolean isThreeDEffect()

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

setGraphFootnote

public void setGraphFootnote(GraphFootnote graphFootnote)

Deprecated. use setGraphFootnote in PieGraphExtendedProperties class.

Specifies the characteristics and text of the footnote for the graph.

Parameters:

graphFootnote - the characteristics and text of the footnote for the graph

getGraphFootnote

public GraphFootnote getGraphFootnote()

Deprecated. use getGraphFootnote in PieGraphExtendedProperties class.

Retrieves the characteristics and text of the footnote for the graph.

Returns:

the characteristics and text of the footnote for the graph

setGraphSubtitle

public void setGraphSubtitle(GraphSubtitle graphSubtitle)

Deprecated. use setGraphSubtitle in PieGraphExtendedProperties class.

Specifies the characteristics and text of the subtitle for the graph.

Parameters:

graphSubtitle - the characteristics and text of the subtitle for the graph

getGraphSubtitle

public GraphSubtitle getGraphSubtitle()

Deprecated. use getGraphSubtitle in PieGraphExtendedProperties class.

Retrieves the characteristics and text of the subtitle for the graph.

Returns:

the characteristics and text of the subtitle for the graph

setGraphTitle

public void setGraphTitle(GraphTitle graphTitle)

Deprecated. use setGraphTitle in PieGraphExtendedProperties class.

Specifies the characteristics and text of the title for the graph.

Parameters:

graphTitle - the characteristics and text of the title for the graph

getGraphTitle

public GraphTitle getGraphTitle()

Deprecated. use getGraphTitle in PieGraphExtendedProperties class.

Retrieves the characteristics and text of the title for the graph.

Returns:

the characteristics and text of the title for the graph

setLegendArea

public void setLegendArea(LegendArea legendArea)

Deprecated. use setLegendArea in PieGraphExtendedProperties class.

Specifies characteristics and display properties of the graph legend area.

Parameters:

legendArea - the characteristics and display properties of the graph legend area.

getLegendArea

public LegendArea getLegendArea()

Deprecated. use getLegendArea in PieGraphExtendedProperties class.

Retrieves characteristics and display properties of the graph legend area.

Returns:

the characteristics and display properties of the graph legend area.

setLegendTitle

public void setLegendTitle(LegendTitle legendTitle)

Deprecated. use setLegendTitle in PieGraphExtendedProperties class.

Specifies the characteristics and text of the title used in the graph's legend.

Parameters:

legendTitle - the characteristics and text of the title used in the graph's legend

getLegendTitle

public LegendTitle getLegendTitle()

Deprecated. use getLegendTitle in PieGraphExtendedProperties class.

Retrieves the characteristics and text of the title used in the graph's legend.

Returns:

the characteristics and text of the title used in the graph's legend

setPieLabel

public void setPieLabel(PieLabel pieLabel)

Deprecated. use setPieLabel in PieGraphExtendedProperties class.

Specifies the characteristics of the label that describes a pie or ring graph.

Parameters:

pieLabel - the characteristics of the label that describes a pie or ring graph

getPieLabel

public PieLabel getPieLabel()

Deprecated. use getPieLabel in PieGraphExtendedProperties class.

Retrieves the characteristics of the label that describes a pie or ring graph.

Returns:

the characteristics of the label that describes a pie or ring graph

cloneFrom

public static PieGraphOptions 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

Returns:

A new instance of PieGraphOptions cloned from a given PieGraphOptions instance.