org.docgene.model

Class XMLSeeAlso

java.lang.Object

org.docgene.model.XMLReference

org.docgene.model.XMLSeeAlso

All Implemented Interfaces:

ArticleReference, ElementReference, ParagraphArticleReference, ParagraphElement, StyledElement

public class XMLSeeAlso
extends XMLReference

Represent an internal reference which is present in a "See Also" chapter.

Field Summary

Fields inherited from class org.docgene.model.XMLReference

desc, id, idMayBeDesc, rawID

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLSeeAlso(Article article, java.lang.String refID, java.lang.String pack) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getText() Return the SeeAlso associated text
void	setText(java.lang.String text) Set the SeeAlso associated text

Methods inherited from class org.docgene.model.XMLReference

bind, bind, getAnchorElement, getArticleRef, getCustomStyles, getDesc, getDescription, getInlinedStyle, getLineNumber, getOriginArticle, getReferencedArticle, getRefID, getRefPackage, getStyle, isAutoDesc, isBareReference, isBound, setCustomStyles, setDesc, setInlinedStyle, setLineNumber, setLowerCase, setStyle, 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

hasInlinedStyle, setCustomStyles

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Constructor Detail

XMLSeeAlso

public XMLSeeAlso(Article article,
                  java.lang.String refID,
                  java.lang.String pack)

Constructor.

Parameters:

article - the article which emit the reference

refID - the other article ID

pack - the package

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Overrides:

getDeclaration in class XMLReference

Returns:

the declaration ID of the element

setText

public void setText(java.lang.String text)

Set the SeeAlso associated text

Parameters:

text - the SeeAlso associated text

getText

public java.lang.String getText()

Return the SeeAlso associated text

Returns:

the SeeAlso associated text