de.betabeans.scroogexhtml.translator
Interface Translator

All Known Implementing Classes:
CustomTranslator, HTML401Strict, HTML401Transitional, HTMLTranslator, PlainText, XHTML10Strict, XHTML10Transitional, XHTMLBasic10, XHTMLMobileProfile10, XHTMLTranslator

public interface Translator

Translator Interface.

Author:
Michael Justin

Method Summary
 java.lang.String buildLangAttribute(java.lang.String language)
          Returns a lang="xx" attribute for the given ISO language code.
 java.lang.String encode(java.lang.String string)
          Encode a (Unicode) string to HTML/XHTML.
 java.lang.String formatElement(java.lang.String text, CharacterProperties cp, ParagraphProperties pp)
          Format a String using the given CharacterProperties.
 java.lang.String getCloseEmptyElement()
          Gets the correct closing bracket for empty elements depending on the document type.
 java.lang.String getDocType()
          Gets the DOCTYPE declaration.
 byte getFontSizeUnit()
          Returns the font size unit value.
 java.lang.String getParagraph(java.lang.String additionalStyle)
          Gets the paragraph attribute of the Translator object.
 java.lang.String getParagraphStyle(ParagraphProperties pp)
          Adds formatting tags to the paragraph.
 java.lang.String getRootElement()
          Gets the root element (the tag).
 java.lang.String getStyleParam(java.lang.String additionalStyle)
          Gets the styleParam attribute of the Translator object.
 boolean isTransitional()
          Returns true if this translator generates transitional (X)HTML.
 boolean isXMLTranslatorClass()
          Checks if this is a XML based translator class.
 void setFontSizeUnit(byte value)
          Specifies the font size unit value.
 void setFormatter(Formatter f)
          Set the Formatter.
 void setParOpen(java.lang.String tagAndClass, java.lang.String defaultStyle)
          Sets the parOpen attribute of the Translator object.
 boolean supportsElement(java.lang.String elementName)
          Checks if a given HTML element is supported.
 

Method Detail

encode

java.lang.String encode(java.lang.String string)
Encode a (Unicode) string to HTML/XHTML.

Parameters:
string - The Unicode String we want to convert to HTML.
Returns:
HTML result String.

isXMLTranslatorClass

boolean isXMLTranslatorClass()
Checks if this is a XML based translator class.

Returns:
true for XML based Translator subclasses

buildLangAttribute

java.lang.String buildLangAttribute(java.lang.String language)
Returns a lang="xx" attribute for the given ISO language code.

Parameters:
language - String
Returns:
String

getRootElement

java.lang.String getRootElement()
Gets the root element (the tag).

Returns:
The rootElement value

getCloseEmptyElement

java.lang.String getCloseEmptyElement()
Gets the correct closing bracket for empty elements depending on the document type. Returns ">" for HTML and " />" for XHTML.

Returns:
The closeEmptyElement value

formatElement

java.lang.String formatElement(java.lang.String text,
                               CharacterProperties cp,
                               ParagraphProperties pp)
Format a String using the given CharacterProperties.

Parameters:
text - The String to be formatted.
cp - The character properties to be used.
pp - The current paragraphs ParagraphProperties.
Returns:
The formatted String.

getDocType

java.lang.String getDocType()
Gets the DOCTYPE declaration.

Returns:
DOCTYPE tag

getParagraph

java.lang.String getParagraph(java.lang.String additionalStyle)
Gets the paragraph attribute of the Translator object.

Parameters:
additionalStyle - Extra CSS styles for the paragraph.
Returns:
The paragraph style.

getParagraphStyle

java.lang.String getParagraphStyle(ParagraphProperties pp)
Adds formatting tags to the paragraph.

Parameters:
pp - Paragraph properties
Returns:
the formatting tags for the paragraph style

setParOpen

void setParOpen(java.lang.String tagAndClass,
                java.lang.String defaultStyle)
Sets the parOpen attribute of the Translator object.

Parameters:
tagAndClass - The new parOpen value
defaultStyle - The new parOpen value

getStyleParam

java.lang.String getStyleParam(java.lang.String additionalStyle)
Gets the styleParam attribute of the Translator object.

Parameters:
additionalStyle - Additional style.
Returns:
The styleParam value

supportsElement

boolean supportsElement(java.lang.String elementName)
Checks if a given HTML element is supported.

Parameters:
elementName - The element name.
Returns:
True if the element is supported

getFontSizeUnit

byte getFontSizeUnit()
Returns the font size unit value.

Returns:
byte

setFontSizeUnit

void setFontSizeUnit(byte value)
Specifies the font size unit value.

Parameters:
value - byte

isTransitional

boolean isTransitional()
Returns true if this translator generates transitional (X)HTML.

Returns:
boolean

setFormatter

void setFormatter(Formatter f)
Set the Formatter.

Parameters:
f - Formatter


Copyright (c) 1998-2006 BetaSoft Michael Justin. All Rights Reserved.