Package quadbase.reportdesigner.ReportElements

Class ReportChartObject

java.lang.Object
quadbase.reportdesigner.ReportElements.ReportElement
quadbase.reportdesigner.ReportElements.ReportCell
quadbase.reportdesigner.ReportElements.ReportImage
quadbase.reportdesigner.ReportElements.ReportChartObject
All Implemented Interfaces:
Serializable, quadbase.common.util.internal.IReportImage
public class ReportChartObject extends ReportImage implements Serializable
This class can be used to insert a QbChart object anywhere in the Report-- ReportSection, and ReportTable.
See Also:

  • Field Details

  • Constructor Details

    • ReportChartObject

      public ReportChartObject()
      Constructs a ReportChartObject with no label

    • ReportChartObject

      public ReportChartObject(String name)
      Constructs a ReportChartObject with the specified name

  • Method Details

    • setChart

      public void setChart(quadbase.common.util.internal.IChart chartObject)
      Set the IChart object contained in this instance of ReportChartObject.

    • getChart

      public quadbase.common.util.internal.IChart getChart()
      Get the IChart object contained in this instance of ReportChartObject. This IChart object may be class casted to a QbChart object. NOTE: the IChart object is mainly used to retrieve information about the chart. To set properties at run time, please try to use IChartModifier
      Returns:
      The chartObject that the ReportChartObject instance is currently using. It could be null.
      See Also:

    • setParameterMap

      public void setParameterMap(String[] p)
      For parameterized chart only, sets the specified String array as CELL_ID.

    • getParameterMap

      public String[] getParameterMap()
      For parameterized chart only, returns a String array of CELL_ID

    • setChartModifier

      public void setChartModifier(IChartModifier chartMod)
      Set the implemented IChartModifier class object into this instance of ReportChartObject.

    • getChartModifier

      public IChartModifier getChartModifier()
      Get the implemented IChartModifier class object that has been set into this instance of ReportChartObject.

    • isSectionDataIncluded

      public boolean isSectionDataIncluded()
      Returns whether data from Report Table header invalid input: '&' footer are used for charts.

    • setSectionDataIncluded

      public void setSectionDataIncluded(boolean b)
      Specifies whether data from Report Table header invalid input: '&' footer are used for charts.

    • isReportDataUsed

      public boolean isReportDataUsed()
      Returns whether data from ReportTable are used for charts.

    • setReportDataUsed

      public void setReportDataUsed(boolean b)
      Specifies whether data from ReportTable are used for charts.

    • setSummaryDataUsed

      public void setSummaryDataUsed(boolean b)
      Specifies whether summary data is used for fixed-field report only

    • isSummaryDataUsed

      public boolean isSummaryDataUsed()
      Returns whether summary data is used for fixed-field report only

    • getColDataMapping

      public String[] getColDataMapping()
      For internal use only.

    • setColDataMapping

      public void setColDataMapping(String[] map)
      For internal use only.

    • isExportMapFile

      public boolean isExportMapFile()
      Returns whether map files for chart images is included in HTML/DHTML exports.

    • setExportMapFile

      public void setExportMapFile(boolean b)
      Specifies whether map files for chart images is included in HTML/DHTML exports.

    • getChartLocation

      public String getChartLocation()
      Gets the path to the location of the chart.

    • createChartObject

      public static ReportChartObject createChartObject(DataInput in, int version) throws Exception
      For internal use only
      Throws:
      Exception

    • createChartObject

      public static ReportChartObject createChartObject(DataInput in, int version, boolean pack, quadbase.common.util.internal.FileInMemTable subFilesTable, String domainPath) throws Exception
      internal use only
      Throws:
      Exception

    • read

      public void read(DataInput in, int version) throws Exception
      For internal use only.
      Overrides:
      read in class ReportImage
      Throws:
      Exception

    • read

      public void read(DataInput in, int version, boolean pack, quadbase.common.util.internal.FileInMemTable subFilesTable, String domainPath) throws Exception
      internal use only
      Throws:
      Exception

    • write

      public void write(DataOutput out) throws IOException
      For internal use only.
      Overrides:
      write in class ReportImage
      Throws:
      IOException

    • write

      public void write(DataOutput out, boolean pack) throws IOException
      For internal use only.
      Overrides:
      write in class ReportImage
      Throws:
      IOException

    • writeChartData

      public void writeChartData(DataOutput out) throws IOException
      internal use only
      Throws:
      IOException

    • resetByteArray

      public void resetByteArray()

    • packChart

      public void packChart(DataOutput out)
      internal use only

    • createChartObject

      public static ReportChartObject createChartObject(Node node, int version) throws Exception
      For internal use only
      Throws:
      Exception

    • deepCopy

      public void deepCopy(ReportChartObject _chart)
      For internal use only

    • copy

      public void copy(ReportChartObject _chart)
      internal use only

    • copyTemplate

      public void copyTemplate(ReportChartObject _chart)
      For internal use only

    • applyTemplate

      public void applyTemplate(ReportChartObject _chart)
      For internal use only

    • writeXML

      public void writeXML(Writer out, boolean writeElementTag) throws IOException
      For internal use only.
      Overrides:
      writeXML in class ReportImage
      Throws:
      IOException

    • readXML

      public void readXML(Node node, int version) throws Exception
      For internal use only.
      Overrides:
      readXML in class ReportImage
      Throws:
      Exception

    • setDomainPath

      public void setDomainPath(String path)
      Sets the domain path for this object.

    • getDomainPath

      public String getDomainPath()
      Gets the domain path for this object.

    • getText

      public String getText()
      Description copied from class: ReportElement
      Get the text of this element
      Overrides:
      getText in class ReportElement
      Returns:
      the text of this element

    • getText

      public String getText(quadbase.common.util.internal.FileInMemTable subFilesTable)

    • setText

      public void setText(String fn)
      Description copied from class: ReportElement
      Set the text of this element
      Overrides:
      setText in class ReportElement
      Parameters:
      fn - the value of new text

    • getNewChartName

      public String getNewChartName(quadbase.common.util.internal.FileInMemTable subFilesTable, String filename)
      This function determines where a new chart may be saved, given a filename.

    • getChartObject

      public quadbase.common.util.internal.IChart getChartObject()
      Obtain an IChart object from this ReportChartObject. The IChart object can be casted to QbChart NOTE: the IChart object is mainly used to retrieve information about the chart. To set properties at run time, please try to use

    • getDataSourceType

      public int getDataSourceType()
      Get the dataSource Type of the Chart Object. The return value is specified in the class ServerMessage Also the DataSourceType is consistent with the QbReport DataSource Type.
      Returns:
      the DataSourceType specified in ServerMessage, returns -1 if the chart uses report data or its DataSource is set to NONE
      See Also:
      • ServerMessage

    • getDataSourceID

      public String getDataSourceID()
      Returns:
      datasourceID(in data registry) of the chart return null if the chart uses report data

    • setDataSourceID

      public void setDataSourceID(String id)
      set datasourceID of the chart, the id is originally from data registry