org.docgene.model

Class XMLList

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.XMLList

All Implemented Interfaces:

org.docgene.model.conditions.ConditionElement<ListElement>, org.docgene.model.conditions.ConditionElementsContainer<ListElement>, ListElement, ParagraphElement, ParagraphElementParent, StyledElement

public class XMLList
extends org.docgene.model.AbstractStyledElement
implements ListElement, org.docgene.model.conditions.ConditionElementsContainer<ListElement>, ParagraphElementParent

Represent the content of an <ul> or <ol> tag.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLList(boolean isUL) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addConditionElement(org.docgene.model.conditions.ConditionElement<ListElement> elt) Add a condition element to the list.
void	addElement(ParagraphElement element) Add an element.
XMLListItem	addItem() Add a new item in this list.
void	addItem(ListElement elt) Add a list element to the list.
XMLList	addSubListItem(boolean isUL) Add a new list as an item of this list.
java.util.List<org.docgene.model.conditions.ConditionElement<ListElement>>	getAllElements()
short	getBulletStyle() Return the bullet style.
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.util.List<ListElement>	getItems(org.docgene.model.globals.ArticlesModel model) Return the list elements in the list.
XMLList	getParentList() Return the parent list.
int	getStartItem() Return the start item of an ordered (ol) list.
boolean	hasStartItem() Return true if there is a start item of an ordered (ol) list.
boolean	isUL() Return true for a ul list.
void	setBulletStyle(short bulletStyle) Set the bullet style.
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	setParentList(XMLList parentList) Set the parent list.
void	setStartItem(int startItem) Set the start item of an ordered (ol) list.

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

getConditionElementsList, getConditionUniqueElement, hasParentList, 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.conditions.ConditionElementsContainer

getFilteredElements

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Constructor Detail

XMLList

public XMLList(boolean isUL)

Constructor.

Parameters:

isUL - true for a ul list

Method Detail

setParentList

public void setParentList(XMLList parentList)

Set the parent list.

Specified by:

setParentList in interface ListElement

Parameters:

parentList - the parent list

getParentList

public XMLList getParentList()

Return the parent list.

Specified by:

getParentList in interface ListElement

Returns:

the parent list

setBulletStyle

public void setBulletStyle(short bulletStyle)

Set the bullet style.

Parameters:

bulletStyle - the bullet style

getBulletStyle

public short getBulletStyle()

Return the bullet style.

Returns:

the bullet style

setStartItem

public void setStartItem(int startItem)

Set the start item of an ordered (ol) list. This is valid only for an ol list.

Parameters:

startItem - the startItem

getStartItem

public int getStartItem()

Return the start item of an ordered (ol) list.

Returns:

the startItem

hasStartItem

public boolean hasStartItem()

Return true if there is a start item of an ordered (ol) list.

Returns:

true if there is a start item

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

isUL

public boolean isUL()

Return true for a ul list.

Returns:

true for a ul list

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(ListElement elt)

Add a list element to the list.

Parameters:

elt - the list element

addConditionElement

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

Add a condition element to the list.

Specified by:

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

Parameters:

elt - the condition element

addSubListItem

public XMLList addSubListItem(boolean isUL)

Add a new list as an item of this list.

Parameters:

isUL - true for a ul list

Returns:

the list

addItem

public XMLListItem addItem()

Add a new item in this list.

Returns:

the item

getItems

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

Return the list elements in the list.

Parameters:

model - the articles model

Returns:

the list elements in the list

getAllElements

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

Specified by:

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

addElement

public void addElement(ParagraphElement element)

Add an element. Only ListElements can be added.

Specified by:

addElement in interface ParagraphElementParent

Parameters:

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