org.activemath.webapp.speech
Interface SpeechItemListInterface

All Known Implementing Classes:

SpeechItemList

public interface SpeechItemListInterface

Method Summary

void	addFullItem(SpeechItem item) Adds an SpeechItem to the List.
void	addItem(String id) Adds an empty Item to the List, to prepare all Items in the List with content use prepareItemList
int	getEye()
String	getEyedItemContent()
SpeechItem	getItem(int pos)
String	getItemTitle(int pos)
LinkedList	getList()
void	nextItem() Set the Eye to the next Item, if the actual eyed Item is not the last in List.
void	prepareList(PresentationTool presentTool) when the list is complete, the prepareList function computes the titles, content and type of the items in the list.
void	prevItem() Set the Eye to the previous Item, if the actual eyed Item is not the first in the List.
void	setEye(int pos) Set the Eye-position to pos.
int	size()

Method Detail

addItem

void addItem(String id)

Adds an empty Item to the List, to prepare all Items in the List with content use prepareItemList

Parameters:

id - - The itemId of the item

prepareList

void prepareList(PresentationTool presentTool)

when the list is complete, the prepareList function computes the titles, content and type of the items in the list.

Parameters:

presentTool - - the Presentationtool to get the transformer

getItemTitle

String getItemTitle(int pos)

Parameters:

pos - - Position of the Item in the List

Returns:

Title of the Item on the Position pos in the List. When the List is not prepared this method returns an empty String

size

int size()

Returns:

- The size of the List, look also LinkedList.size()

getList

LinkedList getList()

Returns:

LinkedList Object of the ItemList. This is needed in the velocity to use the 'for each' expression

getItem

SpeechItem getItem(int pos)

Parameters:

pos - - The position of the Item in the List

Returns:

SpeechItem of the List on position pos

addFullItem

void addFullItem(SpeechItem item)

Adds an SpeechItem to the List.

Parameters:

item - - The SpeechItem which should be added.

setEye

void setEye(int pos)

Set the Eye-position to pos.

Parameters:

pos -

getEye

int getEye()

Returns:

- The actual Eye-Position of the List

getEyedItemContent

String getEyedItemContent()

Returns:

The content of the Item the Eye looked at.

nextItem

void nextItem()

Set the Eye to the next Item, if the actual eyed Item is not the last in List.

prevItem

void prevItem()

Set the Eye to the previous Item, if the actual eyed Item is not the first in the List.