org.docgene.model

Class XMLTodoList

java.lang.Object

org.docgene.model.XMLTodoList

All Implemented Interfaces:

ParagraphElement, StyledElement

public class XMLTodoList
extends java.lang.Object
implements ParagraphElement

Represent the content of a <todolist> tag.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLTodoList.ArticleTodos The TODOs for one article.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Method Summary

Modifier and Type	Method and Description
void	addTodo(XMLArticle article, TodoElement todo) Add a TODO reference.
java.lang.String	getDeclaration() Return the declaration ID of the element.
static XMLTodoList	getInstance()
XMLList	getList() Return the todo list as a "ol" element.
java.util.Map<java.lang.String,XMLTodoList.ArticleTodos>	getTodos() Return the non empty todos sorted by article id.
boolean	hasTODOs() Return true if there are non empty todos.

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

getCustomStyles, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Method Detail

getInstance

public static XMLTodoList getInstance()

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

getTodos

public java.util.Map<java.lang.String,XMLTodoList.ArticleTodos> getTodos()

Return the non empty todos sorted by article id.

Returns:

the non empty todos

hasTODOs

public boolean hasTODOs()

Return true if there are non empty todos.

Returns:

true if there are non empty todos

getList

public XMLList getList()

Return the todo list as a "ol" element.

Returns:

the todo list as a "ol" element.

addTodo

public void addTodo(XMLArticle article,
                    TodoElement todo)

Add a TODO reference.

Parameters:

article - the article where there is the TODO

todo - the TODO