pt.digitalis.dif.presentation.views.jsp.taglibs.interfaces
Interface IFootnoteContainer

All Known Subinterfaces:

IFormComponent

All Known Implementing Classes:

AbstractFormComponent, AbstractGridTag, ContainerBox, Document, Footnotes, FootnotesManager, Form, FormCRUD, FormManager, Grid, GridCRUD, GridTreeSelect, MultiSelect, Panel, PropertiesEditor, Wizard

public interface IFootnoteContainer

Defines the expected behavior for a footnotes container.

Author:

Rodrigo Gonçalves rgoncalves@digitalis.pt

Created on:

2008/10/22

Method Summary

void	addFootnote(FootnoteBean footnote) Adds a new footnote to the container.
void	addFootnotes(java.util.List<FootnoteBean> footnotes) Adds new footnotes to the container.
void	clearAllFootnotes() Clears the container footnotes.
boolean	containsFootnote(java.lang.String id) Checks if the container has already a footnote with the supplied id.
FootnoteBean	getFootnote(java.lang.String id) Returns the footnote with the supplied id.
int	getFootnoteSequenceNumber() Returns the next footnote sequence number.
java.util.List<FootnoteBean>	getFootnotesList() Returns the list of footnotes.
boolean	hasFootnotes()

Method Detail

addFootnote

void addFootnote(FootnoteBean footnote)

Adds a new footnote to the container.

Parameters:

footnote - the footnote to add

addFootnotes

void addFootnotes(java.util.List<FootnoteBean> footnotes)

Adds new footnotes to the container.

Parameters:

footnotes - the footnotes to add

clearAllFootnotes

void clearAllFootnotes()

Clears the container footnotes.

containsFootnote

boolean containsFootnote(java.lang.String id)

Checks if the container has already a footnote with the supplied id.

Parameters:

id - the footnote id

Returns:

T if the container already contains the footnote, F otherwise

getFootnote

FootnoteBean getFootnote(java.lang.String id)

Returns the footnote with the supplied id.

Parameters:

id - the footnote id

Returns:

the footnote if it exists, null otherwise

getFootnoteSequenceNumber

int getFootnoteSequenceNumber()

Returns the next footnote sequence number.

Returns:

the next footnote sequence number.

getFootnotesList

java.util.List<FootnoteBean> getFootnotesList()

Returns the list of footnotes.

Returns:

the list of footnotes

hasFootnotes

boolean hasFootnotes()

Returns:

T if there are footnotes stored