org.docgene.model

Class XMLTreeItem

java.lang.Object

org.docgene.model.XMLTreeItem

All Implemented Interfaces:

org.docgene.model.BorderedElement, org.docgene.model.conditions.ConditionElement<XMLTreeItem>, ParagraphElement, ParagraphElementParent, StyledElement, org.docgene.model.TreeElement

public class XMLTreeItem
extends java.lang.Object
implements org.docgene.model.TreeElement, org.docgene.model.BorderedElement, ParagraphElementParent

Represent the content of a <li> tag in a tree.

Since:

1.6.5.6

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLTreeItem()
XMLTreeItem(org.docgene.model.TreeElement parent)

Method Summary

Modifier and Type	Method and Description
void	addElement(ParagraphElement element) Add an element.
void	addItem(XMLTreeItem elt) Add a tree element to the tree.
java.lang.String	getBorderColor() Return the item border color.
short	getBorderType() Return the block border type.
XMLTreeItem	getConditionUniqueElement() Return the unique element for a condition.
java.util.Set<java.lang.String>	getCustomStyles() Return the element custom classes.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.util.List<ParagraphElement>	getElements() Return the list of elements.
java.lang.String	getFillColor() Return the item background color.
java.util.List<XMLTreeItem>	getItems() Return the list elements in the tree.
org.docgene.model.TreeElement	getParent()
XMLTree	getParentTree()
boolean	hasBorder()
boolean	hasBorderColor()
boolean	hasChildren() Return the tree items elements in the item.
boolean	hasFillColor()
boolean	hasShadow() Return true if the image has a shadowed border.
void	setBorderColor(java.lang.String color) Set the item border color.
void	setBorderType(short borderType) Set if the block border type.
void	setCustomStyles(java.util.Set<java.lang.String> classes) Set the element custom classes.
void	setElements(java.util.List<ParagraphElement> elements) Set the list of elements.
void	setFillColor(java.lang.String color) Set the item background color.
void	setParent(org.docgene.model.TreeElement parent)

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

getConditionElementsList, getElementsList, hasParent, hasUniqueElement

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.conditions.ConditionElement

getCondition

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Constructor Detail

XMLTreeItem

public XMLTreeItem(org.docgene.model.TreeElement parent)

XMLTreeItem

public XMLTreeItem()

Method Detail

setParent

public void setParent(org.docgene.model.TreeElement parent)

getParent

public org.docgene.model.TreeElement getParent()

Specified by:

getParent in interface org.docgene.model.TreeElement

getParentTree

public XMLTree getParentTree()

Specified by:

getParentTree in interface org.docgene.model.TreeElement

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

setCustomStyles

public void setCustomStyles(java.util.Set<java.lang.String> classes)

Set the element custom classes.

Specified by:

setCustomStyles in interface StyledElement

Parameters:

classes - the custom element classes

getCustomStyles

public java.util.Set<java.lang.String> getCustomStyles()

Return the element custom classes.

Specified by:

getCustomStyles in interface StyledElement

Returns:

the custom classes

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

setBorderType

public final void setBorderType(short borderType)

Set if the block border type.

Parameters:

borderType - the block border type

See Also:

BorderType

getBorderType

public short getBorderType()

Return the block border type.

Specified by:

getBorderType in interface org.docgene.model.BorderedElement

Returns:

the block border type

See Also:

BorderType

hasShadow

public boolean hasShadow()

Return true if the image has a shadowed border.

Specified by:

hasShadow in interface org.docgene.model.BorderedElement

Returns:

true if the image has a shadowed border

setFillColor

public void setFillColor(java.lang.String color)

Set the item background color.

Parameters:

color - the background color

getFillColor

public java.lang.String getFillColor()

Return the item background color.

Returns:

the background color

hasFillColor

public boolean hasFillColor()

setBorderColor

public void setBorderColor(java.lang.String color)

Set the item border color.

Parameters:

color - the border color

getBorderColor

public java.lang.String getBorderColor()

Return the item border color.

Returns:

the border color

hasBorderColor

public boolean hasBorderColor()

addItem

public void addItem(XMLTreeItem elt)

Add a tree element to the tree.

Specified by:

addItem in interface org.docgene.model.TreeElement

Parameters:

elt - the tree element

getItems

public java.util.List<XMLTreeItem> getItems()

Return the list elements in the tree.

Returns:

the list elements in the tree

hasChildren

public boolean hasChildren()

Return the tree items elements in the item.

Returns:

the tree items elements in the item

hasBorder

public boolean hasBorder()

Specified by:

hasBorder in interface org.docgene.model.BorderedElement

getConditionUniqueElement

public XMLTreeItem getConditionUniqueElement()

Return the unique element for a condition.

Specified by:

getConditionUniqueElement in interface org.docgene.model.conditions.ConditionElement<XMLTreeItem>

Returns:

the unique element.