Package com.scroogexhtml.converter
Interface ConversionConfiguration
- All Known Implementing Classes:
ScroogeXHTML
,ScroogeXHTMLBase
,ScroogeXHTMLMain
public interface ConversionConfiguration
Conversion configuration interface.
This interface represents all readable properties of a ScroogeXHTML instance.
-
Method Summary
Modifier and TypeMethodDescriptionThis property contains the default font color.This property contains the default font name.int
This property contains the default font size.This property contains the default language.This property contains the output document type.This property contains the font size unit.int
This property contains the number of blanks in the output indentation.This property contains the list of post-process listeners.This property contains the tab string.boolean
Returns true if the conversion will enclose the generated markup.boolean
boolean
This property controls the conversion of bookmarks.boolean
This property controls the conversion of empty paragraphs to linebreaks.boolean
boolean
boolean
boolean
boolean
boolean
boolean
This property controls the conversion of footnotes.boolean
This property controls the conversion of hyperlinks.boolean
boolean
boolean
boolean
This property controls the conversion of pictures.boolean
This property controls the conversion of tables.boolean
If this property is set to true, the HTML head section will include a CSS definition for the default font style.
-
Method Details
-
isAddOuterHTML
boolean isAddOuterHTML()Returns true if the conversion will enclose the generated markup.- Returns:
- true if the conversion will enclose the generated markup.
-
isConvertBookmarks
boolean isConvertBookmarks()This property controls the conversion of bookmarks.- Returns:
- true if the conversion of bookmarks is enabled.
-
isConvertEmptyParagraphs
boolean isConvertEmptyParagraphs()This property controls the conversion of empty paragraphs to linebreaks. If enabled, the result markup will contain <br> or <br /> instead of empty <p> elements.- Returns:
- true if the conversion of bookmarks to linebreaks is enabled.
-
isConvertFootnotes
boolean isConvertFootnotes()This property controls the conversion of footnotes.- Returns:
- true if the conversion of footnotes is enabled.
-
isConvertHyperlinks
boolean isConvertHyperlinks()This property controls the conversion of hyperlinks.- Returns:
- true if the conversion of hyperlinks is enabled.
-
isConvertPictures
boolean isConvertPictures()This property controls the conversion of pictures.- Returns:
- true if the conversion of pictures is enabled.
-
isConvertTables
boolean isConvertTables()This property controls the conversion of tables.- Returns:
- true if the conversion of tables is enabled.
-
isIncludeDefaultFontStyle
boolean isIncludeDefaultFontStyle()If this property is set to true, the HTML head section will include a CSS definition for the default font style.- Returns:
- true if the CSS definition for the default font style will be included.
-
getDefaultFontColor
String getDefaultFontColor()This property contains the default font color.- Returns:
- the default font color.
-
getDefaultFontName
String getDefaultFontName()This property contains the default font name.- Returns:
- the default font name.
-
getDefaultFontSize
int getDefaultFontSize()This property contains the default font size.- Returns:
- the default font size.
-
getDefaultLanguage
String getDefaultLanguage()This property contains the default language.- Returns:
- the default language.
-
getDocumentType
DocumentType getDocumentType()This property contains the output document type.- Returns:
- the output document type.
-
getFontSizeUnit
LengthUnit getFontSizeUnit()This property contains the font size unit.- Returns:
- the font size unit.
-
getIndentAmount
int getIndentAmount()This property contains the number of blanks in the output indentation.- Returns:
- the number of blanks in the output indentation.
-
getPostProcessListeners
List<PostProcessListener> getPostProcessListeners()This property contains the list of post-process listeners. The returned list is unmodifiable.- Returns:
- the list of post-process listeners.
-
getTabString
String getTabString()This property contains the tab string.- Returns:
- the tab string.
-
isConvertFontBGColor
boolean isConvertFontBGColor() -
isConvertFontColor
boolean isConvertFontColor() -
isConvertFontHLColor
boolean isConvertFontHLColor() -
isConvertFontName
boolean isConvertFontName() -
isConvertFontSize
boolean isConvertFontSize() -
isConvertFontStyle
boolean isConvertFontStyle() -
isConvertLanguage
boolean isConvertLanguage() -
isConvertAlignment
boolean isConvertAlignment() -
isConvertIndent
boolean isConvertIndent() -
isConvertParagraphMargins
boolean isConvertParagraphMargins()
-