com.aspose.words.jasperreports
Class AWExporterParameter

java.lang.Object
  extended by JRExporterParameter
      extended by com.aspose.words.jasperreports.AWExporterParameter

public class AWExporterParameter
extends JRExporterParameter

Contains various export parameters used to configure the export.

The following code sample demonstrates the usage of the class:

 AWDocExporter exporter = new AWDocExporter();

 exporter.setParameter(JRExporterParameter.JASPER_PRINT, jasperPrint);
 exporter.setParameter(JRExporterParameter.OUTPUT_FILE_NAME, destFile.toString());

 exporter.setParameter(
     AWExporterParameter.OVERLAP_RESOLUTION_METHOD,
     AWExporterParameter.OVERLAP_RESOLUTION_METHOD_TRUNCATE_ITEMS);

 exporter.exportReport();
 


Field Summary
static AWExporterParameter EXPORT_LINES
          Parameter to determine whether to export lines.
static AWExporterParameter EXPORT_RECTANGLES
          Parameter to determine whether to export rectangles.
static AWExporterParameter LICENSE
          Parameter to set the path to a license file.
static AWExporterParameter OVERLAP_RESOLUTION_METHOD
          Parameter to determine a way to resolve overlapping items.
static int OVERLAP_RESOLUTION_METHOD_PUSH_ITEMS
          Parameter to specify the Push Items resolution method.
static int OVERLAP_RESOLUTION_METHOD_TRUNCATE_ITEMS
          Parameter to specify the Truncate Items resolution method.
static java.lang.String PROPERTY_EXPORT_LINES
          This constant is not supposed to be used directly.
static java.lang.String PROPERTY_EXPORT_RECTANGLES
          This constant is not supposed to be used directly.
static java.lang.String PROPERTY_LICENSE
          This constant is not supposed to be used directly.
static java.lang.String PROPERTY_OVERLAP_RESOLUTION_METHOD
          This constant is not supposed to be used directly.
static java.lang.String PROPERTY_SPACING_FACTOR
          This constant is not supposed to be used directly.
static AWExporterParameter SPACING_FACTOR
          Parameter to reduce spacing between report elements if needed.
 
Method Summary
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LICENSE

public static final AWExporterParameter LICENSE
Parameter to set the path to a license file.


PROPERTY_LICENSE

public static final java.lang.String PROPERTY_LICENSE
This constant is not supposed to be used directly.

See Also:
Constant Field Values

OVERLAP_RESOLUTION_METHOD

public static final AWExporterParameter OVERLAP_RESOLUTION_METHOD
Parameter to determine a way to resolve overlapping items.

JasperReports reports can contain overlapping items. Faithfully converting reports with overlapping items to Microsoft Word documents can sometimes represent challenges to the system. In Flow Layout, overlapping items cannot be converted preserving their original location or size because there is no such thing as Z-order in Flow Layout. However, Aspose.Words for JasperReports tries to export such items as close to the original as possible. It offers two methods of resolving overlapping items:

The first method is used by default as it allows the preservation of the original position of report items and does not affect surrounding contents. However, it may corrupt the item's appearance. If you are not satisfied with the Truncate method, you can try the Push method.


PROPERTY_OVERLAP_RESOLUTION_METHOD

public static final java.lang.String PROPERTY_OVERLAP_RESOLUTION_METHOD
This constant is not supposed to be used directly.


OVERLAP_RESOLUTION_METHOD_PUSH_ITEMS

public static final int OVERLAP_RESOLUTION_METHOD_PUSH_ITEMS
Parameter to specify the Push Items resolution method.

See Also:
Constant Field Values

OVERLAP_RESOLUTION_METHOD_TRUNCATE_ITEMS

public static final int OVERLAP_RESOLUTION_METHOD_TRUNCATE_ITEMS
Parameter to specify the Truncate Items resolution method.

See Also:
Constant Field Values

EXPORT_LINES

public static final AWExporterParameter EXPORT_LINES
Parameter to determine whether to export lines. By default, the value of the parameter is false.

Lines in JasperReports are often used to represent borders and other decorative elements around text. At the moment Aspose.Words for JasperReports exports reports to flow layout documents, which means they consist of "normal" inline paragraphs and tables. Flow layout does not support overlapping items and Z-order at all. Exporting lines that are placed over other items would corrupt the resulting appearance of the document.

If you need lines to be exported, set this parameter to true.


PROPERTY_EXPORT_LINES

public static final java.lang.String PROPERTY_EXPORT_LINES
This constant is not supposed to be used directly.

See Also:
Constant Field Values

EXPORT_RECTANGLES

public static final AWExporterParameter EXPORT_RECTANGLES
Parameter to determine whether to export rectangles. By default, the value of the parameter is false.

Rectangles in JasperReports are often used to represent borders and other decorative elements around text. At the moment Aspose.Words for JasperReports exports reports to flow layout documents, which means they consist of "normal" inline paragraphs and tables. Flow layout does not support overlapping items and Z-order at all. Exporting rectangles that are placed over other items would corrupt the resulting appearance of the document.

If you need rectangles to be exported, set this parameter to true.


PROPERTY_EXPORT_RECTANGLES

public static final java.lang.String PROPERTY_EXPORT_RECTANGLES
This constant is not supposed to be used directly.

See Also:
Constant Field Values

SPACING_FACTOR

public static final AWExporterParameter SPACING_FACTOR
Parameter to reduce spacing between report elements if needed. By default, the value of the parameter is 1.0.

When generating documents in flow mode, it is impossible to set the coordinates of report elements explicitly. This means that sometimes page contents may appear higher than designed and therefore be pushed to the following page. To eliminate this side effect, you may reduce spacing between report elements. If you encounter the described behaviour (the documnet contains more pages than expected), try setting the SPACING_FACTOR parameter to a value less than 1.0. Keep decreasing the value until all page contents fit corresponding pages.


PROPERTY_SPACING_FACTOR

public static final java.lang.String PROPERTY_SPACING_FACTOR
This constant is not supposed to be used directly.

See Also:
Constant Field Values