Package com.scroogexhtml.converter
Interface Writer
- All Superinterfaces:
BorderPropertiesWriter,CharacterPropertiesWriter,DocumentWriter,FieldWriter,FootnoteWriter,HeaderFooterWriter,PageSetupWriter,ParagraphPropertiesWriter,TableStateWriter
- All Known Implementing Classes:
AbstractWriter,XMLDOMWriter
public interface Writer
extends DocumentWriter, CharacterPropertiesWriter, ParagraphPropertiesWriter, FieldWriter, FootnoteWriter, HeaderFooterWriter, TableStateWriter, PageSetupWriter, BorderPropertiesWriter
Writer interface.
The converter uses a Writer to create the result document, and apply character and paragraph properties to it successively.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddPicture(EmbeddedPicture value) voidApplies the paragraph properties to the document.voidApplies the text properties to the current document writer.Retrieves the CharacterProperties object that represents the current state data of the Writer.Returns the default font name of the Writer.Retrieves the ParagraphProperties object that represents the current state data of the Writer.charintToChar(int value) voidvoidvoidResets the character attributes of the current document writer.voidReset the paragraph attributes to their default values.voidsetDefaultFont(FontDescriptor value) voidsetListLevel(int value) voidsetListOverrideIndex(int paramValue) voidsetNodeCharset(int value) voidsetNumberingLevel(NumberingLevel value) voidsetNumberingStyle(boolean value) Methods inherited from interface com.scroogexhtml.converter.BorderPropertiesWriter
setBorderColor, setBorderStyle, setBorderWidthMethods inherited from interface com.scroogexhtml.converter.CharacterPropertiesWriter
setBGColor, setBold, setFontCharSet, setFontColor, setFontName, setFontSize, setHidden, setHLColor, setItalic, setLanguage, setRightToLeftChar, setStrike, setSubscript, setSubscript, setSuperscript, setSuperscript, setUnderlineMethods inherited from interface com.scroogexhtml.converter.DocumentWriter
add, add, addLinebreak, getResult, writeChar, writeEof, writeTabMethods inherited from interface com.scroogexhtml.converter.FieldWriter
addAnchor, finishField, finishFldInst, finishFldRslt, getCurrentFieldExpression, setFieldExpressionMethods inherited from interface com.scroogexhtml.converter.FootnoteWriter
addAutoFootnoteRef, footnoteEnd, footnoteStart, isInFootnoteMethods inherited from interface com.scroogexhtml.converter.HeaderFooterWriter
footerEnd, footerStart, headerEnd, headerStartMethods inherited from interface com.scroogexhtml.converter.PageSetupWriter
calculateCurrentPageWidth, setLeftMargin, setPaperWidth, setRightMarginMethods inherited from interface com.scroogexhtml.converter.ParagraphPropertiesWriter
setAlignment, setFirstIndent, setLeftIndent, setParagraphBackgroundColor, setParagraphBorder, setParagraphInTable, setRightIndent, setRightToLeftPar, setSpaceAfter, setSpaceBeforeMethods inherited from interface com.scroogexhtml.converter.TableStateWriter
nestedTableCellEnds, nestedTableRowEnds, setItap, tableCellEnds
-
Method Details
-
getCharacterProperties
CharacterProperties getCharacterProperties()Retrieves the CharacterProperties object that represents the current state data of the Writer.- Returns:
- The character properties.
-
getParagraphProperties
ParagraphProperties getParagraphProperties()Retrieves the ParagraphProperties object that represents the current state data of the Writer.- Returns:
- The paragraph properties.
-
popParagraphProperties
-
popCharacterProperties
-
resetCharacterAttributes
void resetCharacterAttributes()Resets the character attributes of the current document writer. This method can be used to remove any special formatting applied to the text. It sets the character properties to their default values. -
setDefaultFont
-
getDefaultFontName
String getDefaultFontName()Returns the default font name of the Writer.- Returns:
- The default font name.
-
resetParagraphAttributes
void resetParagraphAttributes()Reset the paragraph attributes to their default values. This method is used to remove any special formatting applied to the paragraph. Invoked when the RTF token \pard appears. -
applyTextProperties
void applyTextProperties()Applies the text properties to the current document writer. This method should be called after any text property is changed. The properties include font style, color, background color, underline, highlight color, etc. The current document writer is responsible for applying these properties to the document. -
applyParagraphProperties
void applyParagraphProperties()Applies the paragraph properties to the document. -
intToChar
char intToChar(int value) -
setNodeCharset
void setNodeCharset(int value) -
setNumberingStyle
void setNumberingStyle(boolean value) -
setNumberingLevel
-
getListHeaderInfo
ListHeaderInfo getListHeaderInfo() -
setListLevel
void setListLevel(int value) -
setListOverrideIndex
void setListOverrideIndex(int paramValue) -
addPicture
-
getTableWriter
TableWriter getTableWriter()
-