org.docgene.model

Class XMLSeeAlsoHeading

java.lang.Object

org.docgene.model.XMLReference

org.docgene.model.XMLSeeAlsoHeading

All Implemented Interfaces:

org.docgene.model.ArticleReference, org.docgene.model.ElementReference, org.docgene.model.ParagraphArticleReference, ParagraphElement, StyledElement

public class XMLSeeAlsoHeading
extends XMLReference

Represent a "SeeAlso" reference in the article header.

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
XMLSeeAlsoHeading(org.docgene.model.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	getOtherText() Return the SeeAlso associated text for the destination article.
java.lang.String	getThisText() Return the SeeAlso associated text for the origin article.
void	setOtherText(java.lang.String text) Set the SeeAlso associated text for the destination article.
void	setThisText(java.lang.String text) Set the SeeAlso associated text for the origin article.

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

XMLSeeAlsoHeading

public XMLSeeAlsoHeading(org.docgene.model.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

setThisText

public void setThisText(java.lang.String text)

Set the SeeAlso associated text for the origin article.

Parameters:

text - the SeeAlso associated text for the origin article

getThisText

public java.lang.String getThisText()

Return the SeeAlso associated text for the origin article.

Returns:

the SeeAlso associated text for the origin article

setOtherText

public void setOtherText(java.lang.String text)

Set the SeeAlso associated text for the destination article.

Parameters:

text - the SeeAlso associated text for the destination article

getOtherText

public java.lang.String getOtherText()

Return the SeeAlso associated text for the destination article.

Returns:

the SeeAlso associated text for the destination article