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 Detail

      • isAddOuterHTML

        boolean isAddOuterHTML()

      • isConvertAlignment

        boolean isConvertAlignment()
        This property controls the conversion of paragraph alignment.
        Returns:
        true if the conversion of paragraph alignment is enabled.

      • 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.

      • isConvertFields

        boolean isConvertFields()
        This property controls the conversion of fields.
        Returns:
        true if the conversion of fields is enabled.

      • isConvertFontBGColor

        boolean isConvertFontBGColor()
        This property controls the conversion of background colors.
        Returns:
        true if the conversion of background colors is enabled.

      • isConvertFontColor

        boolean isConvertFontColor()
        This property controls the conversion of font colors.
        Returns:
        true if the conversion of font colors is enabled.

      • isConvertFontHLColor

        boolean isConvertFontHLColor()
        This property controls the conversion of highlight colors.
        Returns:
        true if the conversion of highlight is enabled.

      • isConvertFontName

        boolean isConvertFontName()
        This property controls the conversion of font names.
        Returns:
        true if the conversion of font names is enabled.

      • isConvertFontSize

        boolean isConvertFontSize()
        This property controls the conversion of font sizes.
        Returns:
        true if the conversion of font sizes is enabled.

      • isConvertFontStyle

        boolean isConvertFontStyle()
        This property controls the conversion of font styles.
        Returns:
        true if the conversion of font styles 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.

      • isConvertIndent

        boolean isConvertIndent()
        This property controls the conversion of paragraph indents.
        Returns:
        true if the conversion of pragraph indents is enabled.

      • isConvertLanguage

        boolean isConvertLanguage()
        This property controls the conversion of language attributes.
        Returns:
        true if the conversion of language attributes is enabled.

      • isConvertParagraphMargins

        boolean isConvertParagraphMargins()
        This property controls the conversion of paragraph margins.
        Returns:
        true if the conversion of margins 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.

      • getDocumentTitle

        String getDocumentTitle()
        This property contains the value of the "title" tag.
        Returns:
        the value of the "title" tag.

      • getDocumentType

        DocumentType getDocumentType()
        This property contains the output document type.
        Returns:
        the output document type.

      • getFontSizeUnit

        FontSizeUnit 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.

      • getMetaViewport

        String getMetaViewport()
        This property contains the value of the "viewport" meta tag.
        Returns:
        the value of the viewport meta tag.

      • getMetaDescription

        String getMetaDescription()
        This property contains the value of the "description" meta tag.
        Returns:
        the value of the "description" meta tag.

      • getMetaKeywords

        String getMetaKeywords()
        This property contains the value of the "keywords" meta tag.
        Returns:
        the value of the "keywords" meta tag.

      • getMetaAuthor

        String getMetaAuthor()
        This property contains the value of the "author" meta tag.
        Returns:
        the value of the "author" meta tag.

      • getMetaGenerator

        String getMetaGenerator()
        This property contains the value of the "generator" meta tag.
        Returns:
        the value of the "generator" meta tag.

      • getOutputProperty

        String getOutputProperty​(String propertyName)
        This method returns a specific output control property value.
        Parameters:
        propertyName - the property name
        Returns:
        the output control property value.

      • 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.

      • getOutputProperties

        Properties getOutputProperties()
        This property contains additional output control properties (mostly experimental).
        Returns:
        the additional output control properties.

      • getStyleSheetLinks

        List<String> getStyleSheetLinks()
        This property contains the list of links to external style sheets.
        Returns:
        the list of links to external style sheets.

      • getStyleSheetInclude

        String getStyleSheetInclude()
        This property contains the style sheet definition to be included in the head element.
        Returns:
        the style sheet definition to be included in the head element.

      • getTabString

        String getTabString()
        This property contains the tab string.
        Returns:
        the tab string.