com.pilot.jword.writer

Class XHTMLWriter

java.lang.Object

com.pilot.jword.writer.XHTMLWriter

public class XHTMLWriter
extends java.lang.Object

A writer class for XHTML format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XHTMLWriter.LevelStore Level status keeper for stack

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_openCharGroup
protected CharacterProperties	charProps
protected java.util.Vector	colorList
protected JWordDocument	document
static java.lang.String	EOL
static int	EQUATION_AS_EMBEDDED_SVG
static int	EQUATION_AS_EXTERNAL_SVG
static int	EQUATION_AS_MATH
static int	EQUATION_AS_PNG
protected java.util.Vector	fontList
protected java.util.ArrayList<NumberedList>	numberedLists
protected java.util.Vector	pictList
protected java.util.Vector	styleList
static int	SVG_AS_EMBEDDED_SVG
static int	SVG_AS_EXTERNAL_SVG
static int	SVG_AS_PNG
static int	WMF_AS_EMBEDDED_SVG
static int	WMF_AS_EXTERNAL_SVG
static int	WMF_AS_PNG

Constructor Summary

Constructors

Constructor and Description
XHTMLWriter(JWordDocument doc, XHTMLObjectHandler objectHandler, int svgOption, int wmfOption, int equationOption, int dpi, int imageDpi, boolean useObjectTagForSvg) Constructs new writer instance.
XHTMLWriter(JWordDocument doc, XHTMLObjectHandler objectHandler, int svgOption, int wmfOption, int equationOption, int dpi, int imageDpi, boolean useObjectTagForSvg, boolean singleFile, java.lang.String linkTarget, int HTMLversion) Constructs new writer instance.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Double	convertPixelsToTwips(java.lang.Double value) Convert pixel measure into the twips.
protected java.lang.String	createStyleTable(java.util.Vector styleList) Creates text representation of the style table.
protected java.lang.String	getAllCharDescription(CharacterProperties cp, javax.swing.text.AttributeSet attr, boolean isStyle) get character attributes as a string from the given properties.
protected java.lang.String	getBorder(Border brd) get string representation of the given border
protected javax.swing.text.Element	getDocumentTree() Gets tree of the document's elements.
protected java.util.Vector	getFontList(javax.swing.text.Element root, java.util.Vector list) Gets fonts which are used in subtree.
protected java.lang.String	getListStyle(Numbering num, int level)
protected java.lang.String	getParagraphDescription(javax.swing.text.AttributeSet attr, boolean isStyle) Get text representation of the paragraph.
protected java.util.Vector	getStyleList() gets style list from the document
protected boolean	isInList(java.util.Vector list, java.lang.Object fontName) Checks whether object is in list.
void	write(java.io.OutputStream out, int pos, int len, boolean bodyOnly) Performs writing to a writer.
void	write(java.lang.String fileName) Performs writing to a file.
protected void	writeBorder(java.io.Writer out, Border brd) Write border attributes for a single border
protected void	writeCell(javax.swing.text.Element cell, int level, Dimension width) writes a cell
protected void	writeCellContent(javax.swing.text.Element cell, int level) Writes content of the cell.
protected void	writeCellDefinition(javax.swing.text.Element cell, com.pilot.irun.PrintWriter out, Dimension width) write cell definition
protected void	writeColumnDefinition(TableColumn col, com.pilot.irun.PrintWriter out) write table column definition
protected void	writeContent(javax.swing.text.Element root, int level, int pos, int len) writes content of an element starting at pos and len amount
protected void	writeEquation(javax.swing.text.Element leaf) writes an equation
protected void	writeField(javax.swing.text.Element leaf) Writes the field element.
protected void	writeFormField(javax.swing.text.Element leaf) Writes the form field element.
protected void	writeHeader(com.pilot.irun.PrintWriter pw) print XML header for content
protected void	writeIcon(javax.swing.text.AttributeSet attr, PaintableIcon icon, int objId, boolean equation, float align) Writes an image.
protected void	writeIcon(javax.swing.text.Element leaf) writes an icon element
protected void	writeLeaf(javax.swing.text.Element leaf, int pos, int len) Writes the leaf element.
protected void	writeParagraph(javax.swing.text.Element paragraph, int level, boolean lastInTable, int pos, int len, boolean breakBefore) Writes content of single paragraph.
protected void	writeRow(javax.swing.text.Element row, int level) Writes row element.
protected void	writeRowContent(javax.swing.text.Element row, com.pilot.irun.PrintWriter out, int level) writes row content (cells)
protected void	writeRowDefinition(javax.swing.text.Element row, com.pilot.irun.PrintWriter out) write row definition
protected void	writeTable(javax.swing.text.Element table, int level) Writes table element.
protected void	writeTableDefinition(javax.swing.text.Element table, com.pilot.irun.PrintWriter out) writes table definition (attributes) to the output writer.

Methods inherited from class java.lang.Object

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

Field Detail

document

protected JWordDocument document

fontList

protected java.util.Vector fontList

colorList

protected java.util.Vector colorList

styleList

protected java.util.Vector styleList

pictList

protected java.util.Vector pictList

numberedLists

protected java.util.ArrayList<NumberedList> numberedLists

EOL

public static java.lang.String EOL

charProps

protected CharacterProperties charProps

_openCharGroup

protected boolean _openCharGroup

SVG_AS_PNG

public static final int SVG_AS_PNG

See Also:

Constant Field Values

SVG_AS_EMBEDDED_SVG

public static final int SVG_AS_EMBEDDED_SVG

See Also:

Constant Field Values

SVG_AS_EXTERNAL_SVG

public static final int SVG_AS_EXTERNAL_SVG

See Also:

Constant Field Values

WMF_AS_PNG

public static final int WMF_AS_PNG

See Also:

Constant Field Values

WMF_AS_EMBEDDED_SVG

public static final int WMF_AS_EMBEDDED_SVG

See Also:

Constant Field Values

WMF_AS_EXTERNAL_SVG

public static final int WMF_AS_EXTERNAL_SVG

See Also:

Constant Field Values

EQUATION_AS_PNG

public static final int EQUATION_AS_PNG

See Also:

Constant Field Values

EQUATION_AS_EMBEDDED_SVG

public static final int EQUATION_AS_EMBEDDED_SVG

See Also:

Constant Field Values

EQUATION_AS_EXTERNAL_SVG

public static final int EQUATION_AS_EXTERNAL_SVG

See Also:

Constant Field Values

EQUATION_AS_MATH

public static final int EQUATION_AS_MATH

See Also:

Constant Field Values

Constructor Detail

XHTMLWriter

public XHTMLWriter(JWordDocument doc,
                   XHTMLObjectHandler objectHandler,
                   int svgOption,
                   int wmfOption,
                   int equationOption,
                   int dpi,
                   int imageDpi,
                   boolean useObjectTagForSvg)

Constructs new writer instance.

Parameters:

doc - document for writing.

XHTMLWriter

public XHTMLWriter(JWordDocument doc,
                   XHTMLObjectHandler objectHandler,
                   int svgOption,
                   int wmfOption,
                   int equationOption,
                   int dpi,
                   int imageDpi,
                   boolean useObjectTagForSvg,
                   boolean singleFile,
                   java.lang.String linkTarget,
                   int HTMLversion)

Constructs new writer instance.

Parameters:

doc - document for writing.

Method Detail

write

public void write(java.lang.String fileName)
           throws java.io.IOException

Performs writing to a file.

Parameters:

fileName - Name of file

Throws:

java.io.IOException - occurs when writing is failed.

writeHeader

protected void writeHeader(com.pilot.irun.PrintWriter pw)

print XML header for content

Parameters:

pw -

write

public void write(java.io.OutputStream out,
                  int pos,
                  int len,
                  boolean bodyOnly)
           throws java.io.IOException

Performs writing to a writer.

Parameters:

out - writer

Throws:

java.io.IOException - occurs when writing is failed.

writeContent

protected void writeContent(javax.swing.text.Element root,
                            int level,
                            int pos,
                            int len)
                     throws java.io.IOException

writes content of an element starting at pos and len amount

Parameters:

root - root element

level - depth of element in tables (default 0)

pos - start offset

len - length

Throws:

java.io.IOException

writeParagraph

protected void writeParagraph(javax.swing.text.Element paragraph,
                              int level,
                              boolean lastInTable,
                              int pos,
                              int len,
                              boolean breakBefore)
                       throws java.io.IOException

Writes content of single paragraph.

Parameters:

paragraph -

level - content level (default 0). If element in the table level is 1. if it in the nested table level is 2 etc.

lastInTable - if true that means paragraph is last paragraph in the table cell.

pos - start offset

len - length

Throws:

java.io.IOException - occurs when writing is failed.

writeEquation

protected void writeEquation(javax.swing.text.Element leaf)
                      throws java.io.IOException

writes an equation

Parameters:

leaf -

Throws:

java.io.IOException

writeLeaf

protected void writeLeaf(javax.swing.text.Element leaf,
                         int pos,
                         int len)
                  throws java.io.IOException

Writes the leaf element.

Parameters:

leaf - the leaf element to write

pos - start offset

len - length

Throws:

java.io.IOException - occurs when writing is failed.

writeFormField

protected void writeFormField(javax.swing.text.Element leaf)
                       throws java.io.IOException

Writes the form field element.

Parameters:

leaf -

Throws:

java.io.IOException - occurs when writing is failed.

writeField

protected void writeField(javax.swing.text.Element leaf)
                   throws java.io.IOException

Writes the field element.

Parameters:

leaf -

Throws:

java.io.IOException - occurs when writing is failed.

writeIcon

protected void writeIcon(javax.swing.text.Element leaf)
                  throws java.io.IOException

writes an icon element

Parameters:

leaf -

Throws:

java.io.IOException

writeIcon

protected void writeIcon(javax.swing.text.AttributeSet attr,
                         PaintableIcon icon,
                         int objId,
                         boolean equation,
                         float align)
                  throws java.io.IOException

Writes an image.

Parameters:

attr - attributes

leaf - leaf element containing image

Throws:

java.io.IOException - occurs when writing is failed.

writeTableDefinition

protected void writeTableDefinition(javax.swing.text.Element table,
                                    com.pilot.irun.PrintWriter out)

writes table definition (attributes) to the output writer.

Parameters:

table -

out -

writeRowDefinition

protected void writeRowDefinition(javax.swing.text.Element row,
                                  com.pilot.irun.PrintWriter out)

write row definition

Parameters:

row -

out -

writeColumnDefinition

protected void writeColumnDefinition(TableColumn col,
                                     com.pilot.irun.PrintWriter out)

write table column definition

Parameters:

col -

out -

writeCellDefinition

protected void writeCellDefinition(javax.swing.text.Element cell,
                                   com.pilot.irun.PrintWriter out,
                                   Dimension width)
                            throws java.io.IOException

write cell definition

Parameters:

cell -

out -

Throws:

java.io.IOException

writeTable

protected void writeTable(javax.swing.text.Element table,
                          int level)
                   throws java.io.IOException

Writes table element.

Parameters:

table -

level - content level (default 0). If element in the table level is 1. if it in the nested table level is 2 etc.

Throws:

java.io.IOException - occurs when writing is failed.

writeRowContent

protected void writeRowContent(javax.swing.text.Element row,
                               com.pilot.irun.PrintWriter out,
                               int level)
                        throws java.io.IOException

writes row content (cells)

Parameters:

row -

out -

level -

Throws:

java.io.IOException

writeRow

protected void writeRow(javax.swing.text.Element row,
                        int level)
                 throws java.io.IOException

Writes row element.

Parameters:

row -

level - content level (default 0). If element in the table level is 1. if it in the nested table level is 2 etc.

Throws:

java.io.IOException - occurs when writing is failed.

writeCellContent

protected void writeCellContent(javax.swing.text.Element cell,
                                int level)
                         throws java.io.IOException

Writes content of the cell.

Parameters:

cell -

level - content level (default 0). If element in the table level is 1. if it in the nested table level is 2 etc.

Throws:

java.io.IOException - occurs when writing is failed.

getBorder

protected java.lang.String getBorder(Border brd)

get string representation of the given border

Parameters:

brd -

Returns:

writeBorder

protected void writeBorder(java.io.Writer out,
                           Border brd)
                    throws java.io.IOException

Write border attributes for a single border

Parameters:

out -

brd -

Throws:

java.io.IOException

writeCell

protected void writeCell(javax.swing.text.Element cell,
                         int level,
                         Dimension width)
                  throws java.io.IOException

writes a cell

Parameters:

cell -

level -

width -

Throws:

java.io.IOException

getDocumentTree

protected javax.swing.text.Element getDocumentTree()

Gets tree of the document's elements.

getFontList

protected java.util.Vector getFontList(javax.swing.text.Element root,
                                       java.util.Vector list)

Gets fonts which are used in subtree.

Parameters:

root - root of subtree.

list - list of the fonts

getStyleList

protected java.util.Vector getStyleList()

gets style list from the document

Returns:

isInList

protected boolean isInList(java.util.Vector list,
                           java.lang.Object fontName)

Checks whether object is in list.

Parameters:

list -

fontName -

createStyleTable

protected java.lang.String createStyleTable(java.util.Vector styleList)

Creates text representation of the style table.

Parameters:

styleList - list of the document's styles.

getListStyle

protected java.lang.String getListStyle(Numbering num,
                                        int level)

getAllCharDescription

protected java.lang.String getAllCharDescription(CharacterProperties cp,
                                                 javax.swing.text.AttributeSet attr,
                                                 boolean isStyle)

get character attributes as a string from the given properties.

Parameters:

cp - character properties

attr - full attribute set

isStyle - is this a style?

Returns:

getParagraphDescription

protected java.lang.String getParagraphDescription(javax.swing.text.AttributeSet attr,
                                                   boolean isStyle)

Get text representation of the paragraph.

Parameters:

attr - Paragraph attributes.

isStyle - is this a style?

convertPixelsToTwips

protected java.lang.Double convertPixelsToTwips(java.lang.Double value)

Convert pixel measure into the twips.

Parameters:

value -