org.docgene.model

Class XMLBasicNote

java.lang.Object

org.docgene.model.AbstractParagraph

org.docgene.model.XMLParagraph

org.docgene.model.XMLBasicNote

All Implemented Interfaces:

JustifiedElement, NoteContent, ParagraphElement, ParagraphElementParent, StyledElement

public class XMLBasicNote
extends XMLParagraph
implements NoteContent

Represent the content of a "note" element.

Field Summary

Fields inherited from class org.docgene.model.AbstractParagraph

elements

Fields inherited from interface org.docgene.model.JustifiedElement

ALIGNMENT_CENTER, ALIGNMENT_INHERIT, ALIGNMENT_JUSTIFIED, ALIGNMENT_LEFT, ALIGNMENT_NONE, ALIGNMENT_RIGHT, JUSTIFIED_AUTO, JUSTIFIED_CHARACTER, JUSTIFIED_INHERIT, JUSTIFIED_NONE, JUSTIFIED_WORD

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLBasicNote() Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getID() Return the node ID.
int	getIndex() Return the node index.
java.util.List<XMLNoteRef>	getNoteReferences() Return the list of note references which refer to this note.
boolean	hasID() Return true if the node has an ID.
void	setID(java.lang.String id) Set the node ID
void	setIndex(int index) Set the node index.

Methods inherited from class org.docgene.model.XMLParagraph

getAlignment, getJustification, setAlignment, setJustification

Methods inherited from class org.docgene.model.AbstractParagraph

addElement, getElements, removeLastElement, setElements

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.NoteContent

getRef

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.StyledElement

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

Constructor Detail

XMLBasicNote

public XMLBasicNote()

Constructor.

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 XMLParagraph

Returns:

the declaration ID of the element

setIndex

public void setIndex(int index)

Set the node index.

Specified by:

setIndex in interface NoteContent

Parameters:

index - the node index

setID

public void setID(java.lang.String id)

Set the node ID

Parameters:

id - the node ID

hasID

public boolean hasID()

Return true if the node has an ID.

Specified by:

hasID in interface NoteContent

Returns:

true if the node has an ID

getID

public java.lang.String getID()

Return the node ID.

Specified by:

getID in interface NoteContent

Returns:

the node ID

getIndex

public int getIndex()

Return the node index.

Specified by:

getIndex in interface NoteContent

Returns:

the node index

getNoteReferences

public java.util.List<XMLNoteRef> getNoteReferences()

Description copied from interface: NoteContent

Return the list of note references which refer to this note.

Specified by:

getNoteReferences in interface NoteContent

Returns:

the list of note references