org.docgene.model

Interface ArticleReference

All Superinterfaces:

ElementReference, ParagraphElement, StyledElement

All Known Subinterfaces:

ParagraphArticleReference

All Known Implementing Classes:

AbstractMoreInfoRef, ArticlesGlossary.Word, XMLInclude, XMLMoreInfo, XMLMoreInfoRef, XMLRedirect, XMLReference, XMLSeeAlso, XMLSeeAlsoHeading, XMLSeeArticle

public interface ArticleReference
extends ParagraphElement, ElementReference

An article reference.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Method Summary

Modifier and Type	Method and Description
default void	bind(XMLParentArticle article) Set the referenced article.
default void	bind(XMLParentArticle article, AnchorElement anchor) Set the referenced article and associated anchor.
default AnchorElement	getAnchorElement() Return the referenced anchor element.
ArticleRef	getArticleRef() Return the associated reference.
java.lang.String	getDesc() Return the reference text.
XMLParentArticle	getReferencedArticle() Return the referenced article.
java.lang.String	getRefID() Return the other article reference ID.
default java.lang.String	getRefPackage() Return the article reference package.
default boolean	isAutoDesc() Return true if the description has been set automatically.
default boolean	isBareReference() Return true for a bare reference pointing directly to a File.
boolean	isBound() Return true if the reference is bound.
default void	setDesc(java.lang.String desc) Set the reference text.

Methods inherited from interface org.docgene.model.StyledElement

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

Methods inherited from interface org.docgene.model.ElementReference

getLineNumber, hasLineNumber

Method Detail

getRefID

java.lang.String getRefID()

Return the other article reference ID. It can be:

• Its description: see XMLArticle.getDescription()
• Its description where the white spaces have been replaced by underscore characters
• Its ID if it has an ID attribute: see XMLArticle.getID()

Returns:

the other article reference ID

getReferencedArticle

XMLParentArticle getReferencedArticle()

Return the referenced article.

Returns:

the referenced article

getArticleRef

ArticleRef getArticleRef()

Return the associated reference.

Returns:

the reference

getAnchorElement

default AnchorElement getAnchorElement()

Return the referenced anchor element. Return null by default.

Returns:

the referenced anchor element

getDesc

java.lang.String getDesc()

Return the reference text.

Returns:

the reference text

setDesc

default void setDesc(java.lang.String desc)

Set the reference text. Do nothing by default.

Parameters:

desc - the reference text

isAutoDesc

default boolean isAutoDesc()

Return true if the description has been set automatically. Return false by default.

Returns:

true if the description has been set automatically

getRefPackage

default java.lang.String getRefPackage()

Return the article reference package. Return null by default.

Returns:

the article reference package

isBareReference

default boolean isBareReference()

Return true for a bare reference pointing directly to a File. Return false by default.

Returns:

false

bind

default void bind(XMLParentArticle article)

Set the referenced article. Do nothing by default.

Parameters:

article - the referenced article

bind

default void bind(XMLParentArticle article,
                  AnchorElement anchor)

Set the referenced article and associated anchor. Do nothing by default.

Parameters:

article - the referenced article

anchor - the anchor

isBound

boolean isBound()

Return true if the reference is bound.

Returns:

true if the reference is bound