Package org.opencms.workplace.list

Class CmsHtmlList

java.lang.Object

org.opencms.workplace.list.CmsHtmlList

public class CmsHtmlList
extends Object

The main class of the html list widget.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON_LEFT	Standard list button location.
static final String	ICON_RIGHT	Standard list button location.
static final String	ITEM_SEPARATOR	Constant for item separator char used for coding/encoding multiselection.
protected int	m_currentPage	Current displayed page number.
protected CmsListOrderEnum	m_currentSortOrder	Current sort order.
protected List<CmsListItem>	m_filteredItems	Filtered list of items or null if no filter is set and not sorted.
protected final String	m_id	Dhtml id.
protected boolean	m_isBoxed	If this flag is set the list will be surrounded by a box.
protected int	m_maxItemsPerPage	Maximum number of items per page.
protected CmsListMetadata	m_metadata	Metadata for building the list.
protected org.opencms.i18n.CmsMessageContainer	m_name	Display Name of the list.
protected List<CmsListItem>	m_originalItems	Really content of the list.
protected boolean	m_printable	printable flag.
protected String	m_searchFilter	Search filter text.
protected boolean	m_showTitle	Show the title of the list.
protected int	m_size	The filtered content size, only used if data self managed.
protected String	m_sortedColumn	Column name to be sorted.
protected int	m_totalSize	The total size, only used is data self managed.
protected List<CmsListItem>	m_visibleItems	Items currently displayed.
protected A_CmsListDialog	m_wp	The related workplace dialog object.
static final String	NO_SELECTION_HELP_VAR	Constant name for error message if no item has been selected.
static final String	NO_SELECTION_MATCH_HELP_VAR	Constant name for error message if number of selected items does not match.

Constructor Summary

Constructors

Constructor	Description
CmsHtmlList(String id, org.opencms.i18n.CmsMessageContainer name, CmsListMetadata metadata)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	This method resets the content of the list (no the metadata).
protected int	displayedFrom()	Returns the number (from 1) of the first displayed item.
protected int	displayedTo()	Returns the number (from 1) of the last displayed item.
List<CmsListItem>	getAllContent()	Returns all list items in the list, may be not visible and sorted.
List<CmsListItem>	getContent()	Returns the filtered list of list items.
int	getCurrentPage()	returns the number of the current page.
List<CmsListItem>	getCurrentPageItems()	Returns all items of the current page.
CmsListOrderEnum	getCurrentSortOrder()	Returns the current used sort order.
String	getId()	Returns the id.
CmsListItem	getItem(String id)	This method returns the item identified by the parameter id.
int	getMaxItemsPerPage()	Returns the maximum number of items per page.
CmsListMetadata	getMetadata()	Returns the metadata.
org.opencms.i18n.CmsMessageContainer	getName()	Returns the name of the list.
int	getNumberOfPages()	Returns the filtered number of pages.
String	getSearchFilter()	Returns the search filter.
int	getSize()	Return the filtered number of items.
String	getSortedColumn()	Returns the sorted column's name.
CmsListState	getState()	Returns a filled list state.
int	getTotalNumberOfPages()	Returns the total number of pages.
int	getTotalSize()	Return the total number of items.
A_CmsListDialog	getWp()	Returns the workplace dialog object.
protected String	htmlBegin()	Generates the initial html code.
protected String	htmlEnd()	Generates the need html code for ending a list.
static String	htmlPageSelector(int nrPages, int itemsPage, int nrItems, int curPage, Locale locale)	Generates the list of html option elements for a html select control to select a page of a list.
protected String	htmlPagingBar()	Generates the needed html code for the paging bar.
protected String	htmlTitle()	Returns the html for the title of the list.
protected String	htmlToolBar()	Returns the html code for the toolbar (search bar + multiactions bar).
boolean	isBoxed()	Returns the isBoxed flag.
boolean	isPrintable()	Returns the printable flag.
boolean	isShowTitle()	Returns if the list title is shown.
String	listCsv()	Generates the csv output for the list.
String	listHtml()	Generates the html code for the list.
String	listJs()	Generate the need js code for the list.
CmsListItem	newItem(String id)	Returns a new list item for this list.
String	printableHtml()	Returns html code for printing the list.
CmsListItem	removeItem(String id)	Removes an item from the list.
void	setBoxed(boolean isBoxed)	Sets the isBoxed flag.
void	setContent(Collection<CmsListItem> listItems)	Sets the list item to display in the list.
void	setCurrentPage(int currentPage)	Sets the current page.
void	setMaxItemsPerPage(int maxItemsPerPage)	Sets the maximum number of items per page.
protected void	setMetadata(CmsListMetadata metadata)	Sets the metadata for this list.
void	setName(org.opencms.i18n.CmsMessageContainer name)	Sets the name of the list.
void	setSearchFilter(String searchFilter)	Sets the search filter.
void	setShowTitle(boolean showTitle)	Sets if the list title is shown.
void	setSize(int size)	Sets the current filtered size, only used if data self managed.
void	setSortedColumn(String sortedColumn)	Sets the sorted column.
void	setState(CmsListState listState)	Sets the list state.
void	setTotalSize(int totalSize)	Sets the total Size, only used if data self managed.
void	setWp(A_CmsListDialog wp)	Sets the workplace dialog object.

Methods inherited from class java.lang.Object

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

Field Details

ICON_LEFT

public static final String ICON_LEFT

Standard list button location.

See Also:

• Constant Field Values

ICON_RIGHT

public static final String ICON_RIGHT

Standard list button location.

See Also:

• Constant Field Values

ITEM_SEPARATOR

public static final String ITEM_SEPARATOR

Constant for item separator char used for coding/encoding multiselection.

See Also:

• Constant Field Values

NO_SELECTION_HELP_VAR

public static final String NO_SELECTION_HELP_VAR

Constant name for error message if no item has been selected.

See Also:

• Constant Field Values

NO_SELECTION_MATCH_HELP_VAR

public static final String NO_SELECTION_MATCH_HELP_VAR

Constant name for error message if number of selected items does not match.

See Also:

• Constant Field Values

m_currentPage

protected int m_currentPage

Current displayed page number.

m_currentSortOrder

protected CmsListOrderEnum m_currentSortOrder

Current sort order.

m_filteredItems

protected List<CmsListItem> m_filteredItems

Filtered list of items or null if no filter is set and not sorted.

m_id

protected final String m_id

Dhtml id.

m_isBoxed

protected boolean m_isBoxed

If this flag is set the list will be surrounded by a box.

m_maxItemsPerPage

protected int m_maxItemsPerPage

Maximum number of items per page.

m_metadata

protected CmsListMetadata m_metadata

Metadata for building the list.

m_name

protected org.opencms.i18n.CmsMessageContainer m_name

Display Name of the list.

m_originalItems

protected List<CmsListItem> m_originalItems

Really content of the list.

m_printable

protected boolean m_printable

printable flag.

m_searchFilter

protected String m_searchFilter

Search filter text.

m_showTitle

protected boolean m_showTitle

Show the title of the list.

m_size

protected int m_size

The filtered content size, only used if data self managed.

m_sortedColumn

protected String m_sortedColumn

Column name to be sorted.

m_totalSize

protected int m_totalSize

The total size, only used is data self managed.

m_visibleItems

protected List<CmsListItem> m_visibleItems

Items currently displayed.

m_wp

protected transient A_CmsListDialog m_wp

The related workplace dialog object.

Constructor Details

CmsHtmlList

public CmsHtmlList(String id,
 org.opencms.i18n.CmsMessageContainer name,
 CmsListMetadata metadata)

Default Constructor.

Parameters:

id - unique id of the list, is used as name for controls and js functions and vars

name - the display name

metadata - the list's metadata

Method Details

htmlPageSelector

public static String htmlPageSelector(int nrPages,
 int itemsPage,
 int nrItems,
 int curPage,
 Locale locale)

Generates the list of html option elements for a html select control to select a page of a list.

Parameters:

nrPages - the total number of pages

itemsPage - the maximum number of items per page

nrItems - the total number of items

curPage - the current page

locale - the locale

Returns:

html code

clear

public void clear()

This method resets the content of the list (no the metadata).

getAllContent

public List<CmsListItem> getAllContent()

Returns all list items in the list, may be not visible and sorted.

Returns:

all list items

getContent

public List<CmsListItem> getContent()

Returns the filtered list of list items.

Equals to getAllContent() if no filter is set.

Returns:

the filtered list of list items

getCurrentPage

public int getCurrentPage()

returns the number of the current page.

Returns:

the number of the current page

getCurrentPageItems

public List<CmsListItem> getCurrentPageItems()

Returns all items of the current page.

Returns:

all items of the current page, a list of CmsListItem objects

getCurrentSortOrder

public CmsListOrderEnum getCurrentSortOrder()

Returns the current used sort order.

Returns:

the current used sort order

getId

public String getId()

Returns the id.

Returns:

the id

getItem

public CmsListItem getItem(String id)

This method returns the item identified by the parameter id.

Only current visible item can be retrieved using this method.

Parameters:

id - the id of the item to look for

Returns:

the requested item or null if not found

getMaxItemsPerPage

public int getMaxItemsPerPage()

Returns the maximum number of items per page.

Returns:

the maximum number of items per page

getMetadata

public CmsListMetadata getMetadata()

Returns the metadata.

Returns:

the metadata

getName

public org.opencms.i18n.CmsMessageContainer getName()

Returns the name of the list.

Returns:

the list's name

getNumberOfPages

public int getNumberOfPages()

Returns the filtered number of pages.

Equals to getTotalNumberOfPages() if no filter is set.

Returns:

the filtered of pages

getSearchFilter

public String getSearchFilter()

Returns the search filter.

Returns:

the search filter

getSize

public int getSize()

Return the filtered number of items.

Equals to getTotalSize() if no filter is set.

Returns:

the filtered number of items

getSortedColumn

public String getSortedColumn()

Returns the sorted column's name.

Returns:

the sorted column's name

getState

public CmsListState getState()

Returns a filled list state.

Returns:

the state of the list

getTotalNumberOfPages

public int getTotalNumberOfPages()

Returns the total number of pages.

Returns:

the total number of pages

getTotalSize

public int getTotalSize()

Return the total number of items.

Returns:

the total number of items

getWp

public A_CmsListDialog getWp()

Returns the workplace dialog object.

Returns:

the workplace dialog object

isBoxed

public boolean isBoxed()

Returns the isBoxed flag.

If this flag is set the list will be surrounded by a box.

Returns:

the isBoxed flag

isPrintable

public boolean isPrintable()

Returns the printable flag.

Returns:

the printable flag

isShowTitle

public boolean isShowTitle()

Returns if the list title is shown.

Returns:

true if the list title is shown, otherwise false

listCsv

public String listCsv()

Generates the csv output for the list.

Returns:

csv output

listHtml

public String listHtml()

Generates the html code for the list.

Returns:

html code

listJs

public String listJs()

Generate the need js code for the list.

Returns:

js code

newItem

public CmsListItem newItem(String id)

Returns a new list item for this list.

Parameters:

id - the id of the item has to be unique

Returns:

a new list item

printableHtml

public String printableHtml()

Returns html code for printing the list.

Returns:

html code

removeItem

public CmsListItem removeItem(String id)

Removes an item from the list.

Keeping care of all the state like sorted column, sorting order, displayed page and search filter.

Try to use it instead of A_CmsListDialog.refreshList().

Parameters:

id - the id of the item to remove

Returns:

the removed list item

setBoxed

public void setBoxed(boolean isBoxed)

Sets the isBoxed flag.

If this flag is set, the list will be surrounded by a box.

Parameters:

isBoxed - the isBoxed flag to set

setContent

public void setContent(Collection<CmsListItem> listItems)

Sets the list item to display in the list.

Parameters:

listItems - a collection of CmsListItem objects

setCurrentPage

public void setCurrentPage(int currentPage)
                    throws org.opencms.main.CmsIllegalArgumentException

Sets the current page.

Parameters:

currentPage - the current page to set

Throws:

org.opencms.main.CmsIllegalArgumentException - if the argument is invalid

setMaxItemsPerPage

public void setMaxItemsPerPage(int maxItemsPerPage)

Sets the maximum number of items per page.

Parameters:

maxItemsPerPage - the maximum number of items per page to set

setName

public void setName(org.opencms.i18n.CmsMessageContainer name)

Sets the name of the list.

Parameters:

name - the name of the list

setSearchFilter

public void setSearchFilter(String searchFilter)

Sets the search filter.

Parameters:

searchFilter - the search filter to set

setShowTitle

public void setShowTitle(boolean showTitle)

Sets if the list title is shown.

Parameters:

showTitle - true if the list title is shown, otherwise false

setSize

public void setSize(int size)

Sets the current filtered size, only used if data self managed.

Parameters:

size - the size to set

setSortedColumn

public void setSortedColumn(String sortedColumn)
                     throws org.opencms.main.CmsIllegalArgumentException

Sets the sorted column.

Parameters:

sortedColumn - the sorted column to set

Throws:

org.opencms.main.CmsIllegalArgumentException - if the sortedColumn argument is invalid

setState

public void setState(CmsListState listState)

Sets the list state.

This may involve sorting, filtering and paging.

Parameters:

listState - the state to be set

setTotalSize

public void setTotalSize(int totalSize)

Sets the total Size, only used if data self managed.

Parameters:

totalSize - the total Size to set

setWp

public void setWp(A_CmsListDialog wp)

Sets the workplace dialog object.

Parameters:

wp - the workplace dialog object to set

displayedFrom

protected int displayedFrom()

Returns the number (from 1) of the first displayed item.

Returns:

the number (from 1) of the first displayed item, or zero if the list is empty

displayedTo

protected int displayedTo()

Returns the number (from 1) of the last displayed item.

Returns:

the number (from 1) of the last displayed item, or zero if the list is empty

htmlBegin

protected String htmlBegin()

Generates the initial html code.

Returns:

html code

htmlEnd

protected String htmlEnd()

Generates the need html code for ending a list.

Returns:

html code

htmlPagingBar

protected String htmlPagingBar()

Generates the needed html code for the paging bar.

Returns:

html code

htmlTitle

protected String htmlTitle()

Returns the html for the title of the list.

Returns:

html code

htmlToolBar

protected String htmlToolBar()

Returns the html code for the toolbar (search bar + multiactions bar).

Returns:

html code

setMetadata

protected void setMetadata(CmsListMetadata metadata)

Sets the metadata for this list.

Should only be used by the A_CmsListDialog class for temporally removing the metadata object while the list is saved in the CmsWorkplaceSettings.

Parameters:

metadata - the list metadata