Package org.silverpeas.core.web.util.viewgenerator.html.navigationlist

Interface NavigationList

All Superinterfaces:

SimpleGraphicElement

All Known Implementing Classes:

AbstractNavigationList, NavigationListSilverpeasV5

public interface NavigationList
extends SimpleGraphicElement

NavigationList is an interface to be implemented by a graphic element Very usefull to create a list of items in an html format.

Version:

1.0

Author:

lloiseau

Method Summary

Modifier and Type	Method	Description
void	addItem(String label, String URL)	Add an item with label and information in the navigation list
void	addItem(String label, String URL, int nbelem, String info)	Add an item with label, number of elements and information in the navigation list
void	addItem(String label, String URL, int nbelem, String info, String universalLink)	Add an item with label, number of elements, information in the navigation list and an universal link
void	addItem(String label, String URL, String info)	Add an item with label and information in the navigation list
void	addItemSubItem(String label, String URL, int nbelem, Collection<Link> links)	Add an item with label, number of elements and sub links in the navigation list
String	print()	Print the NavigationList in an html format
void	setNbcol(int col)	You can set the number of columns you want for your list Default is 3
void	setTitle(String title)	Set the title of the NavigationList

Method Detail

addItem

void addItem(String label,
             String URL,
             int nbelem,
             String info,
             String universalLink)

Add an item with label, number of elements, information in the navigation list and an universal link

Parameters:

label - - string that describe the item

nbelem - - give the number of element contained by the item For exemple, if the item is a directory, "nbelem" is the number of files you can find in this directory

info - - It can be everything ... (only string)

universalLink - - a link as string containing an universal link

addItem

void addItem(String label,
             String URL,
             int nbelem,
             String info)

Add an item with label, number of elements and information in the navigation list

Parameters:

label - string that describe the item

nbelem - give the number of element contained by the item For exemple, if the item is a directory, "nbelem" is the number of files you can find in this directory

info - It can be everything ... (only string)

addItemSubItem

void addItemSubItem(String label,
                    String URL,
                    int nbelem,
                    Collection<Link> links)

Add an item with label, number of elements and sub links in the navigation list

Parameters:

label - string that describe the item

nbelem - give the number of element contained by the item For exemple, if the item is a directory, "nbelem" is the number of files you can find in this directory

addItem

void addItem(String label,
             String URL,
             String info)

Add an item with label and information in the navigation list

Parameters:

label - string that describe the item

info - It can be everything ... (only string)

addItem

void addItem(String label,
             String URL)

Add an item with label and information in the navigation list

Parameters:

label - string that describe the item

setTitle

void setTitle(String title)

Set the title of the NavigationList

Parameters:

title - String that wil appear on the top of the NavigationList

setNbcol

void setNbcol(int col)

You can set the number of columns you want for your list Default is 3

Parameters:

col - int Specify the number of column

print

String print()

Print the NavigationList in an html format

Specified by:

print in interface SimpleGraphicElement

Returns:

The NavigationList representation