org.docgene.model

Class XMLTitle

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.XMLTitle

All Implemented Interfaces:

org.docgene.model.AnchorElement, ParagraphElement, StyledElement, org.docgene.model.TitledElement, org.docgene.model.TitleOrIncludeElement

public class XMLTitle
extends org.docgene.model.AbstractStyledElement
implements org.docgene.model.TitledElement

Represents a title.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLTitle(int level, java.lang.String title, boolean keepCase) Constructor.
XMLTitle(int level, java.lang.String title, java.lang.String id, boolean keepCase) Constructor.
XMLTitle(java.lang.String title, boolean isSeeAlso, boolean keepCase) 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 title id.
int	getLevel() Return the title level.
java.lang.String	getSeq() Return the title sequence id.
java.lang.String	getTitle() Return the title title.
boolean	hasSeq() Return true if the title has a forced sequence id.
boolean	hasThematicBreak() Return true if the title has a thematic break ("hr") before the title.
boolean	isDuplicate() Return true if the title is a duplicate of another existing title.
boolean	isKeepingCase() Return true if the title description should keep the title description case.
boolean	isResolved() Return true if the title element has having been already resolved.
boolean	isSearchable() Return true if the title is searchable.
boolean	isSeeAlso() Return true if the TitledElement correspond to a See Also title.
void	setDuplicate(boolean isDuplicate) Set if the title is a duplicate of another existing title.
void	setID(java.lang.String id) Set the title id.
void	setKeepCase(boolean keepCase) Set if the title description should keep the title description case.
void	setLevel(int level) Set the title level.
void	setResolved() Set the titled element as being resolved.
void	setSearchable(boolean isSearchable) Set if the title is searchable
void	setSeq(java.lang.String seq) Set the title sequence id.
void	setThematicBreak(boolean hasHR) Set if the title has a thematic break ("hr") before the title.
void	setTitle(java.lang.String title) Set the title.

Methods inherited from class org.docgene.model.AbstractStyledElement

getCustomStyles, getInlinedStyle, setCustomStyles, setInlinedStyle

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.TitledElement

getTitleWithSequence

Methods inherited from interface org.docgene.model.StyledElement

getStyle, hasInlinedStyle, setCustomStyles

Constructor Detail

XMLTitle

public XMLTitle(int level,
                java.lang.String title,
                boolean keepCase)

Constructor.

Parameters:

level - the title level

title - the title title

keepCase - true if the title description should keep the title description case

XMLTitle

public XMLTitle(int level,
                java.lang.String title,
                java.lang.String id,
                boolean keepCase)

Constructor.

Parameters:

level - the title level

title - the title title

id - the title id

keepCase - true if the title description should keep the title description case

XMLTitle

public XMLTitle(java.lang.String title,
                boolean isSeeAlso,
                boolean keepCase)

Constructor.

Parameters:

title - the title title

isSeeAlso - true for a SeeAlso title

keepCase - true if the title description should keep the title description case

Method Detail

setTitle

public void setTitle(java.lang.String title)

Set the title.

Specified by:

setTitle in interface org.docgene.model.TitledElement

Parameters:

title - the title

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

setSeq

public void setSeq(java.lang.String seq)

Set the title sequence id.

Specified by:

setSeq in interface org.docgene.model.TitledElement

Parameters:

seq - the sequence id

hasSeq

public boolean hasSeq()

Return true if the title has a forced sequence id.

Specified by:

hasSeq in interface org.docgene.model.TitledElement

Returns:

true if the title has a forced sequence id

getSeq

public java.lang.String getSeq()

Return the title sequence id.

Specified by:

getSeq in interface org.docgene.model.TitledElement

Returns:

seq the sequence id

setLevel

public void setLevel(int level)

Set the title level.

Specified by:

setLevel in interface org.docgene.model.TitledElement

Parameters:

level - the title level

setSearchable

public void setSearchable(boolean isSearchable)

Set if the title is searchable

Parameters:

isSearchable - true if the title is searchable

isSearchable

public boolean isSearchable()

Return true if the title is searchable.

Specified by:

isSearchable in interface org.docgene.model.TitledElement

Returns:

true if the title is searchable

setDuplicate

public void setDuplicate(boolean isDuplicate)

Set if the title is a duplicate of another existing title.

Parameters:

isDuplicate - true if the title is a duplicate of another existing title

isDuplicate

public boolean isDuplicate()

Return true if the title is a duplicate of another existing title.

Specified by:

isDuplicate in interface org.docgene.model.TitledElement

Returns:

true if the title is a duplicate of another existing title

setKeepCase

public void setKeepCase(boolean keepCase)

Set if the title description should keep the title description case.

Parameters:

keepCase - true if the title description should keep the title description case

isKeepingCase

public boolean isKeepingCase()

Return true if the title description should keep the title description case.

Specified by:

isKeepingCase in interface org.docgene.model.TitledElement

Returns:

true if the title description should keep the title description case

setResolved

public void setResolved()

Set the titled element as being resolved.

Specified by:

setResolved in interface org.docgene.model.TitledElement

isResolved

public boolean isResolved()

Return true if the title element has having been already resolved.

Specified by:

isResolved in interface org.docgene.model.TitledElement

Returns:

true if the title element has having been already resolved

setThematicBreak

public void setThematicBreak(boolean hasHR)

Set if the title has a thematic break ("hr") before the title.

Parameters:

hasHR - true if the title has a thematic break ("hr") before the title

hasThematicBreak

public boolean hasThematicBreak()

Return true if the title has a thematic break ("hr") before the title.

Returns:

true if the title has a thematic break ("hr") before the title

isSeeAlso

public boolean isSeeAlso()

Return true if the TitledElement correspond to a See Also title.

Specified by:

isSeeAlso in interface org.docgene.model.TitledElement

Returns:

true if the TitledElement correspond to a See Also title

getLevel

public int getLevel()

Return the title level.

Specified by:

getLevel in interface org.docgene.model.TitledElement

Returns:

the level.

getTitle

public java.lang.String getTitle()

Return the title title.

Specified by:

getTitle in interface org.docgene.model.AnchorElement

Specified by:

getTitle in interface org.docgene.model.TitledElement

Returns:

the title title

setID

public void setID(java.lang.String id)

Set the title id.

Specified by:

setID in interface org.docgene.model.AnchorElement

Parameters:

id - the title id

getID

public java.lang.String getID()

Return the title id.

Specified by:

getID in interface org.docgene.model.AnchorElement

Returns:

the title id