org.docgene.model

Class XMLSpan

java.lang.Object

org.docgene.model.XMLSpan

All Implemented Interfaces:

FontType, ParagraphElement, org.docgene.model.SpanTextElement, org.docgene.model.StylableText, StyledElement

public class XMLSpan
extends java.lang.Object
implements org.docgene.model.StylableText, org.docgene.model.SpanTextElement, FontType

Represent a sentence in a pre element. version 1.6.7.4

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Fields inherited from interface org.docgene.model.FontType

BOLD, ITALIC, REGULAR, STRIKETHROUGH, SUBSCRIPT, SUPERSCRIPT, UNDERLINE

Constructor Summary

Constructors

Constructor and Description
XMLSpan(java.lang.String text) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addTextAfter(java.lang.String suffix) Add characters after the sentence text.
void	addTextBefore(java.lang.String prefix) Add characters before the sentence text.
void	endsWithNewLine(boolean endsWithNewLine) Sets if the sentence ends with a new line.
java.lang.String	getBackgroundColor() Return the html background color of the text.
java.lang.String	getColor() Return the html color of the text.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getFontFace() Return the font face of the text.
java.lang.String	getNamedSize() Return the HTML named size of the text.
int	getNumericSize() Return the numeric size of the text.
XMLTextStyle	getParentStyle() Return null.
java.lang.String	getSize() Return the size of the text.
java.lang.String	getStyle() Return the style class of the element.
java.lang.String	getText() Return the text.
int	getType() Return the font type of the text.
boolean	hasDecoration() Return true if the text has a decoration.
boolean	hasFontFace() Return true if the text has a font face.
boolean	hasSize() Return true if the text has a size.
boolean	isEmpty() Return true if the sentence is empty.
boolean	isEndingWithNewLine() Return true if the sentence ends with a new line.
void	setBackgroundColor(java.lang.String background) Set the html background color of the text.
void	setColor(java.lang.String color) Set the html color of the text.
void	setFontFace(java.lang.String fontFace) Set the font face of the text.
void	setParentStyle(XMLTextStyle parentStyle) Do nothing.
void	setSize(int size) Set the size of the text.
void	setSize(java.lang.String namedSize) Set the HTML named size of the text.
void	setStyle(java.lang.String style) Set the style class of the element.
void	setText(java.lang.String text) Set the text.
void	setType(int type) Set the font type of the text.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.docgene.model.StyledElement

getCustomStyles, getInlinedStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Constructor Detail

XMLSpan

public XMLSpan(java.lang.String text)

Constructor.

Parameters:

text - the text

Method Detail

getParentStyle

public XMLTextStyle getParentStyle()

Return null.

Specified by:

getParentStyle in interface org.docgene.model.StylableText

Returns:

null

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setStyle

public void setStyle(java.lang.String style)

Set the style class of the element.

Parameters:

style - the style class

getStyle

public java.lang.String getStyle()

Return the style class of the element.

Specified by:

getStyle in interface org.docgene.model.StylableText

Specified by:

getStyle in interface StyledElement

Returns:

the style class

endsWithNewLine

public void endsWithNewLine(boolean endsWithNewLine)

Sets if the sentence ends with a new line.

Specified by:

endsWithNewLine in interface org.docgene.model.SpanTextElement

Parameters:

endsWithNewLine - true if the sentence ends with a new line

isEndingWithNewLine

public boolean isEndingWithNewLine()

Return true if the sentence ends with a new line.

Specified by:

isEndingWithNewLine in interface org.docgene.model.SpanTextElement

Returns:

true if the sentence ends with a new line

setType

public void setType(int type)

Set the font type of the text.

Parameters:

type - the font type

See Also:

FontType

getType

public int getType()

Return the font type of the text.

Specified by:

getType in interface org.docgene.model.StylableText

Returns:

the font type of the text

See Also:

FontType

setSize

public void setSize(java.lang.String namedSize)

Set the HTML named size of the text.

Parameters:

namedSize - the HTML named size

setSize

public void setSize(int size)

Set the size of the text.

Parameters:

size - the size of the text

getNamedSize

public java.lang.String getNamedSize()

Return the HTML named size of the text.

Specified by:

getNamedSize in interface org.docgene.model.StylableText

Returns:

the HTML named size of the text

hasSize

public boolean hasSize()

Return true if the text has a size.

Specified by:

hasSize in interface org.docgene.model.StylableText

Returns:

true if the text has a size

getSize

public java.lang.String getSize()

Return the size of the text. It can be the named size or the numeric size.

Specified by:

getSize in interface org.docgene.model.StylableText

Returns:

the size of the text

getNumericSize

public int getNumericSize()

Return the numeric size of the text.

Specified by:

getNumericSize in interface org.docgene.model.StylableText

Returns:

the numeric size of the text

setFontFace

public void setFontFace(java.lang.String fontFace)

Set the font face of the text.

Parameters:

fontFace - the font face of the text

getFontFace

public java.lang.String getFontFace()

Return the font face of the text.

Specified by:

getFontFace in interface org.docgene.model.StylableText

Returns:

the font face of the text

hasFontFace

public boolean hasFontFace()

Return true if the text has a font face.

Specified by:

hasFontFace in interface org.docgene.model.StylableText

Returns:

true if the text has a font face

hasDecoration

public boolean hasDecoration()

Return true if the text has a decoration.

Specified by:

hasDecoration in interface org.docgene.model.StylableText

Returns:

true if the text has a decoration

setColor

public void setColor(java.lang.String color)

Set the html color of the text.

Parameters:

color - the html color of the text

getColor

public java.lang.String getColor()

Return the html color of the text.

Specified by:

getColor in interface org.docgene.model.StylableText

Returns:

the html color of the text

setBackgroundColor

public void setBackgroundColor(java.lang.String background)

Set the html background color of the text.

Parameters:

background - the html background color of the text

getBackgroundColor

public java.lang.String getBackgroundColor()

Return the html background color of the text.

Specified by:

getBackgroundColor in interface org.docgene.model.StylableText

Returns:

the html background color of the text

setText

public void setText(java.lang.String text)

Set the text.

Parameters:

text - the text

getText

public java.lang.String getText()

Return the text.

Specified by:

getText in interface org.docgene.model.StylableText

Returns:

the text

addTextBefore

public void addTextBefore(java.lang.String prefix)

Add characters before the sentence text.

Parameters:

prefix - the prefix characters

addTextAfter

public void addTextAfter(java.lang.String suffix)

Add characters after the sentence text.

Parameters:

suffix - the suffix characters

isEmpty

public boolean isEmpty()

Return true if the sentence is empty.

Returns:

true if the sentence is empty

setParentStyle

public void setParentStyle(XMLTextStyle parentStyle)

Do nothing.

Specified by:

setParentStyle in interface org.docgene.model.StylableText

Parameters:

parentStyle - the parent style