org.docgene.model

Class XMLTree

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.XMLTree

All Implemented Interfaces:

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

public class XMLTree
extends org.docgene.model.AbstractStyledElement
implements org.docgene.model.TreeElement, org.docgene.model.BorderedElement, org.docgene.model.conditions.ConditionElementsContainer<XMLTreeItem>, ParagraphElementParent

Represent the content of an <tree> tag.

Since:

1.6.5.6

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLTree() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addConditionElement(org.docgene.model.conditions.ConditionElement<XMLTreeItem> elt) Add a condition element to the list.
void	addElement(ParagraphElement element) Add an element.
void	addItem(XMLTreeItem elt) Add a list element to the list.
java.util.List<org.docgene.model.conditions.ConditionElement<XMLTreeItem>>	getAllElements()
java.lang.String	getBorderColor() Return the tree 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 children elements.
java.lang.String	getFillColor() Return the tree background color.
java.util.List<XMLTreeItem>	getItems(org.docgene.model.globals.ArticlesModel model) Return the tree elements in the list.
org.docgene.model.TreeElement	getParent()
XMLTree	getParentTree()
boolean	hasShadow() Return true if the image has a shadowed border.
void	setBorderColor(java.lang.String color) Set the tree 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 tree background color.

Methods inherited from class org.docgene.model.AbstractStyledElement

getInlinedStyle, 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.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.BorderedElement

hasBorder

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

getFilteredElements

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Constructor Detail

XMLTree

public XMLTree()

Constructor.

Method Detail

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

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 tree background color.

Parameters:

color - the background color

getFillColor

public java.lang.String getFillColor()

Return the tree background color.

Returns:

the background color

setBorderColor

public void setBorderColor(java.lang.String color)

Set the tree border color.

Parameters:

color - the border color

getBorderColor

public java.lang.String getBorderColor()

Return the tree border color.

Returns:

the border color

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

Overrides:

setCustomStyles in class org.docgene.model.AbstractStyledElement

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

Overrides:

getCustomStyles in class org.docgene.model.AbstractStyledElement

Returns:

the custom classes

addItem

public void addItem(XMLTreeItem elt)

Add a list element to the list.

Specified by:

addItem in interface org.docgene.model.TreeElement

Parameters:

elt - the list element

addConditionElement

public void addConditionElement(org.docgene.model.conditions.ConditionElement<XMLTreeItem> elt)

Add a condition element to the list.

Specified by:

addConditionElement in interface org.docgene.model.conditions.ConditionElementsContainer<XMLTreeItem>

Parameters:

elt - the condition element

getItems

public java.util.List<XMLTreeItem> getItems(org.docgene.model.globals.ArticlesModel model)

Return the tree elements in the list.

Parameters:

model - the articles model

Returns:

the tree elements in the list

getAllElements

public java.util.List<org.docgene.model.conditions.ConditionElement<XMLTreeItem>> getAllElements()

Specified by:

getAllElements in interface org.docgene.model.conditions.ConditionElementsContainer<XMLTreeItem>

addElement

public void addElement(ParagraphElement element)

Add an element. Only XMLTreeItems can be added.

Specified by:

addElement in interface ParagraphElementParent

Parameters:

element - the element

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.

getElements

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

Return the list of children elements.

Specified by:

getElements in interface ParagraphElementParent

Returns:

the list of children elements

setElements

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

Set the list of elements. Only ListElements can be added.

Specified by:

setElements in interface ParagraphElementParent

Parameters:

elements - the list of elements