com.crystaldecisions.sdk.occa.report.definition
Class ChartStyle

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ChartStyle
All Implemented Interfaces:
IChartStyle, IClone

public class ChartStyle
extends java.lang.Object
implements IChartStyle, IClone

This object is used to specify the chart type (for example, a bar chart or pie chart) that appears on the report and gives you access to the text options for the chart title, subtitle, and footnote. When possible, use the IChartStyle interface.


Constructor Summary
ChartStyle()
           
ChartStyle(IChartStyle src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 BarSize getBarSize()
          For internal use only.
 ChartDataPoint getChartDataPoint()
          For internal use only.
 ChartStyleSubtype getChartStyleSubtype()
          For internal use only
 GridType getDataAxisGridLine()
          For internal use only
 double getDataAxisMaxValue()
          For internal use only
 double getDataAxisMinValue()
          For internal use only
 NumberFormat getDataAxisNumberFormat()
          For internal use only
 NumberFormat getDataValueNumberFormat()
          For internal use only
 boolean getEnableDataAxisAutoRange()
          For internal use only
 boolean getEnableDepthEffect()
          For internal use only
 boolean getEnableShowLegend()
          For internal use only
 boolean getEnableShowMarkers()
          For internal use only
 GridType getGroupAxisGridLine()
          For internal use only
 boolean getIsVertical()
          For internal use only
 LegendLayout getLegendLayout()
          For internal use only.
 LegendPosition getLegendPosition()
          For internal use only.
 MarkerShape getMarkerShape()
          For internal use only.
 MarkerSize getMarkerSize()
          For internal use only.
 int getMaxHierarchyDepth()
          For internal use only.
 PieSize getPieSize()
          For internal use only.
 GridType getSeriesAxisGridLine()
          For internal use only
 int getSubtype()
           Returns an int that specifies the subtype of this object.
 IByteArray getTemplate()
          For internal use only
 boolean getTextDefaultOption()
           Returns true if default text is enabled, and false otherwise.
 IChartTextOptions getTextOptions()
           Returns the text options for the chart title, subtitle, and footnote.
 ChartStyleType getType()
           Returns the chart type (for example, a bar chart or pie chart).
 ViewingAngle getViewingAngle()
          For internal use only
 boolean hasContent(java.lang.Object srcChartStyle)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
          For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setBarSize(BarSize barSize)
          For internal use only.
 void setChartDataPoint(ChartDataPoint chartDataPoint)
          For internal use only.
 void setChartStyleSubtype(ChartStyleSubtype subtype)
          For internal use only
 void setDataAxisGridLine(GridType axisYGridLine)
          For internal use only
 void setDataAxisMaxValue(double dataAxisMaxValue)
          For internal use only
 void setDataAxisMinValue(double dataAxisMinValue)
          For internal use only
 void setDataAxisNumberFormat(NumberFormat dataAxisNumberFormat)
          For internal use only
 void setDataValueNumberFormat(NumberFormat dataValueNumberFormat)
          For internal use only
 void setEnableDataAxisAutoRange(boolean dataAxisAutoRange)
          For internal use only
 void setEnableDepthEffect(boolean bl)
          For internal use only
 void setEnableShowLegend(boolean showLegend)
          For internal use only
 void setEnableShowMarkers(boolean bl)
          For internal use only
 void setGroupAxisGridLine(GridType groupAxisGridLine)
          For internal use only
 void setIsVertical(boolean isVerticalBar)
          For internal use only
 void setLegendLayout(LegendLayout legendLayout)
          For internal use only.
 void setLegendPosition(LegendPosition legendPosition)
          For internal use only.
 void setMarkerShape(MarkerShape markerShape)
          For internal use only.
 void setMarkerSize(MarkerSize markerSize)
          For internal use only.
 void setMaxHierarchyDepth(int maxDepth)
          For internal use only.
 void setPieSize(PieSize pieSize)
          For internal use only.
 void setSeriesAxisGridLine(GridType seriesAxisGridLine)
          For internal use only
 void setTemplate(IByteArray template)
          For internal use only
 void setTextDefaultOption(boolean newValue)
           Sets whether default text is enabled.
 void setTextOptions(IChartTextOptions textOptions)
           Sets the text options for the chart title, subtitle, and footnote.
 void setType(ChartStyleType type)
           Sets the chart type (for example, a bar chart or pie chart).
 void setViewingAngle(ViewingAngle viewingAngle)
          For internal use only.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChartStyle

public ChartStyle(IChartStyle src)

ChartStyle

public ChartStyle()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getDataAxisGridLine

public GridType getDataAxisGridLine()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getDataAxisGridLine in interface IChartStyle

getBarSize

public BarSize getBarSize()
For internal use only.


getChartDataPoint

public ChartDataPoint getChartDataPoint()
For internal use only.


getDataValueNumberFormat

public NumberFormat getDataValueNumberFormat()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getDataValueNumberFormat in interface IChartStyle

getGroupAxisGridLine

public GridType getGroupAxisGridLine()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getGroupAxisGridLine in interface IChartStyle

getIsVertical

public boolean getIsVertical()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getIsVertical in interface IChartStyle

getLegendLayout

public LegendLayout getLegendLayout()
For internal use only.


getLegendPosition

public LegendPosition getLegendPosition()
For internal use only.


getMarkerShape

public MarkerShape getMarkerShape()
For internal use only.


getMarkerSize

public MarkerSize getMarkerSize()
For internal use only.


getPieSize

public PieSize getPieSize()
For internal use only.


getSeriesAxisGridLine

public GridType getSeriesAxisGridLine()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getSeriesAxisGridLine in interface IChartStyle

getEnableShowLegend

public boolean getEnableShowLegend()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getEnableShowLegend in interface IChartStyle

getMaxHierarchyDepth

public int getMaxHierarchyDepth()
For internal use only.


getSubtype

public int getSubtype()

Returns an int that specifies the subtype of this object.

Returns:
An int that specifies the subtype of this object.

getChartStyleSubtype

public ChartStyleSubtype getChartStyleSubtype()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getChartStyleSubtype in interface IChartStyle

getTemplate

public IByteArray getTemplate()
For internal use only


getTextDefaultOption

public boolean getTextDefaultOption()

Returns true if default text is enabled, and false otherwise.

Returns:
true if default text is enabled, and false otherwise.

getTextOptions

public IChartTextOptions getTextOptions()
Description copied from interface: IChartStyle

Returns the text options for the chart title, subtitle, and footnote.

Specified by:
getTextOptions in interface IChartStyle
Returns:
An IChartTextOptions object containing the options for the chart title, subtitle, and footnote.

getType

public ChartStyleType getType()
Description copied from interface: IChartStyle

Returns the chart type (for example, a bar chart or pie chart).

Specified by:
getType in interface IChartStyle
Returns:
A ChartStyleType object that specifies the chart type.

getViewingAngle

public ViewingAngle getViewingAngle()
For internal use only


getEnableDataAxisAutoRange

public boolean getEnableDataAxisAutoRange()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getEnableDataAxisAutoRange in interface IChartStyle

getDataAxisMaxValue

public double getDataAxisMaxValue()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getDataAxisMaxValue in interface IChartStyle

getDataAxisMinValue

public double getDataAxisMinValue()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getDataAxisMinValue in interface IChartStyle

getDataAxisNumberFormat

public NumberFormat getDataAxisNumberFormat()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getDataAxisNumberFormat in interface IChartStyle

hasContent

public boolean hasContent(java.lang.Object srcChartStyle)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

setDataAxisGridLine

public void setDataAxisGridLine(GridType axisYGridLine)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setDataAxisGridLine in interface IChartStyle

setBarSize

public void setBarSize(BarSize barSize)
For internal use only.


setChartDataPoint

public void setChartDataPoint(ChartDataPoint chartDataPoint)
For internal use only.


setDataValueNumberFormat

public void setDataValueNumberFormat(NumberFormat dataValueNumberFormat)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setDataValueNumberFormat in interface IChartStyle

setGroupAxisGridLine

public void setGroupAxisGridLine(GridType groupAxisGridLine)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setGroupAxisGridLine in interface IChartStyle

setIsVertical

public void setIsVertical(boolean isVerticalBar)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setIsVertical in interface IChartStyle

setLegendLayout

public void setLegendLayout(LegendLayout legendLayout)
For internal use only.


setLegendPosition

public void setLegendPosition(LegendPosition legendPosition)
For internal use only.


setMarkerShape

public void setMarkerShape(MarkerShape markerShape)
For internal use only.


setMarkerSize

public void setMarkerSize(MarkerSize markerSize)
For internal use only.


setPieSize

public void setPieSize(PieSize pieSize)
For internal use only.


setSeriesAxisGridLine

public void setSeriesAxisGridLine(GridType seriesAxisGridLine)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setSeriesAxisGridLine in interface IChartStyle

setEnableShowLegend

public void setEnableShowLegend(boolean showLegend)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setEnableShowLegend in interface IChartStyle

setMaxHierarchyDepth

public void setMaxHierarchyDepth(int maxDepth)
For internal use only.


setChartStyleSubtype

public void setChartStyleSubtype(ChartStyleSubtype subtype)
For internal use only

Specified by:
setChartStyleSubtype in interface IChartStyle

setTemplate

public void setTemplate(IByteArray template)
For internal use only


setTextDefaultOption

public void setTextDefaultOption(boolean newValue)

Sets whether default text is enabled.

Parameters:
newValue - true if default text is enabled, and false otherwise.

setTextOptions

public void setTextOptions(IChartTextOptions textOptions)
Description copied from interface: IChartStyle

Sets the text options for the chart title, subtitle, and footnote.

Specified by:
setTextOptions in interface IChartStyle
Parameters:
textOptions - An IChartTextOptions object containing the options for the chart title, subtitle, and footnote.

setType

public void setType(ChartStyleType type)
Description copied from interface: IChartStyle

Sets the chart type (for example, a bar chart or pie chart).

Specified by:
setType in interface IChartStyle
Parameters:
type - A ChartStyleType object that specifies the chart type.

setViewingAngle

public void setViewingAngle(ViewingAngle viewingAngle)
For internal use only.


setEnableDataAxisAutoRange

public void setEnableDataAxisAutoRange(boolean dataAxisAutoRange)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setEnableDataAxisAutoRange in interface IChartStyle

setDataAxisMaxValue

public void setDataAxisMaxValue(double dataAxisMaxValue)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setDataAxisMaxValue in interface IChartStyle

setDataAxisMinValue

public void setDataAxisMinValue(double dataAxisMinValue)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setDataAxisMinValue in interface IChartStyle

setDataAxisNumberFormat

public void setDataAxisNumberFormat(NumberFormat dataAxisNumberFormat)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setDataAxisNumberFormat in interface IChartStyle

getEnableDepthEffect

public boolean getEnableDepthEffect()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getEnableDepthEffect in interface IChartStyle

setEnableDepthEffect

public void setEnableDepthEffect(boolean bl)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setEnableDepthEffect in interface IChartStyle

getEnableShowMarkers

public boolean getEnableShowMarkers()
Description copied from interface: IChartStyle
For internal use only

Specified by:
getEnableShowMarkers in interface IChartStyle

setEnableShowMarkers

public void setEnableShowMarkers(boolean bl)
Description copied from interface: IChartStyle
For internal use only

Specified by:
setEnableShowMarkers in interface IChartStyle

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
For internal use only.