Skip navigation links

Oracle Fusion Middleware Design Time Java API Reference for Oracle ADF Faces and Data Visualization Components
11g Release 2 (11.1.2.2.0)

E18581-03


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

java.lang.Object
  extended by oracle.adfdt.view.common.binding.creator.v2.PatternOptions
      extended by oracle.adfdt.view.dvt.binding.pattern.graph.GraphOptions
          extended by oracle.adfdt.view.dvt.binding.pattern.graph.BarGraphOptions


public class BarGraphOptions
extends GraphOptions

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

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

Method Summary
static BarGraphOptions 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.
 GraphFootnote getGraphFootnote()
          Retrieves the characteristics and text of the footnote for the graph.
 GraphSubtitle getGraphSubtitle()
          Retrieves the characteristics and text of the subtitle for the graph.
 java.lang.String getGraphSubType()
          Retrieves the type of graph (BAR_VERT_CLUST by default).
 GraphTitle getGraphTitle()
          Retrieves the characteristics and text of the title for the graph.
 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()
          Retrieves the style of the outer element(enclosing div) of the component
 LegendArea getLegendArea()
          Retrieves characteristics and display properties of the graph legend area.
 LegendTitle getLegendTitle()
          Retrieves the characteristics and text of the title used in the graph's legend.
 O1Title getO1Title()
          Retrieves the text and alignment of the title for the ordinal axis of the graph.
 java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> getSeriesEdge()
          Retrieves the layers for the series edge
 Y1Title getY1Title()
          Retrieves the characteristics and text of the title on the y1-axis.
 Y2Title getY2Title()
          Retrieves the characteristics and text of the title on the y2-axis.
 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)
          Specifies the characteristics and text of the footnote for the graph.
 void setGraphSubtitle(GraphSubtitle graphSubtitle)
          Specifies the characteristics and text of the subtitle for the graph.
 void setGraphSubType(java.lang.String graphSubType)
          Specifies the type of graph (BAR_VERT_CLUST by default).
 void setGraphTitle(GraphTitle graphTitle)
          Specifies the characteristics and text of the title for the 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 setInlineStyle(java.lang.String inlineStyle)
          Specifies the style of the outer element(enclosing div) of the component
 void setLegendArea(LegendArea legendArea)
          Specifies characteristics and display properties of the graph legend area.
 void setLegendTitle(LegendTitle legendTitle)
          Specifies the characteristics and text of the title used in the graph's legend.
 void setO1Title(O1Title o1Title)
          Specifies the text and alignment of the title for the ordinal axis of the graph.
 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.
 void setY1Title(Y1Title y1Title)
          Specifies the characteristics and text of the title on the y1-axis.
 void setY2Title(Y2Title y2Title)
          Specifies the characteristics and text of the title on the y2-axis.

 

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

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 (BAR_VERT_CLUST by default). Valid values are:

Parameters:
graphSubType - the type of graph

getGraphSubType

public java.lang.String getGraphSubType()

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

Returns:
the type of graph

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)
Specifies the style of the outer element(enclosing div) of the component
Parameters:
inlineStyle - the inline style

getInlineStyle

public java.lang.String getInlineStyle()
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:
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:
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:
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:
Returns:
the type of initial rendering effect to apply

setImageFormat

public void setImageFormat(int imageFormat)

Specifies the format of graph image. Valid values are:

Parameters:
imageFormat - the format of graph image.

getImageFormat

public int getImageFormat()

Retrieves the format of graph image. Valid values are:

Returns:
the format of graph image

setGraphFootnote

public void setGraphFootnote(GraphFootnote graphFootnote)
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()
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)
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()
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)
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()
Retrieves the characteristics and text of the title for the graph.
Returns:
the characteristics and text of the title for the graph

setO1Title

public void setO1Title(O1Title o1Title)
Specifies the text and alignment of the title for the ordinal axis of the graph.
Parameters:
o1Title - the text and alignment of the title for the ordinal axis of the graph

getO1Title

public O1Title getO1Title()
Retrieves the text and alignment of the title for the ordinal axis of the graph.
Returns:
the text and alignment of the title for the ordinal axis of the graph

setY1Title

public void setY1Title(Y1Title y1Title)
Specifies the characteristics and text of the title on the y1-axis.
Parameters:
y1Title - the characteristics and text of the title on the y1-axis

getY1Title

public Y1Title getY1Title()
Retrieves the characteristics and text of the title on the y1-axis.
Returns:
the characteristics and text of the title on the y1-axis

setY2Title

public void setY2Title(Y2Title y2Title)
Specifies the characteristics and text of the title on the y2-axis.
Parameters:
y2Title - the the characteristics and text of the title on the y2-axis

getY2Title

public Y2Title getY2Title()
Retrieves the characteristics and text of the title on the y2-axis.
Returns:
the characteristics and text of the title on the y2-axis

setLegendArea

public void setLegendArea(LegendArea legendArea)
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()
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)
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()
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

cloneFrom

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

Skip navigation links

Oracle Fusion Middleware Design Time Java API Reference for Oracle ADF Faces and Data Visualization Components
11g Release 2 (11.1.2.2.0)

E18581-03


Copyright © 1997, 2012, Oracle. All rights reserved.