org.docgene.model

Class XMLWord

java.lang.Object

org.docgene.model.XMLWord

All Implemented Interfaces:

org.docgene.model.AnchorElement, ParagraphElement, StyledElement

public class XMLWord
extends java.lang.Object
implements ParagraphElement, org.docgene.model.AnchorElement

Represent a word anchor in an article.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLWord(XMLArticle article) Constructor.
XMLWord(XMLArticle article, java.lang.String word) Constructor.

Method Summary

Modifier and Type	Method and Description
XMLArticle	getArticle() Return the article.
ArticleRef	getArticleRef() Return the article ref.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getID() Return the ID of the anchor.
java.lang.String	getText() Return the text.
java.lang.String	getWord() Return the associated word.
boolean	getWriteInstruction() Return the write instruction for the the word.
boolean	hasID() Return true if this anchor has an id.
boolean	isOnAnchor() Return true if the word as being put on an existing anchor.
boolean	isOnArticle() Return true if the word anchor is on an article.
void	setID(java.lang.String id) Set the ID of the anchor.
void	setOnAnchor(boolean isOnAnchor) Set the word as being put on an existing anchor.
void	setText(java.lang.String text) Set the text.
void	setWriteInstruction(boolean toWrite) Set the write instruction for the the word.

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

Methods inherited from interface org.docgene.model.AnchorElement

getTitle

Constructor Detail

XMLWord

public XMLWord(XMLArticle article)

Constructor.

Parameters:

article - the article

XMLWord

public XMLWord(XMLArticle article,
               java.lang.String word)

Constructor.

Parameters:

article - the article

word - the word of the anchor

Method Detail

getArticle

public XMLArticle getArticle()

Return the article.

Returns:

the article

getArticleRef

public ArticleRef getArticleRef()

Return the article ref.

Returns:

the article ref

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

isOnArticle

public boolean isOnArticle()

Return true if the word anchor is on an article.

Returns:

true if the word anchor is on an article

setOnAnchor

public void setOnAnchor(boolean isOnAnchor)

Set the word as being put on an existing anchor.

Parameters:

isOnAnchor - true if the word is being put on an existing anchor

isOnAnchor

public boolean isOnAnchor()

Return true if the word as being put on an existing anchor.

Returns:

true if the word is being put on an existing anchor

getWord

public java.lang.String getWord()

Return the associated word.

Returns:

word

setWriteInstruction

public void setWriteInstruction(boolean toWrite)

Set the write instruction for the the word.

Parameters:

toWrite - true if the word must be written

getWriteInstruction

public boolean getWriteInstruction()

Return the write instruction for the the word.

Returns:

true if the word must be written

setText

public void setText(java.lang.String text)

Set the text.

Parameters:

text - the text

getText

public java.lang.String getText()

Return the text.

Returns:

the text

getID

public java.lang.String getID()

Return the ID of the anchor.

Specified by:

getID in interface org.docgene.model.AnchorElement

Returns:

the ID of the anchor

hasID

public boolean hasID()

Return true if this anchor has an id.

Returns:

true if this anchor has an id

setID

public void setID(java.lang.String id)

Set the ID of the anchor.

Specified by:

setID in interface org.docgene.model.AnchorElement

Parameters:

id - the ID of the anchor