org.ujac.print
Class TocItem

java.lang.Object
  org.ujac.print.TocItem

public class TocItem
extends Object

Name: TocItem
Description: A class holding informations about table of contents entries (chapters or sessions for example).

Author:

lauerc

Constructor Summary

TocItem(int level, String number, String title, String tocRelevance)
Constructs a TocItem instance with specific attributes.

TocItem(int level, String number, String title, String tocRelevance, int page, float position)
Constructs a TocItem instance with specific attributes.

Method Summary

int	getIndex() Getter method for the the property index.
int	getLevel() Getter method for the the property level.
String	getNumber() Getter method for the the property number.
OutlineItem	getOutline() Getter method for the the property outline.
int	getPage() Getter method for the the property page.
float	getPosition() Getter method for the the property position.
String	getTitle() Getter method for the the property title.
String	getTocRelevance() Getter method for the the property tocRelevance.
void	setIndex(int index) Setter method for the the property index.
void	setOutline(OutlineItem outline) Setter method for the the property outline.
protected void	setPage(int page) Setter method for the the property page.
void	setPosition(float position) Setter method for the the property position.
void	setTocRelevance(String tocRelevance) Setter method for the the property tocRelevance.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TocItem

public TocItem(int level,
               String number,
               String title,
               String tocRelevance)

Constructs a TocItem instance with specific attributes.

Parameters:

level - The level of the toc entry.

number - The number of the iten.

title - The title of the item.

tocRelevance - The relevance definition, 'toc': only for TOC, 'index' only for index, 'all': view in both, index and TOC.

TocItem

public TocItem(int level,
               String number,
               String title,
               String tocRelevance,
               int page,
               float position)

Constructs a TocItem instance with specific attributes.

Parameters:

level - The level of the toc entry.

number - The number of the iten.

title - The title of the item.

tocRelevance - The relevance definition, 'toc': only for TOC, 'index' only for index, 'all': view in both, index and TOC.

page - The page where the item is located.

position - The vertical position of the item.

Method Detail

getLevel

public int getLevel()

Getter method for the the property level.

Returns:

The current value of property level.

getNumber

public String getNumber()

Getter method for the the property number.

Returns:

The current value of property number.

getTitle

public String getTitle()

Getter method for the the property title.

Returns:

The current value of property title.

getPage

public int getPage()

Getter method for the the property page.

Returns:

The current value of property page.

setPage

protected void setPage(int page)

Setter method for the the property page.

Parameters:

page - The value to set for the property page.

getPosition

public float getPosition()

Getter method for the the property position.

Returns:

The current value of property position.

setPosition

public void setPosition(float position)

Setter method for the the property position.

Parameters:

position - The value to set for the property position.

getOutline

public OutlineItem getOutline()

Getter method for the the property outline.

Returns:

The current value of property outline.

setOutline

public void setOutline(OutlineItem outline)

Setter method for the the property outline.

Parameters:

outline - The value to set for the property outline.

getTocRelevance

public String getTocRelevance()

Getter method for the the property tocRelevance.

Returns:

The current value of property tocRelevance.

setTocRelevance

public void setTocRelevance(String tocRelevance)

Setter method for the the property tocRelevance.

Parameters:

tocRelevance - The value to set for the property tocRelevance.

getIndex

public int getIndex()

Getter method for the the property index.

Returns:

The current value of property index.

setIndex

public void setIndex(int index)

Setter method for the the property index.

Parameters:

index - The value to set for the property index.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()