EspressReport 6.6

quadbase.reportdesigner.ReportElements
Class ReportChartObject

java.lang.Object
  extended by quadbase.reportdesigner.ReportElements.ReportElement
      extended by quadbase.reportdesigner.ReportElements.ReportCell
          extended by quadbase.reportdesigner.ReportElements.ReportImage
              extended by quadbase.reportdesigner.ReportElements.ReportChartObject
All Implemented Interfaces:
java.io.Serializable, quadbase.common.util.internal.IReportImage

public class ReportChartObject
extends ReportImage
implements java.io.Serializable

This class can be used to insert a QbChart object anywhere in the Report-- ReportSection, and ReportTable.

See Also:
Serialized Form

Field Summary
static java.lang.String XMLTAG
          For internal use only
 
Fields inherited from class quadbase.reportdesigner.ReportElements.ReportImage
CENTER, DBImageDir, FIT, TILE
 
Fields inherited from class quadbase.reportdesigner.ReportElements.ReportElement
bgColor, borderColor, CHART, COLUMN, COLUMNHEADER, FORMULA, GRID, height, ID_TYPE, IMAGE, isLocked, LABEL, LINE, min_height, min_width, NONE, rotate_angle, ROTATE_CLOCKWISE, ROTATE_COUNTERCLOCKWISE, ROTATE_NONE, roundCornerRadius, roundCornersArray, RTFOBJECT, SECTION, securityMap, snap, SORT_X, SORT_Y, SORT_Z, SUBREPORT, TABLE, TABLEOFCONTENTS, TITLE, visible, vsnap, width, x
 
Constructor Summary
ReportChartObject()
          Constructs a ReportChartObject with no label
ReportChartObject(java.lang.String name)
          Constructs a ReportChartObject with the specified name
 
Method Summary
 void applyTemplate(ReportChartObject _chart)
          For internal use only
 void copy(ReportChartObject _chart)
          internal use only
 void copyTemplate(ReportChartObject _chart)
          For internal use only
static ReportChartObject createChartObject(java.io.DataInput in, int version)
          For internal use only
static ReportChartObject createChartObject(java.io.DataInput in, int version, boolean pack, quadbase.common.util.internal.FileInMemTable subFilesTable, java.lang.String domainPath)
          internal use only
static ReportChartObject createChartObject(org.w3c.dom.Node node, int version)
          For internal use only
 void deepCopy(ReportChartObject _chart)
          For internal use only
 quadbase.common.util.internal.IChart getChart()
          Get the IChart object contained in this instance of ReportChartObject.
 java.lang.String getChartLocation()
          Gets the path to the location of the chart.
 IChartModifier getChartModifier()
          Get the implemented IChartModifier class object that has been set into this instance of ReportChartObject.
 quadbase.common.util.internal.IChart getChartObject()
          Obtain an IChart object from this ReportChartObject.
 java.lang.String[] getColDataMapping()
          For internal use only.
 java.lang.String getDataSourceID()
           
 int getDataSourceType()
          Get the dataSource Type of the Chart Object.
 java.lang.String getDomainPath()
          Gets the domain path for this object.
 java.lang.String getNewChartName(quadbase.common.util.internal.FileInMemTable subFilesTable, java.lang.String filename)
          This function determines where a new chart may be saved, given a filename.
 java.lang.String[] getParameterMap()
          For parameterized chart only, returns a String array of CELL_ID
 java.lang.String getText()
          Get the text of this element
 java.lang.String getText(quadbase.common.util.internal.FileInMemTable subFilesTable)
           
 boolean isExportMapFile()
          Returns whether map files for chart images is included in HTML/DHTML exports.
 boolean isReportDataUsed()
          Returns whether data from ReportTable are used for charts.
 boolean isSectionDataIncluded()
          Returns whether data from Report Table header & footer are used for charts.
 boolean isSummaryDataUsed()
          Returns whether summary data is used for fixed-field report only
 void packChart(java.io.DataOutput out)
          internal use only
 void read(java.io.DataInput in, int version)
          For internal use only.
 void read(java.io.DataInput in, int version, boolean pack, quadbase.common.util.internal.FileInMemTable subFilesTable, java.lang.String domainPath)
          internal use only
 void readXML(org.w3c.dom.Node node, int version)
          For internal use only.
 void resetByteArray()
           
 void setChart(quadbase.common.util.internal.IChart chartObject)
          Set the IChart object contained in this instance of ReportChartObject.
 void setChartModifier(IChartModifier chartMod)
          Set the implemented IChartModifier class object into this instance of ReportChartObject.
 void setColDataMapping(java.lang.String[] map)
          For internal use only.
 void setDataSourceID(java.lang.String id)
          set datasourceID of the chart, the id is originally from data registry
 void setDomainPath(java.lang.String path)
          Sets the domain path for this object.
 void setExportMapFile(boolean b)
          Specifies whether map files for chart images is included in HTML/DHTML exports.
 void setParameterMap(java.lang.String[] p)
          For parameterized chart only, sets the specified String array as CELL_ID.
 void setReportDataUsed(boolean b)
          Specifies whether data from ReportTable are used for charts.
 void setSectionDataIncluded(boolean b)
          Specifies whether data from Report Table header & footer are used for charts.
 void setSummaryDataUsed(boolean b)
          Specifies whether summary data is used for fixed-field report only
 void setText(java.lang.String fn)
          Set the text of this element
 void write(java.io.DataOutput out)
          For internal use only.
 void write(java.io.DataOutput out, boolean pack)
          For internal use only.
 void writeChartData(java.io.DataOutput out)
          internal use only
 void writeXML(java.io.Writer out, boolean writeElementTag)
          For internal use only.
 
Methods inherited from class quadbase.reportdesigner.ReportElements.ReportImage
applyTemplate, applyTemplate, copy, copyTemplate, createImage, createImage, createImage, createReportImage, deepCopy, equals, getBytes, getFlashFrameCount, getFlashFrameRate, getImageOption, getImagePath, getImageType, getImageURL, getJPEGQuality, getPdfImageType, getPNGCompression, getRelativePath, getSavedFileLocation, getSavedFileURL, isDBImage, isGIFTransparent, read, setBytes, setBytes, setDBImage, setFlashFrameCount, setFlashFrameRate, setGIFTransparent, setHTMLParameters, setImageOption, setImagePath, setImagePath, setImageType, setImageURL, setImageURL, setJPEGQuality, setPdfImageType, setPNGCompression, setRelativePath, toString, writeImageData
 
Methods inherited from class quadbase.reportdesigner.ReportElements.ReportCell
applyStyle, applyStyleButNotWH, applyTemplate, applyTemplate, clone, copy, copyTemplate, createCell, createCell, createFormulaObject, createFormulaObjectFromName, createFormulaObjectFromText, deepCopy, equals, formulaReferenced, getColIndex, getColumn, getDataFormat, getEntry, getFormula, getFormulaName, getFormulaObj, getScriptedValue, getSQLType, setColumn, setDataFormat, setEntry, setFormula, setFormulaObj, setScriptedValue
 
Methods inherited from class quadbase.reportdesigner.ReportElements.ReportElement
addSecurityLevel, applyImageTemplate, applyImageTemplateExceptBound, applySecurity, applyStyle, applyStyleButNotWH, applyTemplate, applyTemplate, applyTemplate, contains, contains, containsX, containsY, copy, copyTemplate, createScriptObject, createScriptObjectFromName, deepCopy, doesElementSupportRoundCorners, equals, findElementsAbove, findElementsBelow, findElementsToLeft, findElementsToRight, findElementsToRight, findElementType, findGroupElementType, findMaxXr, findMaxYd, findMinX, findMinY, findSpecificElements, getAlign, getAllColors, getBgColor, getBookmark, getBorder, getBorderColor, getBorderThickness, getBottomBorder, getCustomID, getDrawX, getDrawX, getDrawY, getDrawY, getDrillDownName, getElementType, getElementTypeName, getFirst2RowOfColumns, getFirst2RowOfColumns, getFont, getFontColor, getHeight, getHeight, getHeightOfElement, getHeightOfElement, getHeightToPoints, getHint, getID, getLeftBorder, getLink, getMaxXr, getMin_Height, getMin_Width, getMinX, getRefFont, getRefFontToDraw, getRightBorder, getRotateAngle, getRoundCornerRadius, getRoundCornersArray, getScript, getScriptName, getScriptObj, getSecuredScripts, getSecurityLevel, getSecurityLevels, getSecurityMap, getSnap, getStyleName, getTarget, getTopBorder, getVAlign, getVSnap, getWidth, getWidth, getWidthOfElement, getWidthOfElement, getWidthToPoints, getX, getX, getXPos, getXPos, getXToPoints, getY, getY, getYPos, getYPos, getYToPoints, getZ, hasBorder, inBottomHalf, inLeftEnd, inLeftHalf, inRightEnd, inRightHalf, inTopHalf, isCrossTabElt, isDrawAgain, isLocked, isNoWrap, isResizeToFitContent, isSecurityLevelDefined, isSecurityTextScript, isShiftSecuredColX, isShiftSecuredColXIncludeHeaderAndFooter, isSnapToGrid, isUnderline, isVisible, moveForCrossTabFixedField, moveForCrossTabFixedField, newArrayX, newArrayY, removeScriptReferenced, removeSecurityLevel, renameSecurityLevel, resize, resizeForCrossTabFixedField, resizeForCrossTabFixedField, scriptReferenced, securityScriptReferenced, setAlign, setBgColor, setBookmark, setBorder, setBorderColor, setBorderThickness, setBorderThickness, setBorderThickness, setBottomBorder, setCustomID, setDrawAgain, setDrawX, setDrawX, setDrawY, setDrawY, setDrillDownName, setFont, setFontColor, setHeight, setHeight, setHint, setID, setID, setInchGridSpace, setLeftBorder, setLink, setLocked, setMinHeight, setMinWidth, setNoWrap, setResizeToFitContent, setRightBorder, setRotateAngle, setRotateAngle, setRoundCornerRadius, setRoundCornersArray, setScript, setScriptName, setScriptObj, setScriptObjNull, setSecurityLevelProperties, setSecurityMap, setSecurityTextScript, setShiftSecuredColX, setShiftSecuredColXIncludeHeaderAndFooter, setSnap, setSnapToGrid, setSnapToGrid, setStyleName, setTarget, setTopBorder, setUnderline, setVAlign, setVisible, setVSnap, setWidth, setWidth, setX, setX, setXX, setXX, setY, setY, setYY, setYY, setZ, shift, shiftObjectsOnMove, shiftOnMove, sortElement, sortElement, sortElementHorizontally, sortElementInXYOrder, sortElementVertically, swapElements, switchSecurityProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

XMLTAG

public static final java.lang.String XMLTAG
For internal use only

See Also:
Constant Field Values
Constructor Detail

ReportChartObject

public ReportChartObject()
Constructs a ReportChartObject with no label


ReportChartObject

public ReportChartObject(java.lang.String name)
Constructs a ReportChartObject with the specified name

Method Detail

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:
getChartObject()

setParameterMap

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


getParameterMap

public java.lang.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 & footer are used for charts.


setSectionDataIncluded

public void setSectionDataIncluded(boolean b)
Specifies whether data from Report Table header & 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 java.lang.String[] getColDataMapping()
For internal use only.


setColDataMapping

public void setColDataMapping(java.lang.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 java.lang.String getChartLocation()
Gets the path to the location of the chart.


createChartObject

public static ReportChartObject createChartObject(java.io.DataInput in,
                                                  int version)
                                           throws java.lang.Exception
For internal use only

Throws:
java.lang.Exception

createChartObject

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

Throws:
java.lang.Exception

read

public void read(java.io.DataInput in,
                 int version)
          throws java.lang.Exception
For internal use only.

Overrides:
read in class ReportImage
Throws:
java.lang.Exception

read

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

Throws:
java.lang.Exception

write

public void write(java.io.DataOutput out)
           throws java.io.IOException
For internal use only.

Overrides:
write in class ReportImage
Throws:
java.io.IOException

write

public void write(java.io.DataOutput out,
                  boolean pack)
           throws java.io.IOException
For internal use only.

Overrides:
write in class ReportImage
Throws:
java.io.IOException

writeChartData

public void writeChartData(java.io.DataOutput out)
                    throws java.io.IOException
internal use only

Throws:
java.io.IOException

resetByteArray

public void resetByteArray()

packChart

public void packChart(java.io.DataOutput out)
internal use only


createChartObject

public static ReportChartObject createChartObject(org.w3c.dom.Node node,
                                                  int version)
                                           throws java.lang.Exception
For internal use only

Throws:
java.lang.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(java.io.Writer out,
                     boolean writeElementTag)
              throws java.io.IOException
For internal use only.

Overrides:
writeXML in class ReportImage
Throws:
java.io.IOException

readXML

public void readXML(org.w3c.dom.Node node,
                    int version)
             throws java.lang.Exception
For internal use only.

Overrides:
readXML in class ReportImage
Throws:
java.lang.Exception

setDomainPath

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


getDomainPath

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


getText

public java.lang.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 java.lang.String getText(quadbase.common.util.internal.FileInMemTable subFilesTable)

setText

public void setText(java.lang.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 java.lang.String getNewChartName(quadbase.common.util.internal.FileInMemTable subFilesTable,
                                        java.lang.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

Returns:
the chartObject that is used in this ReportChartObject if chartObject is not null otherwise, return a new IChart Object from the stream (pak) or file (rpt)
See Also:
setChartModifier(IChartModifier)

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 java.lang.String getDataSourceID()
Returns:
datasourceID(in data registry) of the chart return null if the chart uses report data

setDataSourceID

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


EspressReport 6.6