org.docgene.model

Class XMLSentence

java.lang.Object

org.docgene.model.AbstractStylableText

org.docgene.model.XMLSentence

All Implemented Interfaces:

FontType, ParagraphElement, SpanTextElement, StylableText, StyledElement

public class XMLSentence
extends AbstractStylableText
implements SpanTextElement, ParagraphElement, FontType

Represent a sentence in a paragraph.

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
XMLSentence(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	getDeclaration() Return the declaration ID of the element.
java.lang.String	getStyle() Return the style class of the element.
java.lang.String	getText() Return the text.
boolean	isEmpty() Return true if the sentence is empty.
boolean	isEndingWithNewLine() Return true if the sentence ends with a new line.
void	setStyle(java.lang.String style) Set the style class of the element.
void	setText(java.lang.String text) Set the text.
java.lang.String	toString()

Methods inherited from class org.docgene.model.AbstractStylableText

getBackgroundColor, getColor, getFontFace, getNamedSize, getNumericSize, getParentStyle, getSize, getType, hasDecoration, hasFontFace, hasSize, setBackgroundColor, setColor, setFontFace, setParentStyle, setSize, setSize, setType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.StylableText

getBackgroundColor, getColor, getFontFace, getNamedSize, getNumericSize, getParentStyle, getSize, getType, hasDecoration, hasFontFace, hasSize, setParentStyle

Methods inherited from interface org.docgene.model.StyledElement

getCustomStyles, getInlinedStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Constructor Detail

XMLSentence

public XMLSentence(java.lang.String text)

Constructor.

Parameters:

text - the text

Method Detail

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 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 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 SpanTextElement

Returns:

true if the sentence ends with a new line

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