com.ontimize.printing

Class HTMLProcessor

java.lang.Object

com.ontimize.printing.HTMLProcessor

public class HTMLProcessor
extends Object

Class to parse HTML code. This class can use the html string or the path of a html file.
It allows to replace some keys in the text with other string values. It does not allow page break

Field Summary

Fields

Modifier and Type	Field and Description
static String	CELL_HEAD_TAG
static String	CELL_TAG
protected String	code
static boolean	DEBUG
protected HTMLDocument	document
protected HTMLEditorKit	editor
static String	END_CELL_HEAD_TAG
static String	END_CELL_TAG
static String	END_ROW_TAG
static String	END_TABLE_TAG
protected String	footId
protected String	headId
static String	ROW_TAG
static String	TABLE_TAG
protected JTextPane	textPane

Constructor Summary

Constructors

Constructor and Description
HTMLProcessor(String htmlCode, URL base) Creates a processor class using the html code
HTMLProcessor(URL fileURL) Builds a new processor using the html file with the specified URL
HTMLProcessor(URL fileURL, URL base) Builds a new processor using the file with the specified URL

Method Summary

Methods

Modifier and Type	Method and Description
void	advancedPrint(PageFormat pf, int height)
HTMLDocument	getDocument() Get the document used for this processor to can use it in a text panel
HTMLEditorKit	getEditorKit() Get the EditorKit used for this processor to can use it in a text panel
String	getHTML()
JTextPane	getJTextPane() Get a JTextPanel with the current document text The processor save a reference to the returned panel
Printable	getPrintable(PageFormat pf, int height)
String	insertTable(String text, Hashtable tableValues)
String	insertTable(String text, Hashtable tableValues, Vector sortColumns) Insert a table using its values, replacing in the html code the key word text with the table HTML equivalence.
void	print(PageFormat pf, int height)
void	replaceTextInHTML(String text, byte[] imageBytes, int width, int height) Replace the text in the html code with the image represented by the bytes array.
void	replaceTextInHTML(String text, String newText) Replaces the text in the string HTML with the newText This replaces the code in the same html code and this method must be used carefully.
void	reset() Undo all the changes in the html code and set the original value again
void	setFoot(String id) Fixes the element with attribute id as footer in the template for all the pages.If the element has children the children will be in the footer too.
void	setHead(String id) Fixes the element with attribute id as header in the template for all the pages.
Vector	toPages(PageFormat pageFormat) Gets a vector of JTextPane with the document separated by pages with the specified page format.
void	updateTextPane() Update the values of the JTextPane with the last changes in the HTML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

TABLE_TAG

public static final String TABLE_TAG

See Also:

Constant Field Values

ROW_TAG

public static final String ROW_TAG

See Also:

Constant Field Values

CELL_HEAD_TAG

public static final String CELL_HEAD_TAG

See Also:

Constant Field Values

CELL_TAG

public static final String CELL_TAG

See Also:

Constant Field Values

END_ROW_TAG

public static final String END_ROW_TAG

See Also:

Constant Field Values

END_CELL_HEAD_TAG

public static final String END_CELL_HEAD_TAG

See Also:

Constant Field Values

END_CELL_TAG

public static final String END_CELL_TAG

See Also:

Constant Field Values

END_TABLE_TAG

public static final String END_TABLE_TAG

See Also:

Constant Field Values

code

protected String code

document

protected HTMLDocument document

editor

protected HTMLEditorKit editor

textPane

protected JTextPane textPane

headId

protected String headId

footId

protected String footId

Constructor Detail

HTMLProcessor

public HTMLProcessor(String htmlCode,
             URL base)
              throws Exception

Creates a processor class using the html code

Parameters:

htmlCode -

base -

Throws:

Exception

HTMLProcessor

public HTMLProcessor(URL fileURL,
             URL base)
              throws Exception

Builds a new processor using the file with the specified URL

Parameters:

fileURL -

base -

Throws:

Exception

HTMLProcessor

public HTMLProcessor(URL fileURL)
              throws Exception

Builds a new processor using the html file with the specified URL

Parameters:

fileURL -

Throws:

Exception

Method Detail

replaceTextInHTML

public void replaceTextInHTML(String text,
                     String newText)

Replaces the text in the string HTML with the newText
This replaces the code in the same html code and this method must be used carefully.

Parameters:

text - Text to replace

newText - New text to set

replaceTextInHTML

public void replaceTextInHTML(String text,
                     byte[] imageBytes,
                     int width,
                     int height)

Replace the text in the html code with the image represented by the bytes array.
If width or height are 0 then the image size will be the real
With values different from 0 this method scales the image. The method replaces te values in the html code and must be used carefully

Parameters:

text -

imageBytes -

width -

height -

getEditorKit

public HTMLEditorKit getEditorKit()

Get the EditorKit used for this processor to can use it in a text panel

Returns:

getDocument

public HTMLDocument getDocument()

Get the document used for this processor to can use it in a text panel

Returns:

getHTML

public String getHTML()

getJTextPane

public JTextPane getJTextPane()

Get a JTextPanel with the current document text The processor save a reference to the returned panel

Returns:

updateTextPane

public void updateTextPane()

Update the values of the JTextPane with the last changes in the HTML

reset

public void reset()
           throws Exception

Undo all the changes in the html code and set the original value again

Throws:

Exception

insertTable

public String insertTable(String text,
                 Hashtable tableValues,
                 Vector sortColumns)

Insert a table using its values, replacing in the html code the key word text with the table HTML equivalence.

Parameters:

text -

tableValues - The keys of this hashtable are the names of the table columns and the values are vectors whit the column values. If some of these values are hashtables then they are new tables in the appropriate cell.

sortColumns - This vector contains the name of the table columns in the order to put them in the table. These columns must be the keys of the tableValues hashtable

Returns:

insertTable

public String insertTable(String text,
                 Hashtable tableValues)

toPages

public Vector toPages(PageFormat pageFormat)

Gets a vector of JTextPane with the document separated by pages with the specified page format.

Parameters:

pageFormat -

Returns:

print

public void print(PageFormat pf,
         int height)

setHead

public void setHead(String id)

Fixes the element with attribute id as header in the template for all the pages. If the element has children the children will be in the header too.

Parameters:

id -

setFoot

public void setFoot(String id)

Fixes the element with attribute id as footer in the template for all the pages.If the element has children the children will be in the footer too.

Parameters:

id -

advancedPrint

public void advancedPrint(PageFormat pf,
                 int height)

Parameters:

pf - Page format to use in the printing method

height - Height in pixels from the text pane of this processor

getPrintable

public Printable getPrintable(PageFormat pf,
                     int height)