|
| |
|
| java.lang.Object
 com.xoetrope.io.XExportHelper
com.xoetrope.io.HtmlExportHelper
| HtmlExportHelper | | public class HtmlExportHelper extends XExportHelper (Code) | | A utility class to help export HTML
Copyright (c) Xoetrope Ltd., 2001-2006, This software is licensed under
the GNU Public License (GPL), please see license.txt for more details. If
you make commercial use of this software you must purchase a commercial
license from Xoetrope.
$Revision: 1.10 $
|
| isInRecord | | protected boolean isInRecord(Code) | | A flag indicating that the exporter is in the process of exporting a table
record
|
| isInTable | | protected boolean isInTable(Code) | | A flag indicating that the exporter is in the process of exporting a table
|
| isInTableHeader | | protected boolean isInTableHeader(Code) | | A flag indicating that the exporter is in the process of exporting a table
header
|
| styleManager | | protected XStyleManager styleManager(Code) | | The style manager
|
| HtmlExportHelper | | public HtmlExportHelper()(Code) | | Setup the exporter for HTML. Prepare for a new document.
|
| close | | public void close() throws IOException(Code) | | Flushes and closes any existing stream
throws:
java.io.IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| closeElement | | public void closeElement() throws IOException(Code) | | Write the closing of an element
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| endDocument | | public void endDocument() throws IOException(Code) | | Write the ending of a document
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| endElement | | public void endElement() throws IOException(Code) | | Write the end of an element opening
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| endElement | | public void endElement(String styleName) throws IOException(Code) | | Write the end of an element opening
Parameters:
styleName - the style of the section title or the section name e.g. HEADER_STYLE
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| endHeader | | public void endHeader() throws IOException(Code) | | Write the ending of a table record
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| endRecord | | public void endRecord() throws IOException(Code) | | Write the ending of a table record
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| endTable | | public void endTable() throws IOException(Code) | | Write the ending of a table
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| matchElement | | public void matchElement() throws IOException(Code) | | Write the matching ending element
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| prepareFieldName | | protected String prepareFieldName(String name)(Code) | | Prepare the field name for export
Parameters:
name - the raw name the prepared value |
| startDocument | | public void startDocument() throws IOException(Code) | | Write the opening of a document
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| startElement | | public void startElement(String elementName) throws IOException(Code) | | Write the begining/opening of an element
Parameters:
elementName - the element name
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| startElement | | public void startElement(String elementName, String styleName) throws IOException(Code) | | Write the begining/opening of an element
Parameters:
elementName - the element name
Parameters:
styleName - the style of the section title or the section name e.g. HEADER_STYLE
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| startHeader | | public void startHeader() throws IOException(Code) | | Write the opening of a table record
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| startRecord | | public void startRecord() throws IOException(Code) | | Write the opening of a table record
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| startTable | | public void startTable() throws IOException(Code) | | Write the opening of a table
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| toHexString | | public static String toHexString(int value)(Code) | | Get a two letter hex string for the decimal value in the range 0-255
Parameters:
value - the int value in the range 0-255 the two letter hex value |
| writeBlankLine | | public void writeBlankLine() throws IOException(Code) | | Output a blank line
throws:
IOException - thrown if the stream is not ready or if it is in an invalid state |
| writeBreak | | public void writeBreak() throws IOException(Code) | | Output a line break
throws:
IOException - thrown if the stream is not ready or if it is in an invalid state |
| writeField | | public void writeField(String name, String value) throws IOException(Code) | | Write a field
Parameters:
name - the field name
Parameters:
value - the field value
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| writeHorizontalLine | | public void writeHorizontalLine() throws IOException(Code) | | Output a line/ruler
throws:
IOException - thrown if the stream is not ready or if it is in an invalid state |
| writeImage | | public void writeImage(String imageName, String altText) throws IOException(Code) | | Output an image
Parameters:
imageName - the file name
Parameters:
altText - the alternative text |
| writeSectionEnd | | public void writeSectionEnd() throws IOException(Code) | | Write the end of a section
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| writeSectionTitle | | public void writeSectionTitle(String text) throws IOException(Code) | | Write the section title and terminate with a line feed, new line as appropriate
Parameters:
text - the text to output
throws:
IOException - thrown if the ooutput stream is not ready or in some other invalid state |
| writeSectionTitle | | public void writeSectionTitle(String text, String styleName) throws IOException(Code) | | Write the section title and terminate with a line feed, new line as appropriate
Parameters:
text - the text to output
Parameters:
styleName - the style of the section title or the section name e.g. HEADER_STYLE
throws:
IOException - thrown if the stream is not ready or if it is in an invalid state |
| writeText | | public void writeText(String name, String value, String styleName) throws IOException(Code) | | Write a field
Parameters:
name - the field name
Parameters:
value - the field value
Parameters:
styleName - the style to apply
throws:
IOException - thrown if the stream is not ready or if it is in an invalid state |
| Methods inherited from com.xoetrope.io.XExportHelper | public void addStyle(String sectionName, String styleName)(Code)(Java Doc)
public void close() throws IOException(Code)(Java Doc)
public void closeElement() throws IOException(Code)(Java Doc)
public void endDocument() throws IOException(Code)(Java Doc)
public void endElement() throws IOException(Code)(Java Doc)
public void endElement(String styleName) throws IOException(Code)(Java Doc)
public void endHeader() throws IOException(Code)(Java Doc)
public void endRecord() throws IOException(Code)(Java Doc)
public void endTable() throws IOException(Code)(Java Doc)
public void lostOwnership(Clipboard aClipboard, Transferable aContents)(Code)(Java Doc)
public void matchElement() throws IOException(Code)(Java Doc)
protected String prepareFieldName(String name)(Code)(Java Doc)
public void removeHint(String name)(Code)(Java Doc)
public void setClipboardContents(String aString)(Code)(Java Doc)
public void setComponentFactory(XComponentFactory cf)(Code)(Java Doc)
public void setFieldNameSeparator(String separatorStr)(Code)(Java Doc)
public void setFieldSeparator(String separatorStr)(Code)(Java Doc)
public void setHint(String name, String value)(Code)(Java Doc)
public void setLeftDelimiter(String delimStr)(Code)(Java Doc)
public void setOutputElementNames(boolean doOutput)(Code)(Java Doc)
public void setOutputFieldNames(boolean doOutput)(Code)(Java Doc)
public void setOutputWriter(Writer w)(Code)(Java Doc)
public void setRightDelimiter(String delimStr)(Code)(Java Doc)
public void setUseWindowsLineEnd(boolean use)(Code)(Java Doc)
public Writer setupWriter(XPage owner, String fileName)(Code)(Java Doc)
public void startDocument() throws IOException(Code)(Java Doc)
public void startElement(String elementName) throws IOException(Code)(Java Doc)
public void startElement(String elementName, String styleName) throws IOException(Code)(Java Doc)
public void startHeader() throws IOException(Code)(Java Doc)
public void startRecord() throws IOException(Code)(Java Doc)
public void startTable() throws IOException(Code)(Java Doc)
public void writeBlankLine() throws IOException(Code)(Java Doc)
public void writeBreak() throws IOException(Code)(Java Doc)
public void writeElement(String elementName, String name, String value) throws IOException(Code)(Java Doc)
public void writeElement(String elementName, String[] names, String[] values) throws IOException(Code)(Java Doc)
public void writeField(String name, String value) throws IOException(Code)(Java Doc)
public void writeHorizontalLine() throws IOException(Code)(Java Doc)
public void writeImage(String imageName, String altText) throws IOException(Code)(Java Doc)
public void writeLine(String text) throws IOException(Code)(Java Doc)
public void writeSectionEnd() throws IOException(Code)(Java Doc)
public void writeSectionTitle(String text) throws IOException(Code)(Java Doc)
public void writeSectionTitle(String text, String styleName) throws IOException(Code)(Java Doc)
public void writeText(String name, String value, String styleName) throws IOException(Code)(Java Doc)
|
|
|
|