org.docgene.model

Class XMLBox

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.XMLBox

All Implemented Interfaces:

org.docgene.model.Alignment, ParagraphElement, ParagraphElementParent, StyledElement

public class XMLBox
extends org.docgene.model.AbstractStyledElement
implements ParagraphElementParent, org.docgene.model.Alignment

Represent the content of a <box> tag.

Field Summary

Fields

Modifier and Type	Field and Description
static short	WIDTH_LIMITED The type where the box width adapts to the text size.
static short	WIDTH_SET The type where the box width is explictly set.
static short	WIDTH_UNLIMITED The type where the box width is not limited.

Fields inherited from interface org.docgene.model.Alignment

CENTER, LEFT, RIGHT

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLBox(short type) Constructor.
XMLBox(short type, int width, boolean isRelative) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addElement(ParagraphElement element) Add an element.
char	getAlignment() Return the alignment of the box.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.util.List<ParagraphElement>	getElements() Return the list of elements.
int	getWidth() Return the box width.
short	getWidthType() Return true if the box width is limited to the content width.
boolean	isRelativeWidth() Return true if the box width is relative (in %).
void	setAlignment(char align) Set the alignment of the box.
void	setElements(java.util.List<ParagraphElement> elements) Set the list of elements.
void	setWidth(int width, boolean relWidth) Set the box width.

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

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.StyledElement

getStyle, hasInlinedStyle, setCustomStyles

Field Detail

WIDTH_LIMITED

public static final short WIDTH_LIMITED

The type where the box width adapts to the text size.

See Also:

Constant Field Values

WIDTH_UNLIMITED

public static final short WIDTH_UNLIMITED

The type where the box width is not limited.

See Also:

Constant Field Values

WIDTH_SET

public static final short WIDTH_SET

The type where the box width is explictly set.

See Also:

Constant Field Values

Constructor Detail

XMLBox

public XMLBox(short type)

Constructor.

Parameters:

type - the width type

XMLBox

public XMLBox(short type,
              int width,
              boolean isRelative)

Constructor.

Parameters:

type - the width type

width - the specified bow width

isRelative - true for a relativ width

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

getWidthType

public short getWidthType()

Return true if the box width is limited to the content width.

Returns:

true if the box width is limited to the content width

setWidth

public void setWidth(int width,
                     boolean relWidth)

Set the box width.

Parameters:

width - the box width

relWidth - true if the width is relative (in percent)

getWidth

public int getWidth()

Return the box width.

Returns:

the box width

isRelativeWidth

public boolean isRelativeWidth()

Return true if the box width is relative (in %).

Returns:

true if the box width is relative

setAlignment

public void setAlignment(char align)

Set the alignment of the box.

Specified by:

setAlignment in interface org.docgene.model.Alignment

Parameters:

align - the alignment

See Also:

Alignment

getAlignment

public char getAlignment()

Return the alignment of the box.

Specified by:

getAlignment in interface org.docgene.model.Alignment

Returns:

the alignment

See Also:

Alignment

setElements

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

Set the list of elements.

Specified by:

setElements in interface ParagraphElementParent

Parameters:

elements - the list of elements

addElement

public void addElement(ParagraphElement element)

Add an element.

Specified by:

addElement in interface ParagraphElementParent

Parameters:

element - the element

getElements

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

Return the list of elements.

Specified by:

getElements in interface ParagraphElementParent

Returns:

the list of elements