org.docgene.model

Class XMLTodo

java.lang.Object

org.docgene.model.XMLTodo

All Implemented Interfaces:

ImportanceType, ParagraphElement, ReviewElement, StyledElement, TodoElement

public class XMLTodo
extends java.lang.Object
implements TodoElement, ParagraphElement, ImportanceType

Represent the content of a <todo> tag.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Fields inherited from interface org.docgene.model.ImportanceType

CRITICAL, IMPORTANT, NORMAL

Constructor Summary

Constructors

Constructor and Description
XMLTodo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalTextContent() Return the TODO additional text content ( ncluding the date, the author, and the reason).
java.lang.String	getAuthor() Return the author.
java.lang.String	getDate() Return the date.
java.lang.String	getDeclaration() Return the declaration ID of the element.
int	getIndex() Return the todo index.
java.lang.String	getReason() Return the reason of the TODO.
java.lang.String	getRef() Return the todo reference composed using the todo index.
java.lang.String	getTODOText() Return the text of the TODO.
short	getType() Return the type of the TODO.
boolean	hasAdditionalTextContent() Return true if the TODO ahas dditional text content ( ncluding the date, the author, and the reason).
boolean	hasAuthor() Return true if the TODO has an author.
boolean	hasDate() Return true if the TODO has a date.
boolean	hasReason() Return true if the TODO has a reason.
boolean	hasTODOText() Return true if the TODO has a text.
void	setAuthor(java.lang.String author) Set the author.
void	setDate(java.lang.String date) Set the date.
void	setIndex(int index) Set the todo index.
void	setReason(java.lang.String reason) Set the reason of the TODO.
void	setText(java.lang.String text) Set the text of the TODO.
void	setType(short type) Set the type of the TODO.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.docgene.model.StyledElement

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

Constructor Detail

XMLTodo

public XMLTodo()

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

setText

public void setText(java.lang.String text)

Set the text of the TODO.

Parameters:

text - the reason

hasTODOText

public boolean hasTODOText()

Return true if the TODO has a text.

Specified by:

hasTODOText in interface TodoElement

Returns:

true if the TODO has a text

getReason

public java.lang.String getReason()

Return the reason of the TODO.

Specified by:

getReason in interface TodoElement

Returns:

the reason of the TODO

setReason

public void setReason(java.lang.String reason)

Set the reason of the TODO.

Parameters:

reason - the reason

hasReason

public boolean hasReason()

Return true if the TODO has a reason.

Specified by:

hasReason in interface TodoElement

Returns:

true if the TODO has a reason

getTODOText

public java.lang.String getTODOText()

Return the text of the TODO.

Specified by:

getTODOText in interface ReviewElement

Specified by:

getTODOText in interface TodoElement

Returns:

the text of the TODO

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setAuthor

public void setAuthor(java.lang.String author)

Set the author.

Parameters:

author - the author

getAuthor

public java.lang.String getAuthor()

Return the author.

Returns:

the author

hasAuthor

public boolean hasAuthor()

Return true if the TODO has an author.

Returns:

true if the TODO has an author

setDate

public void setDate(java.lang.String date)

Set the date.

Parameters:

date - the date

getDate

public java.lang.String getDate()

Return the date.

Returns:

the date

hasDate

public boolean hasDate()

Return true if the TODO has a date.

Returns:

true if the TODO has a date

hasAdditionalTextContent

public boolean hasAdditionalTextContent()

Return true if the TODO ahas dditional text content ( ncluding the date, the author, and the reason).

Returns:

true if the TODO ahas dditional text content

getAdditionalTextContent

public java.lang.String getAdditionalTextContent()

Return the TODO additional text content ( ncluding the date, the author, and the reason).

Returns:

the TODO additional text content

setType

public void setType(short type)

Set the type of the TODO.

Parameters:

type - the type

getType

public short getType()

Return the type of the TODO.

Specified by:

getType in interface TodoElement

Returns:

the type

setIndex

public void setIndex(int index)

Set the todo index.

Parameters:

index - the todo index

getIndex

public int getIndex()

Return the todo index.

Specified by:

getIndex in interface ReviewElement

Returns:

the todo index

getRef

public java.lang.String getRef()

Return the todo reference composed using the todo index.

Specified by:

getRef in interface ReviewElement

Returns:

the todo reference