org.docgene.model

Class XMLSeeArticle

java.lang.Object

org.docgene.model.XMLReference

org.docgene.model.XMLSeeArticle

All Implemented Interfaces:

ArticleReference, ElementReference, ParagraphArticleReference, ParagraphElement, StyledElement

public class XMLSeeArticle
extends XMLReference

Represent an internal reference which is present in a "See also" tag in a paragraph.

See Also:

XMLMoreInfo

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
XMLSeeArticle(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.
protected java.lang.String	getDescription(XMLParentArticle article, java.lang.String refID) Return the description associated to an ID and an article.

Methods inherited from class org.docgene.model.XMLReference

bind, bind, getAnchorElement, getArticleRef, getCustomStyles, getDesc, 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

XMLSeeArticle

public XMLSeeArticle(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

getDescription

protected java.lang.String getDescription(XMLParentArticle article,
                                          java.lang.String refID)

Return the description associated to an ID and an article.

Overrides:

getDescription in class XMLReference

Parameters:

article - the parent article

refID - the ID

Returns:

the description