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

Class AbstractNavigationList

java.lang.Object

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

All Implemented Interfaces:

NavigationList, SimpleGraphicElement

Direct Known Subclasses:

NavigationListSilverpeasV5

public abstract class AbstractNavigationList
extends Object
implements NavigationList

Abstract class of the NavigationList

Version:

1.0

Author:

lloiseau

Constructor Summary

Constructors

Constructor	Description
AbstractNavigationList()	Creates new AbstractNavigationList

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	getIconsPath()	Give the path for the pics...
Collection<Item>	getItems()	Get the items collection
int	getNbcol()	Get the number of column of the list
String	getTitle()	Get the list's title
abstract 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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNavigationList

public AbstractNavigationList()

Creates new AbstractNavigationList

Method Detail

addItem

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

Description copied from interface: NavigationList

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

Specified by:

addItem in interface NavigationList

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

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

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

Specified by:

addItem in interface NavigationList

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)

addItem

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

Add an item with label and information in the navigation list

Specified by:

addItem in interface NavigationList

Parameters:

label - string that describe the item

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

addItem

public void addItem(String label,
                    String URL)

Add an item with label and information in the navigation list

Specified by:

addItem in interface NavigationList

Parameters:

label - string that describe the item

getItems

public Collection<Item> getItems()

Get the items collection

Returns:

The items collection

setTitle

public void setTitle(String title)

Set the title of the NavigationList

Specified by:

setTitle in interface NavigationList

Parameters:

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

getTitle

public String getTitle()

Get the list's title

Returns:

The title

setNbcol

public void setNbcol(int col)

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

Specified by:

setNbcol in interface NavigationList

Parameters:

col - int Specify the number of column

getNbcol

public int getNbcol()

Get the number of column of the list

Returns:

The number of columns

print

public abstract String print()

Print the NavigationList in an html format

Specified by:

print in interface NavigationList

Specified by:

print in interface SimpleGraphicElement

Returns:

The NavigationList representation

getIconsPath

public String getIconsPath()

Give the path for the pics...

Returns:

String Return the path

addItemSubItem

public 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

Specified by:

addItemSubItem in interface NavigationList

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