public abstract class ScroogeXHTMLBase extends Object implements Serializable
Constructor and Description |
---|
ScroogeXHTMLBase() |
Modifier and Type | Method and Description |
---|---|
void |
addPostProcessListener(PostProcessListener listener)
Adds a post process listener.
|
String |
getDefaultFontColor() |
String |
getDefaultFontName() |
int |
getDefaultFontSize() |
String |
getDefaultLanguage() |
String |
getDocumentTitle() |
DocumentType |
getDocumentType() |
StringBuilder |
getFieldExpression() |
FontReplacing |
getFontReplacing() |
FontSizeUnit |
getFontSizeUnit() |
FontStatisticsCollecting |
getFontStatistics() |
int |
getIndentAmount() |
String |
getMetaAuthor() |
String |
getMetaDescription() |
String |
getMetaGenerator() |
String |
getMetaKeywords() |
String |
getMetaViewport() |
Properties |
getOutputProperties()
Get a copy of the output properties for the transformation.
|
String |
getOutputProperty(String key) |
PictureAdapter |
getPictureAdapter() |
List<PostProcessListener> |
getPostProcessListeners() |
Map<String,String> |
getReplaceFonts() |
String |
getStyleSheetInclude() |
List<String> |
getStyleSheetLinks() |
String |
getTabString() |
String |
getVersion() |
boolean |
isAddOuterHTML() |
boolean |
isConvertAlignment() |
boolean |
isConvertBookmarks() |
boolean |
isConvertEmptyParagraphs() |
boolean |
isConvertFields() |
boolean |
isConvertFontBGColor() |
boolean |
isConvertFontColor() |
boolean |
isConvertFontHLColor() |
boolean |
isConvertFontName() |
boolean |
isConvertFontSize() |
boolean |
isConvertFontStyle() |
boolean |
isConvertFootnotes() |
boolean |
isConvertHyperlinks() |
boolean |
isConvertIndent() |
boolean |
isConvertLanguage() |
boolean |
isConvertPictures() |
boolean |
isConvertTables() |
boolean |
isIncludeDefaultFontStyle() |
static String |
nameAndVersion()
Name and version of ScroogeXHTML.
|
void |
removePostProcessListener(PostProcessListener listener)
Removes a post process listener.
|
void |
setAddOuterHTML(boolean newValue)
Set this property to true to include the HTML header section, and place
the generated HTML between the <body> and </body> tags.
|
void |
setConvertAlignment(boolean newValue)
Set this property to false to disable paragraph alignment conversion.
|
void |
setConvertBookmarks(boolean newValue)
Set this property to true to activate bookmark conversion.
|
void |
setConvertEmptyParagraphs(boolean newValue)
Enable conversion of empty paragraphs to line break tags (<br />).
|
void |
setConvertFields(boolean newValue)
Set this property to true to enable processing of RTF field expressions.
|
void |
setConvertFontBGColor(boolean newValue)
Set ConvertFontBGColor to true to enable conversion of text background
colors.
|
void |
setConvertFontColor(boolean newValue)
Set this property to true to enable conversion of font colors.
|
void |
setConvertFontHLColor(boolean newValue)
Set ConvertFontHLColor to true to enable conversion of text highlight
colors.
|
void |
setConvertFontName(boolean newValue)
Set this property to true to enable conversion of font names.
|
void |
setConvertFontSize(boolean newValue)
Set this property to true to enable conversion of font sizes.
|
void |
setConvertFontStyle(boolean newValue)
Set this property to true to enable conversion of font styles (bold,
italic, strike, underline, subscript, superscript).
|
void |
setConvertFootnotes(boolean newValue)
Set this property to true to enable conversion of footnotes.
|
void |
setConvertHyperlinks(boolean newValue)
Set this property to true to enable conversion of hyperlinks.
|
void |
setConvertIndent(boolean newValue)
Set this property to true to enable conversion of indents.
|
void |
setConvertLanguage(boolean newValue)
Set this property to true to enable generation of lang attributes.
|
void |
setConvertPictures(boolean newValue)
Set this property to true to enable extraction of picture data.
|
void |
setConvertTables(boolean newValue)
Set this property to true to enable table conversion.
|
void |
setDefaultFontColor(String newValue)
Use this property to optimize the HTML code generation.
|
void |
setDefaultFontName(String newValue)
Use this property to optimize the HTML code generation.
|
void |
setDefaultFontSize(int newValue)
Use this property to optimize the HTML code generation.
|
void |
setDefaultLanguage(String newValue)
Set the default language code.
|
void |
setDocumentTitle(String newValue)
Sets the document title.
|
void |
setDocumentType(DocumentType newValue)
Sets the documentType property.
|
void |
setFontReplacing(FontReplacing fontReplacing)
Sets the FontReplacing object.
|
void |
setFontSizeUnit(FontSizeUnit newValue)
Set the fontSizeUnit property.
|
void |
setFontStatistics(FontStatisticsCollecting fontStatistics)
Set the FontStatistics property.
|
void |
setIncludeDefaultFontStyle(boolean newValue)
If this property is set to true, the HTML head section will include a CSS
definition for the default font style.
|
void |
setIndentAmount(int newValue)
This property specifies the indentation level.
|
void |
setMetaAuthor(String newValue)
This property may be used to specify a META tag which contains the
document author.
|
void |
setMetaDescription(String newValue)
This property may be used to specify a document description.
|
void |
setMetaGenerator(String newValue)
This property may be used to specify the content of the generator meta
element.
|
void |
setMetaKeywords(String newValue)
This property may be used to specify keywords for the document.
|
void |
setMetaViewport(String newValue)
Use this property to define the meta viewport tag manually.
|
void |
setOutputProperty(String name,
String value)
Set an output property that will be in effect for the conversion.
|
void |
setPictureAdapter(PictureAdapter newValue)
Set the picture adapter.
|
void |
setStyleSheetInclude(String newValue)
Additional style sheet definitions which are stored in the HTML document.
|
void |
setStyleSheetLink(String href)
URL of a file which contains external CSS style sheet definitions for the
HTML document.
|
void |
setTabString(String newValue)
Sets the string which will be used to replace a \\tab token in the RTF
document.
|
public static String nameAndVersion()
public StringBuilder getFieldExpression()
public void addPostProcessListener(PostProcessListener listener)
listener
- the post process listenerpublic void removePostProcessListener(PostProcessListener listener)
listener
- the post process listenerpublic void setAddOuterHTML(boolean newValue)
newValue
- The new addOuterHTML valueisAddOuterHTML()
public void setConvertAlignment(boolean newValue)
newValue
- the new convertAlignment valueisConvertAlignment()
public void setConvertBookmarks(boolean newValue)
newValue
- the new convertBookmarks valueisConvertBookmarks()
public void setConvertEmptyParagraphs(boolean newValue)
newValue
- The new convertEmptyParagraphs valueisConvertEmptyParagraphs()
public void setConvertFields(boolean newValue)
newValue
- the new convertFields valueisConvertFields()
public void setConvertFontBGColor(boolean newValue)
// switch off background color conversion scroogeXHTML1.setConvertBGColor(false); // switch off higlight color conversion scroogeXHTML1.setConvertHLColor(false);
newValue
- The new convertFontBGColor valueisConvertFontBGColor()
ConvertFontHLColor
property. public void setConvertFontColor(boolean newValue)
newValue
- The new convertFontColor valueisConvertFontColor()
public void setConvertFontHLColor(boolean newValue)
// switch off background color conversion scroogeXHTML1.setConvertBGColor(false); // switch off higlight color conversion scroogeXHTML1.setConvertHLColor(false);
newValue
- The new convertFontHLColor valueisConvertFontHLColor()
ConvertFontBGColor
property.public void setConvertFontName(boolean newValue)
newValue
- The new convertFontName valueisConvertFontName()
public void setConvertFontSize(boolean newValue)
newValue
- The new convertFontSize valueisConvertFontSize()
public void setConvertFontStyle(boolean newValue)
newValue
- The new convertFontStyle valueisConvertFontStyle()
public void setConvertFootnotes(boolean newValue)
newValue
- The new convertFootnotes valueisConvertFootnotes()
public void setConvertHyperlinks(boolean newValue)
newValue
- The new convertHyperlinks valueisConvertHyperlinks()
public void setConvertIndent(boolean newValue)
newValue
- The new convertIndent valueisConvertIndent()
public void setConvertLanguage(boolean newValue)
newValue
- The new convertLanguage valueisConvertLanguage()
public void setConvertPictures(boolean newValue)
newValue
- The new convertSpaces valueisConvertPictures()
public void setConvertTables(boolean newValue)
newValue
- The new convertTables valueisConvertTables()
public void setDefaultFontColor(String newValue)
newValue
- The new defaultFontColor valuegetDefaultFontColor()
DEFAULT_FONT_COLOR
IncludeDefaultFontStyle
is set to true.public void setDefaultFontName(String newValue)
newValue
- The new defaultFontName valuegetDefaultFontName()
DEFAULT_FONT_NAME
IncludeDefaultFontStyle
is set to true.public void setDefaultFontSize(int newValue)
newValue
- The new defaultFontSize valuegetDefaultFontSize()
DEFAULT_FONT_SIZE
IncludeDefaultFontStyle
is set to true.public void setDefaultLanguage(String newValue)
newValue
- the new defaultLanguage value.getDefaultLanguage()
public void setDocumentTitle(String newValue)
newValue
- The new documentTitle valuegetDocumentTitle()
AddOuterHTML
is set to true.public void setDocumentType(DocumentType newValue)
newValue
- the new documentType valuegetDocumentType()
public void setFontReplacing(FontReplacing fontReplacing)
fontReplacing
- the new FontReplacing value.public void setFontSizeUnit(FontSizeUnit newValue)
newValue
- the new FontSizeUnit valuegetFontSizeUnit()
public void setFontStatistics(FontStatisticsCollecting fontStatistics)
fontStatistics
- the new FontStatistics valuegetFontStatistics()
public void setIncludeDefaultFontStyle(boolean newValue)
newValue
- The new includeDefaultFontStyle valueisIncludeDefaultFontStyle()
public void setIndentAmount(int newValue)
newValue
- the new indentAmount valuegetIndentAmount()
public void setMetaAuthor(String newValue)
newValue
- The new metaAuthor valuegetMetaAuthor()
AddOuterHTML
is set to true.public void setMetaDescription(String newValue)
newValue
- The new metaDescription valuegetMetaDescription()
AddOuterHTML
is set to true.public void setMetaGenerator(String newValue)
newValue
- The new metaGenerator valuegetMetaGenerator()
public void setMetaKeywords(String newValue)
newValue
- The new metaKeywords valuegetMetaKeywords()
AddOuterHTML
is set to true.public void setMetaViewport(String newValue)
newValue
- The new viewport valuegetMetaViewport()
AddOuterHTML
is set to true.public final void setOutputProperty(String name, String value) throws IllegalArgumentException
name
- A non-null String that specifies an output property namevalue
- The non-null string value of the output property.IllegalArgumentException
- If the property is not supported.getOutputProperty(java.lang.String)
public void setPictureAdapter(PictureAdapter newValue)
newValue
- the new pictureAdapter valuegetPictureAdapter()
public void setStyleSheetInclude(String newValue)
newValue
- The new styleSheetInclude valuegetStyleSheetInclude()
AddOuterHTML
is set to true.public void setStyleSheetLink(String href)
href
- The new styleSheetLink valuegetStyleSheetLinks()
AddOuterHTML
is set to true.public void setTabString(String newValue)
newValue
- The new tabStringgetTabString()
public boolean isAddOuterHTML()
public boolean isConvertAlignment()
public boolean isConvertBookmarks()
public boolean isConvertEmptyParagraphs()
public boolean isConvertFields()
public boolean isConvertFontBGColor()
public boolean isConvertFontColor()
public boolean isConvertFontHLColor()
public boolean isConvertFontName()
public boolean isConvertFontSize()
public boolean isConvertFontStyle()
public boolean isConvertFootnotes()
public boolean isConvertHyperlinks()
public boolean isConvertIndent()
public boolean isConvertLanguage()
public boolean isConvertPictures()
public boolean isConvertTables()
public String getDefaultFontColor()
public String getDefaultFontName()
public int getDefaultFontSize()
public String getDefaultLanguage()
public String getDocumentTitle()
public DocumentType getDocumentType()
public FontReplacing getFontReplacing()
public FontSizeUnit getFontSizeUnit()
public FontStatisticsCollecting getFontStatistics()
public boolean isIncludeDefaultFontStyle()
public int getIndentAmount()
public String getMetaAuthor()
public String getMetaDescription()
public String getMetaGenerator()
public String getMetaKeywords()
public String getMetaViewport()
public Properties getOutputProperties()
public PictureAdapter getPictureAdapter()
public List<PostProcessListener> getPostProcessListeners()
public String getStyleSheetInclude()
public String getTabString()
public String getVersion()
Copyright © 2019 Habarisoft. All rights reserved.