org.docgene.model.globals

Class InternalMenuItem

java.lang.Object

org.docgene.model.globals.AbstractMenuItem

org.docgene.model.globals.InternalMenuItem

public class InternalMenuItem
extends AbstractMenuItem

Represent a Menu Item pointing to an internal link.

Constructor Summary

Constructors

Constructor and Description
InternalMenuItem(java.lang.String desc) Constructor.

Method Summary

Modifier and Type	Method and Description
void	bind(XMLParentArticle article) Set the referenced article.
XMLParentArticle	getArticle() Return the referenced article.
java.lang.String	getID() Return the other article reference ID.
java.lang.String	getPackage() Return the article reference package.
void	setID(java.lang.String id) Set the referenced article ID.
void	setPackage(java.lang.String pack) Set the package ID of the referenced article.

Methods inherited from class org.docgene.model.globals.AbstractMenuItem

getDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InternalMenuItem

public InternalMenuItem(java.lang.String desc)

Constructor.

Parameters:

desc - the menu item description

Method Detail

setID

public void setID(java.lang.String id)

Set the referenced article ID.

Parameters:

id - the referenced article ID

setPackage

public void setPackage(java.lang.String pack)

Set the package ID of the referenced article.

Parameters:

pack - the package ID of the referenced article

getID

public java.lang.String getID()

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

getPackage

public java.lang.String getPackage()

Return the article reference package.

Returns:

the article reference package

getArticle

public XMLParentArticle getArticle()

Return the referenced article.

Returns:

the referenced article

bind

public void bind(XMLParentArticle article)

Set the referenced article.

Parameters:

article - the referenced article