Java Doc for JRHtmlExporterParameter.java in » Report » jasperreports-2.0.1 » net » sf » jasperreports » engine » export » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Report » jasperreports 2.0.1 » net.sf.jasperreports.engine.export

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

net.sf.jasperreports.engine .JRExporterParameter

net.sf.jasperreports.engine.export .JRHtmlExporterParameter

JRHtmlExporterParameter

public class JRHtmlExporterParameter extends JRExporterParameter (Code)

Contains parameters useful for export in HTML format.

The HTML exporter can send data to a string buffer, output stream, character stream or file on disk. The engine looks among the export parameters in order to find the selected output type in this order: OUTPUT_STRING_BUFFER, OUTPUT_WRITER, OUTPUT_STREAM, OUTPUT_FILE, OUTPUT_FILE_NAME.

An important issue is images. The HTML format stores images as separate files, so the exporter needs to know where these images will be stored. If they are stored on disk, the IMAGES_URI parameter will be initialized with a string containing the file name on disk. If they remain in memory, IMAGES_URI must point to a resource that is able to send the images to the browser (such as an image servlet, as shown in the webapp example).
author:
Teodor Danciu (teodord@users.sourceforge.net)
version:
$Id: JRHtmlExporterParameter.java 1824 2007-08-23 14:19:12Z teodord $

Field Summary
final public static JRHtmlExporterParameter	BETWEEN_PAGES_HTML A string representing HTML code that will be inserted between pages of the generated report.
final public static JRHtmlExporterParameter	FRAMES_AS_NESTED_TABLES Indicates whether JRPrintFrame frames are to be exported as nested HTML tables.
final public static JRHtmlExporterParameter	HTML_FOOTER A string representing HTML code that will be inserted after the generated report.
final public static JRHtmlExporterParameter	HTML_HEADER A string representing HTML code that will be inserted in front of the generated report.
final public static JRHtmlExporterParameter	IMAGES_DIR A `java.io.File` instance representing an absolute path to a folder on a local disk, where all the images are stored.
final public static JRHtmlExporterParameter	IMAGES_DIR_NAME An absolute path to a folder on a local disk, where all the images are stored.
final public static JRHtmlExporterParameter	IMAGES_MAP A map containing all the images that were used for generating the report.
final public static JRHtmlExporterParameter	IMAGES_URI An URI to the folder where all the images are stored.
final public static JRHtmlExporterParameter	IS_OUTPUT_IMAGES_TO_DIR A boolean value specifying whether the images should be stored on disk.
final public static JRHtmlExporterParameter	IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS A boolean value specifying whether the blank lines, that sometimes appear between rows, should be deleted.
final public static JRHtmlExporterParameter	IS_USING_IMAGES_TO_ALIGN A boolean value specifying whether the export engine should use small images for aligning.
final public static JRHtmlExporterParameter	IS_WHITE_PAGE_BACKGROUND A boolean value specifying whether the report background should be white.
final public static JRHtmlExporterParameter	IS_WRAP_BREAK_WORD A boolean value specifying whether the export engine should use force wrapping by breaking words (CSS `word-wrap: break-word`).
final public static String	PROPERTY_FRAMES_AS_NESTED_TABLES This property serves as default value for the JRHtmlExporterParameter.FRAMES_AS_NESTED_TABLES FRAMES_AS_NESTED_TABLES export parameter.
final public static String	PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS Property whose value is used as default state of the JRHtmlExporterParameter.IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS export flag.
final public static String	PROPERTY_SIZE_UNIT Property whose value is used as default for the JRHtmlExporterParameter.SIZE_UNIT SIZE_UNIT export parameter.
final public static String	PROPERTY_USING_IMAGES_TO_ALIGN Property whose value is used as default state of the JRHtmlExporterParameter.IS_USING_IMAGES_TO_ALIGN IS_USING_IMAGES_TO_ALIGN export flag.
final public static String	PROPERTY_WHITE_PAGE_BACKGROUND Property whose value is used as default state of the JRHtmlExporterParameter.IS_WHITE_PAGE_BACKGROUND IS_WHITE_PAGE_BACKGROUND export flag.
final public static String	PROPERTY_WRAP_BREAK_WORD Property whose value is used as default state of the JRHtmlExporterParameter.IS_WRAP_BREAK_WORD IS_WRAP_BREAK_WORD export flag.
final public static JRHtmlExporterParameter	SIZE_UNIT A String value specifying the unit to use when measuring lengths or font size.
final public static String	SIZE_UNIT_PIXEL Possible value for the JRHtmlExporterParameter.SIZE_UNIT parameter indicated that measurements are made in pixels.
final public static String	SIZE_UNIT_POINT Possible value for the JRHtmlExporterParameter.SIZE_UNIT parameter indicated that measurements are made in points.

Constructor Summary
protected	JRHtmlExporterParameter(String name)

Field Detail

BETWEEN_PAGES_HTML
final public static JRHtmlExporterParameter BETWEEN_PAGES_HTML(Code)
	A string representing HTML code that will be inserted between pages of the generated report. By default, JasperReports separates pages by two empty lines, but this behaviour can be overriden by this parameter.

FRAMES_AS_NESTED_TABLES

final public static JRHtmlExporterParameter FRAMES_AS_NESTED_TABLES(Code)

Indicates whether JRPrintFrame frames are to be exported as nested HTML tables.

The type of the parameter is java.lang.Boolean.

Is set to false, the frame contents will be integrated into the master/page HTML table. This can be useful when exporting frames as nested tables causes output misalignments.

See Also: JRHtmlExporter.PROPERTY_FRAMES_AS_NESTED_TABLES

HTML_FOOTER
final public static JRHtmlExporterParameter HTML_FOOTER(Code)
	A string representing HTML code that will be inserted after the generated report. By default, JasperReports closes the usual HTML tags that were opened in HTML_HEADER. If the default HTML_HEADER was overriden, it is recommended that this parameter is overriden too, in order to ensure proper construction of HTML page.

HTML_HEADER
final public static JRHtmlExporterParameter HTML_HEADER(Code)
	A string representing HTML code that will be inserted in front of the generated report. The JasperReports engine places a piece of HTML code at the top of the page but users can define their own headers and stylesheet links.

IMAGES_DIR
final public static JRHtmlExporterParameter IMAGES_DIR(Code)
	A `java.io.File` instance representing an absolute path to a folder on a local disk, where all the images are stored.

IMAGES_DIR_NAME
final public static JRHtmlExporterParameter IMAGES_DIR_NAME(Code)
	An absolute path to a folder on a local disk, where all the images are stored. This is an alternative to IMAGES_DIR

IMAGES_MAP
final public static JRHtmlExporterParameter IMAGES_MAP(Code)
	A map containing all the images that were used for generating the report. The JasperReports engine stores all the images in this map, and uses the map keys for referencing images throughout the export process.

IMAGES_URI
final public static JRHtmlExporterParameter IMAGES_URI(Code)
	An URI to the folder where all the images are stored. It could also point to a different resource, such as an image servlet. It is used in the generated HTML to point to the actual location of the image in the tag (as a file on disk or a web resource).

IS_OUTPUT_IMAGES_TO_DIR
final public static JRHtmlExporterParameter IS_OUTPUT_IMAGES_TO_DIR(Code)
	A boolean value specifying whether the images should be stored on disk. The default value is true. If this parameter is specified, IMAGES_DIR or IMAGES_DIR_NAME must also be specified and point to a valid directory.

IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
final public static JRHtmlExporterParameter IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS(Code)
	A boolean value specifying whether the blank lines, that sometimes appear between rows, should be deleted. Sometimes page break occurs before the entire page is filled with data (i.e. having a group with the isStartNewPage attribute set to true). All the remaining empty space could be removed by setting this parameter to true.

IS_USING_IMAGES_TO_ALIGN
final public static JRHtmlExporterParameter IS_USING_IMAGES_TO_ALIGN(Code)
	A boolean value specifying whether the export engine should use small images for aligning. This is useful when you don't have images in your report anyway and you don't want to have to handle images at all.

IS_WHITE_PAGE_BACKGROUND
final public static JRHtmlExporterParameter IS_WHITE_PAGE_BACKGROUND(Code)
	A boolean value specifying whether the report background should be white. If this parameter is not set, the default background will appear, depending on the selected CSS styles.

IS_WRAP_BREAK_WORD
final public static JRHtmlExporterParameter IS_WRAP_BREAK_WORD(Code)
	A boolean value specifying whether the export engine should use force wrapping by breaking words (CSS `word-wrap: break-word`).

PROPERTY_FRAMES_AS_NESTED_TABLES
final public static String PROPERTY_FRAMES_AS_NESTED_TABLES(Code)
	This property serves as default value for the JRHtmlExporterParameter.FRAMES_AS_NESTED_TABLES FRAMES_AS_NESTED_TABLES export parameter. The propery itself defaults to `true`. See Also: JRProperties

PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
final public static String PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS(Code)
	Property whose value is used as default state of the JRHtmlExporterParameter.IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS export flag. This property is by default not set (`false`). See Also: JRProperties

PROPERTY_SIZE_UNIT
final public static String PROPERTY_SIZE_UNIT(Code)
	Property whose value is used as default for the JRHtmlExporterParameter.SIZE_UNIT SIZE_UNIT export parameter. See Also: JRProperties

PROPERTY_USING_IMAGES_TO_ALIGN
final public static String PROPERTY_USING_IMAGES_TO_ALIGN(Code)
	Property whose value is used as default state of the JRHtmlExporterParameter.IS_USING_IMAGES_TO_ALIGN IS_USING_IMAGES_TO_ALIGN export flag. This property is set by default (`true`). See Also: JRProperties

PROPERTY_WHITE_PAGE_BACKGROUND
final public static String PROPERTY_WHITE_PAGE_BACKGROUND(Code)
	Property whose value is used as default state of the JRHtmlExporterParameter.IS_WHITE_PAGE_BACKGROUND IS_WHITE_PAGE_BACKGROUND export flag. This property is set by default (`true`). See Also: JRProperties

PROPERTY_WRAP_BREAK_WORD
final public static String PROPERTY_WRAP_BREAK_WORD(Code)
	Property whose value is used as default state of the JRHtmlExporterParameter.IS_WRAP_BREAK_WORD IS_WRAP_BREAK_WORD export flag. This property is by default not set (`false`). See Also: JRProperties

SIZE_UNIT
final public static JRHtmlExporterParameter SIZE_UNIT(Code)
	A String value specifying the unit to use when measuring lengths or font size. This can be one of the supported size units from the CSS specifications like "px" for pixels or "pt" for points. The default value is "px", meaning that lengths and font sizes are specified in pixels.

SIZE_UNIT_PIXEL
final public static String SIZE_UNIT_PIXEL(Code)
	Possible value for the JRHtmlExporterParameter.SIZE_UNIT parameter indicated that measurements are made in pixels.

SIZE_UNIT_POINT
final public static String SIZE_UNIT_POINT(Code)
	Possible value for the JRHtmlExporterParameter.SIZE_UNIT parameter indicated that measurements are made in points.

Constructor Detail

JRHtmlExporterParameter
protected JRHtmlExporterParameter(String name)(Code)

Fields inherited from net.sf.jasperreports.engine.JRExporterParameter

final public static JRExporterParameter CHARACTER_ENCODING(Code)(Java Doc)
final public static JRExporterParameter CLASS_LOADER(Code)(Java Doc)
final public static JRExporterParameter END_PAGE_INDEX(Code)(Java Doc)
final public static JRExporterParameter FONT_MAP(Code)(Java Doc)
final public static JRExporterParameter HYPERLINK_PRODUCER_FACTORY(Code)(Java Doc)
final public static JRExporterParameter INPUT_FILE(Code)(Java Doc)
final public static JRExporterParameter INPUT_FILE_NAME(Code)(Java Doc)
final public static JRExporterParameter INPUT_STREAM(Code)(Java Doc)
final public static JRExporterParameter INPUT_URL(Code)(Java Doc)
final public static JRExporterParameter JASPER_PRINT(Code)(Java Doc)
final public static JRExporterParameter JASPER_PRINT_LIST(Code)(Java Doc)
final public static JRExporterParameter OFFSET_X(Code)(Java Doc)
final public static JRExporterParameter OFFSET_Y(Code)(Java Doc)
final public static JRExporterParameter OUTPUT_FILE(Code)(Java Doc)
final public static JRExporterParameter OUTPUT_FILE_NAME(Code)(Java Doc)
final public static JRExporterParameter OUTPUT_STREAM(Code)(Java Doc)
final public static JRExporterParameter OUTPUT_STRING_BUFFER(Code)(Java Doc)
final public static JRExporterParameter OUTPUT_WRITER(Code)(Java Doc)
final public static JRExporterParameter PAGE_INDEX(Code)(Java Doc)
final public static JRExporterParameter PROGRESS_MONITOR(Code)(Java Doc)
final public static String PROPERTY_CHARACTER_ENCODING(Code)(Java Doc)
final public static JRExporterParameter START_PAGE_INDEX(Code)(Java Doc)
final public static JRExporterParameter URL_HANDLER_FACTORY(Code)(Java Doc)

Methods inherited from net.sf.jasperreports.engine.JRExporterParameter

public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.