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 doControllerModification(java.lang.Object newObject)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
          For internal use only.
 com.crystaldecisions.sdk.occa.report.definition.BarSize getBarSize()
          For internal use only.
 com.crystaldecisions.sdk.occa.report.definition.ChartDataPoint getChartDataPoint()
          For internal use only.
 ControllableMixin getControllableMixin()
          For internal use only.
 GridType getDataAxisGridLine()
           
 double getDataAxisMaxValue()
           
 double getDataAxisMinValue()
           
 NumberFormat getDataAxisNumberFormat()
           
 NumberFormat getDataValueNumberFormat()
           
 boolean getEnableDataAxisAutoRange()
           
 boolean getEnableDepthEffect()
           
 boolean getEnableShowLegend()
           
 boolean getEnableShowMarkers()
           
 GridType getGroupAxisGridLine()
           
 boolean getIsVertical()
           
 com.crystaldecisions.sdk.occa.report.definition.LegendLayout getLegendLayout()
          For internal use only.
 com.crystaldecisions.sdk.occa.report.definition.LegendPosition getLegendPosition()
          For internal use only.
 com.crystaldecisions.sdk.occa.report.definition.MarkerShape getMarkerShape()
          For internal use only.
 com.crystaldecisions.sdk.occa.report.definition.MarkerSize getMarkerSize()
          For internal use only.
 com.crystaldecisions.sdk.occa.report.definition.PieSize getPieSize()
          For internal use only.
 GridType getSeriesAxisGridLine()
           
 com.crystaldecisions.sdk.occa.report.definition.SliceDetachment getSliceDetachment()
          For internal use only.
 ChartStyleSubtype getSubtype()
           Returns an int that specifies the subtype of this object.
 IByteArray getTemplate()
           
 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).
 com.crystaldecisions.sdk.occa.report.definition.ViewingAngle getViewingAngle()
           
 boolean hasContent(java.lang.Object srcChartStyle)
           
 boolean isDirectlyControllable()
          For internal use only.
 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(com.crystaldecisions.sdk.occa.report.definition.BarSize barSize)
          For internal use only.
 void setChartDataPoint(com.crystaldecisions.sdk.occa.report.definition.ChartDataPoint chartDataPoint)
          For internal use only.
 void setDataAxisGridLine(GridType axisYGridLine)
           
 void setDataAxisMaxValue(double dataAxisMaxValue)
           
 void setDataAxisMinValue(double dataAxisMinValue)
           
 void setDataAxisNumberFormat(NumberFormat dataAxisNumberFormat)
           
 void setDataValueNumberFormat(NumberFormat dataValueNumberFormat)
           
 void setEnableDataAxisAutoRange(boolean dataAxisAutoRange)
           
 void setEnableDepthEffect(boolean bl)
           
 void setEnableShowLegend(boolean showLegend)
           
 void setEnableShowMarkers(boolean bl)
           
 void setGroupAxisGridLine(GridType groupAxisGridLine)
           
 void setIsVertical(boolean isVerticalBar)
           
 void setLegendLayout(com.crystaldecisions.sdk.occa.report.definition.LegendLayout legendLayout)
          For internal use only.
 void setLegendPosition(com.crystaldecisions.sdk.occa.report.definition.LegendPosition legendPosition)
          For internal use only.
 void setMarkerShape(com.crystaldecisions.sdk.occa.report.definition.MarkerShape markerShape)
          For internal use only.
 void setMarkerSize(com.crystaldecisions.sdk.occa.report.definition.MarkerSize markerSize)
          For internal use only.
 void setPieSize(com.crystaldecisions.sdk.occa.report.definition.PieSize pieSize)
          For internal use only.
 void setSeriesAxisGridLine(GridType seriesAxisGridLine)
           
 void setSliceDetachment(com.crystaldecisions.sdk.occa.report.definition.SliceDetachment sliceDetachment)
          For internal use only.
 void setSubtype(ChartStyleSubtype subtype)
           
 void setTemplate(IByteArray template)
           
 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(com.crystaldecisions.sdk.occa.report.definition.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()
Specified by:
getDataAxisGridLine in interface IChartStyle

getBarSize

public com.crystaldecisions.sdk.occa.report.definition.BarSize getBarSize()
For internal use only.


getChartDataPoint

public com.crystaldecisions.sdk.occa.report.definition.ChartDataPoint getChartDataPoint()
For internal use only.


getDataValueNumberFormat

public NumberFormat getDataValueNumberFormat()
Specified by:
getDataValueNumberFormat in interface IChartStyle

getGroupAxisGridLine

public GridType getGroupAxisGridLine()
Specified by:
getGroupAxisGridLine in interface IChartStyle

getIsVertical

public boolean getIsVertical()
Specified by:
getIsVertical in interface IChartStyle

getLegendLayout

public com.crystaldecisions.sdk.occa.report.definition.LegendLayout getLegendLayout()
For internal use only.


getLegendPosition

public com.crystaldecisions.sdk.occa.report.definition.LegendPosition getLegendPosition()
For internal use only.


getMarkerShape

public com.crystaldecisions.sdk.occa.report.definition.MarkerShape getMarkerShape()
For internal use only.


getMarkerSize

public com.crystaldecisions.sdk.occa.report.definition.MarkerSize getMarkerSize()
For internal use only.


getPieSize

public com.crystaldecisions.sdk.occa.report.definition.PieSize getPieSize()
For internal use only.


getSeriesAxisGridLine

public GridType getSeriesAxisGridLine()
Specified by:
getSeriesAxisGridLine in interface IChartStyle

getEnableShowLegend

public boolean getEnableShowLegend()
Specified by:
getEnableShowLegend in interface IChartStyle

getSliceDetachment

public com.crystaldecisions.sdk.occa.report.definition.SliceDetachment getSliceDetachment()
For internal use only.


getSubtype

public ChartStyleSubtype getSubtype()

Returns an int that specifies the subtype of this object.

Specified by:
getSubtype in interface IChartStyle
Returns:
An int that specifies the subtype of this object.

getTemplate

public IByteArray getTemplate()

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 com.crystaldecisions.sdk.occa.report.definition.ViewingAngle getViewingAngle()

getEnableDataAxisAutoRange

public boolean getEnableDataAxisAutoRange()
Specified by:
getEnableDataAxisAutoRange in interface IChartStyle

getDataAxisMaxValue

public double getDataAxisMaxValue()
Specified by:
getDataAxisMaxValue in interface IChartStyle

getDataAxisMinValue

public double getDataAxisMinValue()
Specified by:
getDataAxisMinValue in interface IChartStyle

getDataAxisNumberFormat

public NumberFormat getDataAxisNumberFormat()
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)
Specified by:
setDataAxisGridLine in interface IChartStyle

setBarSize

public void setBarSize(com.crystaldecisions.sdk.occa.report.definition.BarSize barSize)
For internal use only.


setChartDataPoint

public void setChartDataPoint(com.crystaldecisions.sdk.occa.report.definition.ChartDataPoint chartDataPoint)
For internal use only.


setDataValueNumberFormat

public void setDataValueNumberFormat(NumberFormat dataValueNumberFormat)
Specified by:
setDataValueNumberFormat in interface IChartStyle

setGroupAxisGridLine

public void setGroupAxisGridLine(GridType groupAxisGridLine)
Specified by:
setGroupAxisGridLine in interface IChartStyle

setIsVertical

public void setIsVertical(boolean isVerticalBar)
Specified by:
setIsVertical in interface IChartStyle

setLegendLayout

public void setLegendLayout(com.crystaldecisions.sdk.occa.report.definition.LegendLayout legendLayout)
For internal use only.


setLegendPosition

public void setLegendPosition(com.crystaldecisions.sdk.occa.report.definition.LegendPosition legendPosition)
For internal use only.


setMarkerShape

public void setMarkerShape(com.crystaldecisions.sdk.occa.report.definition.MarkerShape markerShape)
For internal use only.


setMarkerSize

public void setMarkerSize(com.crystaldecisions.sdk.occa.report.definition.MarkerSize markerSize)
For internal use only.


setPieSize

public void setPieSize(com.crystaldecisions.sdk.occa.report.definition.PieSize pieSize)
For internal use only.


setSeriesAxisGridLine

public void setSeriesAxisGridLine(GridType seriesAxisGridLine)
Specified by:
setSeriesAxisGridLine in interface IChartStyle

setEnableShowLegend

public void setEnableShowLegend(boolean showLegend)
Specified by:
setEnableShowLegend in interface IChartStyle

setSliceDetachment

public void setSliceDetachment(com.crystaldecisions.sdk.occa.report.definition.SliceDetachment sliceDetachment)
For internal use only.


setSubtype

public void setSubtype(ChartStyleSubtype subtype)
Specified by:
setSubtype in interface IChartStyle

setTemplate

public void setTemplate(IByteArray template)

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(com.crystaldecisions.sdk.occa.report.definition.ViewingAngle viewingAngle)
For internal use only.


setEnableDataAxisAutoRange

public void setEnableDataAxisAutoRange(boolean dataAxisAutoRange)
Specified by:
setEnableDataAxisAutoRange in interface IChartStyle

setDataAxisMaxValue

public void setDataAxisMaxValue(double dataAxisMaxValue)
Specified by:
setDataAxisMaxValue in interface IChartStyle

setDataAxisMinValue

public void setDataAxisMinValue(double dataAxisMinValue)
Specified by:
setDataAxisMinValue in interface IChartStyle

setDataAxisNumberFormat

public void setDataAxisNumberFormat(NumberFormat dataAxisNumberFormat)
Specified by:
setDataAxisNumberFormat in interface IChartStyle

getEnableDepthEffect

public boolean getEnableDepthEffect()
Specified by:
getEnableDepthEffect in interface IChartStyle

setEnableDepthEffect

public void setEnableDepthEffect(boolean bl)
Specified by:
setEnableDepthEffect in interface IChartStyle

getEnableShowMarkers

public boolean getEnableShowMarkers()
Specified by:
getEnableShowMarkers in interface IChartStyle

setEnableShowMarkers

public void setEnableShowMarkers(boolean bl)
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.


doControllerModification

public void doControllerModification(java.lang.Object newObject)
For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()
For internal use only.


isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.


enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
For internal use only.