|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.util.JRApiWriter
public class JRApiWriter
A writer that generates the Java code required to produce a given report template programmatically, using the JasperReports API.
Constructor Summary | |
---|---|
protected |
JRApiWriter(JRReport report)
|
Method Summary | |
---|---|
protected void |
close()
|
protected void |
flush()
|
static void |
main(java.lang.String[] args)
|
protected boolean |
toWriteConditionalStyles()
|
protected void |
write(java.lang.String text)
|
protected void |
write(java.lang.String pattern,
boolean value,
boolean defaultValue)
|
protected void |
write(java.lang.String pattern,
byte value,
byte defaultValue)
|
protected void |
write(java.lang.String pattern,
java.awt.Color value)
|
protected void |
write(java.lang.String pattern,
java.awt.Color value,
java.awt.Color defaultValue)
|
protected void |
write(java.lang.String pattern,
java.lang.Double value)
|
protected void |
write(java.lang.String pattern,
java.lang.Double value,
java.lang.Double defaultValue)
|
protected void |
write(java.lang.String pattern,
java.lang.Enum<?> value)
|
protected void |
write(java.lang.String pattern,
java.lang.Enum<?> value,
java.lang.Enum<?> defaultValue)
|
protected void |
write(java.lang.String pattern,
java.lang.Float value)
|
protected void |
write(java.lang.String pattern,
java.lang.Float value,
java.lang.Float defaultValue)
|
protected void |
write(java.lang.String pattern,
int value)
|
protected void |
write(java.lang.String pattern,
int value,
int defaultValue)
|
protected void |
write(java.lang.String pattern,
java.lang.Object value)
|
protected void |
write(java.lang.String pattern,
java.lang.Object value,
java.lang.Object defaultValue)
|
void |
writeAreaChart(JRChart chart,
java.lang.String chartName)
|
void |
writeAxisFormat(java.lang.String indent,
JRFont axisLabelFont,
java.awt.Color axisLabelColor,
JRFont axisTickLabelFont,
java.awt.Color axisTickLabelColor,
java.lang.String axisTickLabelMask,
java.lang.Boolean axisVerticalTickLabels,
java.awt.Color axisLineColor,
java.lang.String parentName,
java.lang.String axisNameSuffix,
boolean isToSet)
Writes out the axis format block for a chart axis. |
void |
writeBar3DChart(JRChart chart,
java.lang.String chartName)
|
void |
writeBar3DPlot(JRBar3DPlot plot,
java.lang.String chartName)
|
void |
writeBarChart(JRChart chart,
java.lang.String chartName)
|
protected void |
writeBox(JRLineBox box,
java.lang.String boxHolder)
|
void |
writeBreak(JRBreak breakElement,
java.lang.String breakName)
|
void |
writeBubbleChart(JRChart chart,
java.lang.String chartName)
|
protected void |
writeBucket(JRCrosstabBucket bucket,
java.lang.String parentName)
|
void |
writeCandlestickChart(JRChart chart,
java.lang.String chartName)
|
void |
writeCategoryAxisFormat(java.lang.String indent,
JRFont axisLabelFont,
java.awt.Color axisLabelColor,
JRFont axisTickLabelFont,
java.awt.Color axisTickLabelColor,
java.lang.String axisTickLabelMask,
java.lang.Boolean axisVerticalTickLabels,
java.lang.Double labelRotation,
java.awt.Color axisLineColor,
java.lang.String parentName,
java.lang.String axisNameSuffix)
Writes out the category axis format block. |
protected void |
writeCellContents(JRCellContents contents,
java.lang.String cellName)
|
void |
writeChartTag(JRChart chart,
java.lang.String chartName)
|
void |
writeChildElements(JRElementGroup elementContainer,
java.lang.String parentName)
Writes the contents (child elements) of an element container. |
void |
writeComponentElement(JRComponentElement componentElement,
java.lang.String componentName)
|
protected void |
writeConditionalStyle(JRConditionalStyle style,
java.lang.String styleName)
Writes a conditional style. |
void |
writeCrosstab(JRCrosstab crosstab,
java.lang.String crosstabName)
|
protected void |
writeCrosstabCell(JRCrosstabCell cell,
java.lang.String cellName)
|
protected void |
writeCrosstabColumnGroup(JRCrosstabColumnGroup group,
java.lang.String groupName)
|
protected void |
writeCrosstabMeasure(JRCrosstabMeasure measure,
java.lang.String measureName)
|
protected void |
writeCrosstabParameter(JRCrosstabParameter parameter,
java.lang.String parameterName)
|
protected void |
writeCrosstabRowGroup(JRCrosstabRowGroup group,
java.lang.String groupName)
|
void |
writeDataRange(JRDataRange dataRange,
java.lang.String parentName,
java.lang.String dataRangeSuffix)
Writes a data range block to the output stream. |
void |
writeDataset(JRDataset dataset,
java.lang.String datasetName)
|
protected void |
writeDatasetContents(JRDataset dataset,
java.lang.String datasetName)
|
void |
writeDatasetRun(JRDatasetRun datasetRun,
java.lang.String parentName)
Outputs the XML representation of a subdataset run object. |
void |
writeElementDataset(JRElementDataset dataset,
boolean skipIfEmpty,
java.lang.String datasetName)
Writes the JRXML representation of an element dataset . |
void |
writeElementDataset(JRElementDataset dataset,
java.lang.String datasetName)
Writes the JRXML representation of an element dataset . |
void |
writeElementGroup(JRElementGroup elementGroup,
java.lang.String groupName)
|
void |
writeEllipse(JREllipse ellipse,
java.lang.String ellipseName)
|
void |
writeExpression(JRExpression expression,
java.lang.String parentName,
java.lang.String expressionSuffix)
|
void |
writeExpression(JRExpression expression,
java.lang.String parentName,
java.lang.String expressionSuffix,
java.lang.String defaultClassName)
|
void |
writeFrame(JRFrame frame,
java.lang.String frameName)
|
void |
writeGanttChart(JRChart chart,
java.lang.String chartName)
|
void |
writeGenericElement(JRGenericElement element,
java.lang.String elementName)
protected XmlNamespace getNamespace() { return JASPERREPORTS_NAMESPACE; } /** |
void |
writeHighLowChart(JRChart chart,
java.lang.String chartName)
|
void |
writeHighLowDataset(JRHighLowDataset dataset,
java.lang.String parentName,
java.lang.String datasetNameSuffix)
|
void |
writeHyperlink(JRHyperlink hyperlink,
java.lang.String parentName,
java.lang.String hyperlinkSuffix)
public void writeHyperlink( String tagName, JRHyperlink hyperlink, String hyperlinkName) { writeHyperlink( tagName, null, hyperlink, hyperlinkName); } /** public void writeHyperlink( String tagName, XmlNamespace namespace, JRHyperlink hyperlink, String hyperlinkName) { if (hyperlink ! |
protected void |
writeHyperlinkParameter(JRHyperlinkParameter parameter,
java.lang.String parameterName)
|
protected void |
writeHyperlinkParameters(JRHyperlinkParameter[] parameters,
java.lang.String parentName)
|
void |
writeImage(JRImage image,
java.lang.String imageName)
|
void |
writeItemLabel(JRItemLabel itemLabel,
java.lang.String parentName,
java.lang.String itemLabelSuffix)
Writes the description of how to display item labels in a category plot. |
void |
writeLine(JRLine line,
java.lang.String lineName)
|
void |
writeLineChart(JRChart chart,
java.lang.String chartName)
|
void |
writeMeterChart(JRChart chart,
java.lang.String chartName)
Writes the definition of a meter chart to the output stream. |
void |
writeMultiAxisChart(JRChart chart,
java.lang.String chartName)
Writes the definition of a multiple axis chart to the output stream. |
protected void |
writeParagraph(JRParagraph paragraph,
java.lang.String paragraphHolder)
|
void |
writePie3DChart(JRChart chart,
java.lang.String chartName)
|
void |
writePieChart(JRChart chart,
java.lang.String chartName)
|
void |
writePieDataset(JRPieDataset dataset,
java.lang.String parentName,
java.lang.String datasetNameSuffix)
|
protected void |
writePropertyExpression(JRPropertyExpression propertyExpression,
java.lang.String propertyExpressionName)
|
protected void |
writePropertyExpressions(JRPropertyExpression[] propertyExpressions,
java.lang.String propertyHolderName)
|
void |
writeRectangle(JRRectangle rectangle,
java.lang.String rectangleName)
|
static java.lang.String |
writeReport(JRReport report)
|
static void |
writeReport(JRReport report,
java.io.OutputStream outputStream)
|
static void |
writeReport(JRReport report,
java.lang.String destFileName)
|
protected void |
writeReport(java.io.Writer aWriter)
|
void |
writeScatterChart(JRChart chart,
java.lang.String chartName)
|
protected void |
writeSection(JRSection section,
java.lang.String sectionName,
java.lang.String sectionBandListGetterName)
|
void |
writeStackedAreaChart(JRChart chart,
java.lang.String chartName)
|
void |
writeStackedBar3DChart(JRChart chart,
java.lang.String chartName)
|
void |
writeStackedBarChart(JRChart chart,
java.lang.String chartName)
|
void |
writeStaticText(JRStaticText staticText,
java.lang.String staticTextName)
|
protected void |
writeStyleReferenceAttr(JRStyleContainer styleContainer,
java.lang.String styleName)
|
void |
writeSubreport(JRSubreport subreport,
java.lang.String subreportName)
|
protected void |
writeTemplate(JRReportTemplate template,
java.lang.String templateName)
|
protected void |
writeTemplates(java.lang.String indent)
|
void |
writeTextField(JRTextField textField,
java.lang.String textFieldName)
|
void |
writeThermometerChart(JRChart chart,
java.lang.String chartName)
Writes the description of a thermometer chart to the output stream. |
void |
writeTimeSeriesChart(JRChart chart,
java.lang.String chartName)
|
void |
writeValueDataset(JRValueDataset dataset,
java.lang.String parentName,
java.lang.String datasetNameSuffix)
Writes the description of a value dataset to the output stream. |
void |
writeValueDisplay(JRValueDisplay valueDisplay,
java.lang.String parentName)
Writes the description of how to display a value in a valueDataset. |
void |
writeXyAreaChart(JRChart chart,
java.lang.String chartName)
|
void |
writeXyBarChart(JRChart chart,
java.lang.String chartName)
|
void |
writeXyLineChart(JRChart chart,
java.lang.String chartName)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected JRApiWriter(JRReport report)
Method Detail |
---|
public static java.lang.String writeReport(JRReport report)
public static void writeReport(JRReport report, java.lang.String destFileName) throws JRException
JRException
public static void writeReport(JRReport report, java.io.OutputStream outputStream) throws JRException
JRException
protected void writeReport(java.io.Writer aWriter)
protected void writeTemplates(java.lang.String indent)
protected void writeTemplate(JRReportTemplate template, java.lang.String templateName)
protected void writeSection(JRSection section, java.lang.String sectionName, java.lang.String sectionBandListGetterName)
public void writeChildElements(JRElementGroup elementContainer, java.lang.String parentName)
elementContainer
- the element containerpublic void writeElementGroup(JRElementGroup elementGroup, java.lang.String groupName)
public void writeBreak(JRBreak breakElement, java.lang.String breakName)
public void writeLine(JRLine line, java.lang.String lineName)
protected void writePropertyExpressions(JRPropertyExpression[] propertyExpressions, java.lang.String propertyHolderName)
protected void writePropertyExpression(JRPropertyExpression propertyExpression, java.lang.String propertyExpressionName)
public void writeRectangle(JRRectangle rectangle, java.lang.String rectangleName)
public void writeEllipse(JREllipse ellipse, java.lang.String ellipseName)
public void writeImage(JRImage image, java.lang.String imageName)
public void writeStaticText(JRStaticText staticText, java.lang.String staticTextName)
public void writeTextField(JRTextField textField, java.lang.String textFieldName)
public void writeSubreport(JRSubreport subreport, java.lang.String subreportName)
public void writeElementDataset(JRElementDataset dataset, java.lang.String datasetName)
element dataset
.
The method produces a <dataset>
XML element.
dataset
- the element dataset
java.io.IOException
- any I/O exception that occurred while writing the
XML outputpublic void writeElementDataset(JRElementDataset dataset, boolean skipIfEmpty, java.lang.String datasetName)
element dataset
.
The method produces a <dataset>
XML element.
dataset
- the element datasetskipIfEmpty
- if set, no output will be produced if the element dataset
only has default attribute values
java.io.IOException
- any I/O exception that occurred while writing the
XML outputpublic void writePieDataset(JRPieDataset dataset, java.lang.String parentName, java.lang.String datasetNameSuffix)
public void writeValueDataset(JRValueDataset dataset, java.lang.String parentName, java.lang.String datasetNameSuffix)
dataset
- the value dataset to persistpublic void writeValueDisplay(JRValueDisplay valueDisplay, java.lang.String parentName)
valueDisplay
- the description to savepublic void writeItemLabel(JRItemLabel itemLabel, java.lang.String parentName, java.lang.String itemLabelSuffix)
itemLabel
- the description to savepublic void writeDataRange(JRDataRange dataRange, java.lang.String parentName, java.lang.String dataRangeSuffix)
dataRange
- the range to writepublic void writePieChart(JRChart chart, java.lang.String chartName)
public void writePie3DChart(JRChart chart, java.lang.String chartName)
public void writeCategoryAxisFormat(java.lang.String indent, JRFont axisLabelFont, java.awt.Color axisLabelColor, JRFont axisTickLabelFont, java.awt.Color axisTickLabelColor, java.lang.String axisTickLabelMask, java.lang.Boolean axisVerticalTickLabels, java.lang.Double labelRotation, java.awt.Color axisLineColor, java.lang.String parentName, java.lang.String axisNameSuffix)
axisLabelFont
- font to use for the axis labelaxisLabelColor
- color to use for the axis labelaxisTickLabelFont
- font to use for the label of each tick markaxisTickLabelColor
- color to use for the label of each tick markaxisTickLabelMask
- formatting mask to use for the label of each tick markaxisVerticalTickLabels
- flag to render tick labels at 90 degreeslabelRotation
- label rotation angleaxisLineColor
- the color to use for the axis line and any tick markspublic void writeAxisFormat(java.lang.String indent, JRFont axisLabelFont, java.awt.Color axisLabelColor, JRFont axisTickLabelFont, java.awt.Color axisTickLabelColor, java.lang.String axisTickLabelMask, java.lang.Boolean axisVerticalTickLabels, java.awt.Color axisLineColor, java.lang.String parentName, java.lang.String axisNameSuffix, boolean isToSet)
axisLabelFont
- font to use for the axis labelaxisLabelColor
- color to use for the axis labelaxisTickLabelFont
- font to use for the label of each tick markaxisTickLabelColor
- color to use for the label of each tick markaxisTickLabelMask
- formatting mask to use for the label of each tick markaxisVerticalTickLabels
- flag to render tick labels at 90 degreesaxisLineColor
- the color to use for the axis line and any tick markspublic void writeBar3DPlot(JRBar3DPlot plot, java.lang.String chartName)
public void writeBarChart(JRChart chart, java.lang.String chartName)
public void writeBar3DChart(JRChart chart, java.lang.String chartName)
public void writeBubbleChart(JRChart chart, java.lang.String chartName)
public void writeStackedBarChart(JRChart chart, java.lang.String chartName)
public void writeStackedBar3DChart(JRChart chart, java.lang.String chartName)
public void writeLineChart(JRChart chart, java.lang.String chartName)
public void writeTimeSeriesChart(JRChart chart, java.lang.String chartName)
public void writeHighLowDataset(JRHighLowDataset dataset, java.lang.String parentName, java.lang.String datasetNameSuffix)
public void writeHighLowChart(JRChart chart, java.lang.String chartName)
public void writeGanttChart(JRChart chart, java.lang.String chartName)
public void writeCandlestickChart(JRChart chart, java.lang.String chartName)
public void writeAreaChart(JRChart chart, java.lang.String chartName)
public void writeScatterChart(JRChart chart, java.lang.String chartName)
public void writeXyAreaChart(JRChart chart, java.lang.String chartName)
public void writeXyBarChart(JRChart chart, java.lang.String chartName)
public void writeXyLineChart(JRChart chart, java.lang.String chartName)
public void writeMeterChart(JRChart chart, java.lang.String chartName)
chart
- the meter chart to writepublic void writeThermometerChart(JRChart chart, java.lang.String chartName)
chart
- the thermometer chart to writepublic void writeMultiAxisChart(JRChart chart, java.lang.String chartName)
chart
- the multiple axis chart to writepublic void writeStackedAreaChart(JRChart chart, java.lang.String chartName)
public void writeChartTag(JRChart chart, java.lang.String chartName)
public void writeCrosstab(JRCrosstab crosstab, java.lang.String crosstabName)
protected void writeCrosstabRowGroup(JRCrosstabRowGroup group, java.lang.String groupName)
protected void writeCrosstabColumnGroup(JRCrosstabColumnGroup group, java.lang.String groupName)
protected void writeBucket(JRCrosstabBucket bucket, java.lang.String parentName)
protected void writeCrosstabMeasure(JRCrosstabMeasure measure, java.lang.String measureName)
protected void writeCrosstabCell(JRCrosstabCell cell, java.lang.String cellName)
protected void writeCellContents(JRCellContents contents, java.lang.String cellName)
protected void writeCrosstabParameter(JRCrosstabParameter parameter, java.lang.String parameterName)
public void writeDataset(JRDataset dataset, java.lang.String datasetName)
protected void writeDatasetContents(JRDataset dataset, java.lang.String datasetName)
public void writeDatasetRun(JRDatasetRun datasetRun, java.lang.String parentName)
datasetRun
- the subdataset run
java.io.IOException
public void writeFrame(JRFrame frame, java.lang.String frameName)
protected void writeHyperlinkParameters(JRHyperlinkParameter[] parameters, java.lang.String parentName)
protected void writeHyperlinkParameter(JRHyperlinkParameter parameter, java.lang.String parameterName)
public void writeHyperlink(JRHyperlink hyperlink, java.lang.String parentName, java.lang.String hyperlinkSuffix)
protected boolean toWriteConditionalStyles()
protected void writeConditionalStyle(JRConditionalStyle style, java.lang.String styleName)
style
- the conditional stylepublic void writeComponentElement(JRComponentElement componentElement, java.lang.String componentName)
public void writeGenericElement(JRGenericElement element, java.lang.String elementName)
protected void writeStyleReferenceAttr(JRStyleContainer styleContainer, java.lang.String styleName)
protected void writeBox(JRLineBox box, java.lang.String boxHolder)
protected void writeParagraph(JRParagraph paragraph, java.lang.String paragraphHolder)
public void writeExpression(JRExpression expression, java.lang.String parentName, java.lang.String expressionSuffix)
public void writeExpression(JRExpression expression, java.lang.String parentName, java.lang.String expressionSuffix, java.lang.String defaultClassName)
protected void write(java.lang.String text)
protected void write(java.lang.String pattern, java.lang.Object value)
protected void write(java.lang.String pattern, java.lang.Object value, java.lang.Object defaultValue)
protected void write(java.lang.String pattern, java.lang.Enum<?> value)
protected void write(java.lang.String pattern, java.lang.Enum<?> value, java.lang.Enum<?> defaultValue)
protected void write(java.lang.String pattern, int value)
protected void write(java.lang.String pattern, int value, int defaultValue)
protected void write(java.lang.String pattern, java.lang.Float value)
protected void write(java.lang.String pattern, java.lang.Float value, java.lang.Float defaultValue)
protected void write(java.lang.String pattern, java.lang.Double value)
protected void write(java.lang.String pattern, java.lang.Double value, java.lang.Double defaultValue)
protected void write(java.lang.String pattern, boolean value, boolean defaultValue)
protected void write(java.lang.String pattern, byte value, byte defaultValue)
protected void write(java.lang.String pattern, java.awt.Color value)
protected void write(java.lang.String pattern, java.awt.Color value, java.awt.Color defaultValue)
protected void close()
protected void flush()
public static void main(java.lang.String[] args)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |