org.docgene.model

Class XMLPre

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.AbstractJustifiedElement

org.docgene.model.XMLPre

All Implemented Interfaces:

BorderedElement, ParagraphElement, ParagraphElementParent, StyledElement

public class XMLPre
extends AbstractJustifiedElement
implements BorderedElement, ParagraphElementParent

Represent the content of "pre" or "source" tags.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLPre(boolean isSource) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addElement(ParagraphElement element) Add an element.
boolean	allowInvisibleChars() Return true if the invisible char character is supported.
short	getBorderType() Return the pre block border type.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.util.List<ParagraphElement>	getElements() Return the list of elements.
java.io.File	getPreFile() Return the File associated with the pre element.
char	getScrollingType() Return the scrolling type.
java.lang.String	getSyntax() Return the pre syntax.
int	getTrimmedLeftLength() Return the length of the spaces before the pre on the same line.
boolean	hasBackground() Return true if the pre element has a background.
boolean	hasColor() Return true if the pre has a specified background color.
boolean	hasSpecificStyle() Return true if the pre elemetn has a specified background color or a border.
boolean	hasSyntax() Return true if the pre has a syntax.
boolean	hasTrimmedLeftLength() Return true the length of the spaces before the pre on the same line if not 0.
boolean	isSource() Return true for a source tag.
boolean	isTrimmedLeft() Return true if the text must be trimmed to the left.
void	setBorderType(short borderType) Set if the pre block border type.
void	setElements(java.util.List<ParagraphElement> elements) Set the pre elements.
void	setHasBackground(boolean hasBackground) Set if the pre element has a background.
void	setHasColor(boolean hasColor) Set if the pre has a specified background color.
void	setInvisibleChars(boolean invisibleChars) Set if the invisible char character is supported.
void	setPreFile(java.io.File preFile) Set the File associated with the pre element.
void	setScrollingType(char scrollingType) Set the scrolling type.
void	setSyntax(java.lang.String syntax) Set the pre syntax.
void	setTrimLeft(boolean trimLeft) Set if the text must be trimmed to the left.
void	setTrimmedLeftLength(int trimmedLeft) Set the length of the spaces before the pre on the same line.
boolean	useFile() Return true if there is a File associated with the pre element.

Methods inherited from class org.docgene.model.AbstractJustifiedElement

isFirstInLine, setFirstInLine

Methods inherited from class org.docgene.model.AbstractStyledElement

getCustomStyles, getInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.BorderedElement

hasBorder, hasShadow

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.StyledElement

getStyle, hasInlinedStyle, setCustomStyles

Constructor Detail

XMLPre

public XMLPre(boolean isSource)

Constructor.

Parameters:

isSource - true for a "source tag"

Method Detail

setPreFile

public void setPreFile(java.io.File preFile)

Set the File associated with the pre element.

Parameters:

preFile - the File

getPreFile

public java.io.File getPreFile()

Return the File associated with the pre element.

Returns:

the File

useFile

public boolean useFile()

Return true if there is a File associated with the pre element.

Returns:

true if there is a File associated with the pre element

setTrimmedLeftLength

public void setTrimmedLeftLength(int trimmedLeft)

Set the length of the spaces before the pre on the same line.

Parameters:

trimmedLeft - the length of the spaces before the pre on the same line

getTrimmedLeftLength

public int getTrimmedLeftLength()

Return the length of the spaces before the pre on the same line.

Returns:

the length of the spaces before the pre on the same line

hasTrimmedLeftLength

public boolean hasTrimmedLeftLength()

Return true the length of the spaces before the pre on the same line if not 0.

Returns:

true the length of the spaces before the pre on the same line if not 0

setHasBackground

public void setHasBackground(boolean hasBackground)

Set if the pre element has a background.

Parameters:

hasBackground - true if the pre element has a background

hasBackground

public boolean hasBackground()

Return true if the pre element has a background.

Returns:

true if the pre element has a background

setScrollingType

public void setScrollingType(char scrollingType)

Set the scrolling type.

Parameters:

scrollingType - the type

See Also:

PreScrollingType

getScrollingType

public char getScrollingType()

Return the scrolling type.

Returns:

the type

See Also:

PreScrollingType

setTrimLeft

public void setTrimLeft(boolean trimLeft)

Set if the text must be trimmed to the left.

Parameters:

trimLeft - true if the text must be trimmed to the left

isTrimmedLeft

public boolean isTrimmedLeft()

Return true if the text must be trimmed to the left.

Returns:

true if the text must be trimmed to the left

setInvisibleChars

public void setInvisibleChars(boolean invisibleChars)

Set if the invisible char character is supported.

Parameters:

invisibleChars - if the invisible char character is supported

setHasColor

public void setHasColor(boolean hasColor)

Set if the pre has a specified background color.

Parameters:

hasColor - true if the pre has a specified background color

hasColor

public boolean hasColor()

Return true if the pre has a specified background color.

Returns:

true if the pre has a specified background color

hasSpecificStyle

public boolean hasSpecificStyle()

Return true if the pre elemetn has a specified background color or a border.

Returns:

true if the pre elemetn has a specified background color or a border

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

allowInvisibleChars

public boolean allowInvisibleChars()

Return true if the invisible char character is supported.

Returns:

true if the invisible char character is supported

isSource

public boolean isSource()

Return true for a source tag.

Returns:

true for a source tag

setBorderType

public void setBorderType(short borderType)

Set if the pre block border type.

Parameters:

borderType - the pre block border type

See Also:

BorderType

getBorderType

public short getBorderType()

Return the pre block border type.

Specified by:

getBorderType in interface BorderedElement

Returns:

the pre block border type

See Also:

BorderType

setSyntax

public void setSyntax(java.lang.String syntax)

Set the pre syntax.

Parameters:

syntax - the pre syntax

hasSyntax

public boolean hasSyntax()

Return true if the pre has a syntax.

Returns:

true if the pre has a syntax

getSyntax

public java.lang.String getSyntax()

Return the pre syntax.

Returns:

the pre syntax

addElement

public void addElement(ParagraphElement element)

Add an element.

Specified by:

addElement in interface ParagraphElementParent

Parameters:

element - the element

setElements

public void setElements(java.util.List<ParagraphElement> elements)

Set the pre elements.

Specified by:

setElements in interface ParagraphElementParent

Parameters:

elements - the pre elements

getElements

public java.util.List<ParagraphElement> getElements()

Return the list of elements.

Specified by:

getElements in interface ParagraphElementParent

Returns:

the list of elements