CmsHtmlList

java.lang.Object
- org.opencms.workplace.list.CmsHtmlList

```
public class CmsHtmlList
extends java.lang.Object
```
The main class of the html list widget.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ICON_LEFT` Standard list button location.
`static java.lang.String`	`ICON_RIGHT` Standard list button location.
`static java.lang.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 java.util.List<CmsListItem>`	`m_filteredItems` Filtered list of items or `null` if no filter is set and not sorted.
`protected java.lang.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 CmsMessageContainer`	`m_name` Display Name of the list.
`protected java.util.List<CmsListItem>`	`m_originalItems` Really content of the list.
`protected boolean`	`m_printable` printable flag.
`protected java.lang.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 java.lang.String`	`m_sortedColumn` Column name to be sorted.
`protected int`	`m_totalSize` The total size, only used is data self managed.
`protected java.util.List<CmsListItem>`	`m_visibleItems` Items currently displayed.
`protected A_CmsListDialog`	`m_wp` The related workplace dialog object.
`static java.lang.String`	`NO_SELECTION_HELP_VAR` Constant name for error message if no item has been selected.
`static java.lang.String`	`NO_SELECTION_MATCH_HELP_VAR` Constant name for error message if number of selected items does not match.

构造器概要

构造器
构造器和说明

CmsHtmlList(java.lang.String id, CmsMessageContainer name, CmsListMetadata metadata)
Default Constructor.

构造器
构造器和说明
`CmsHtmlList(java.lang.String id, CmsMessageContainer name, CmsListMetadata metadata)` Default Constructor.

方法概要

方法
限定符和类型	方法和说明
`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.
`java.util.List<CmsListItem>`	`getAllContent()` Returns all list items in the list, may be not visible and sorted.
`java.util.List<CmsListItem>`	`getContent()` Returns the filtered list of list items.
`int`	`getCurrentPage()` returns the number of the current page.
`java.util.List<CmsListItem>`	`getCurrentPageItems()` Returns all items of the current page.
`CmsListOrderEnum`	`getCurrentSortOrder()` Returns the current used sort order.
`java.lang.String`	`getId()` Returns the id.
`CmsListItem`	`getItem(java.lang.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.
`CmsMessageContainer`	`getName()` Returns the name of the list.
`int`	`getNumberOfPages()` Returns the filtered number of pages.
`java.lang.String`	`getSearchFilter()` Returns the search filter.
`int`	`getSize()` Return the filtered number of items.
`java.lang.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 java.lang.String`	`htmlBegin()` Generates the initial html code.
`protected java.lang.String`	`htmlEnd()` Generates the need html code for ending a list.
`static java.lang.String`	`htmlPageSelector(int nrPages, int itemsPage, int nrItems, int curPage, java.util.Locale locale)` Generates the list of html option elements for a html select control to select a page of a list.
`protected java.lang.String`	`htmlPagingBar()` Generates the needed html code for the paging bar.
`protected java.lang.String`	`htmlTitle()` Returns the html for the title of the list.
`protected java.lang.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.
`java.lang.String`	`listCsv()` Generates the csv output for the list.
`java.lang.String`	`listHtml()` Generates the html code for the list.
`java.lang.String`	`listJs()` Generate the need js code for the list.
`CmsListItem`	`newItem(java.lang.String id)` Returns a new list item for this list.
`java.lang.String`	`printableHtml()` Returns html code for printing the list.
`CmsListItem`	`removeItem(java.lang.String id)` Removes an item from the list.
`void`	`setBoxed(boolean isBoxed)` Sets the isBoxed flag.
`void`	`setContent(java.util.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(CmsMessageContainer name)` Sets the name of the list.
`void`	`setSearchFilter(java.lang.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(java.lang.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.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - ICON_LEFT
```
public static final java.lang.String ICON_LEFT
```
    Standard list button location.
    
    另请参阅:
    常量字段值
  - ICON_RIGHT
```
public static final java.lang.String ICON_RIGHT
```
    Standard list button location.
    
    另请参阅:
    常量字段值
  - ITEM_SEPARATOR
```
public static final java.lang.String ITEM_SEPARATOR
```
    Constant for item separator char used for coding/encoding multiselection.
    
    另请参阅:
    常量字段值
  - NO_SELECTION_HELP_VAR
```
public static final java.lang.String NO_SELECTION_HELP_VAR
```
    Constant name for error message if no item has been selected.
    
    另请参阅:
    常量字段值
  - NO_SELECTION_MATCH_HELP_VAR
```
public static final java.lang.String NO_SELECTION_MATCH_HELP_VAR
```
    Constant name for error message if number of selected items does not match.
    
    另请参阅:
    常量字段值
  - m_currentPage
```
protected int m_currentPage
```
    Current displayed page number.
  - m_currentSortOrder
```
protected CmsListOrderEnum m_currentSortOrder
```
    Current sort order.
  - m_filteredItems
```
protected java.util.List<CmsListItem> m_filteredItems
```
    Filtered list of items or null if no filter is set and not sorted.
  - m_id
```
protected final java.lang.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 CmsMessageContainer m_name
```
    Display Name of the list.
  - m_originalItems
```
protected java.util.List<CmsListItem> m_originalItems
```
    Really content of the list.
  - m_printable
```
protected boolean m_printable
```
    printable flag.
  - m_searchFilter
```
protected java.lang.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 java.lang.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 java.util.List<CmsListItem> m_visibleItems
```
    Items currently displayed.
  - m_wp
```
protected transient A_CmsListDialog m_wp
```
    The related workplace dialog object.
- 构造器详细资料
  - CmsHtmlList
```
public CmsHtmlList(java.lang.String id,
           CmsMessageContainer name,
           CmsListMetadata metadata)
```
    Default Constructor.
    
    参数:
    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
- 方法详细资料
  - htmlPageSelector
```
public static java.lang.String htmlPageSelector(int nrPages,
                                int itemsPage,
                                int nrItems,
                                int curPage,
                                java.util.Locale locale)
```
    Generates the list of html option elements for a html select control to select a page of a list.
    
    参数:
    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
    
    返回:
    html code
  - clear
```
public void clear()
```
    This method resets the content of the list (no the metadata).
  - getAllContent
```
public java.util.List<CmsListItem> getAllContent()
```
    Returns all list items in the list, may be not visible and sorted.
    
    返回:
    all list items
  - getContent
```
public java.util.List<CmsListItem> getContent()
```
    Returns the filtered list of list items.
    Equals to getAllContent() if no filter is set.
    
    返回:
    the filtered list of list items
  - getCurrentPage
```
public int getCurrentPage()
```
    returns the number of the current page.
    
    返回:
    the number of the current page
  - getCurrentPageItems
```
public java.util.List<CmsListItem> getCurrentPageItems()
```
    Returns all items of the current page.
    
    返回:
    all items of the current page, a list of CmsListItem objects
  - getCurrentSortOrder
```
public CmsListOrderEnum getCurrentSortOrder()
```
    Returns the current used sort order.
    
    返回:
    the current used sort order
  - getId
```
public java.lang.String getId()
```
    Returns the id.
    
    返回:
    the id
  - getItem
```
public CmsListItem getItem(java.lang.String id)
```
    This method returns the item identified by the parameter id.
    Only current visible item can be retrieved using this method.
    
    参数:
    id - the id of the item to look for
    
    返回:
    the requested item or null if not found
  - getMaxItemsPerPage
```
public int getMaxItemsPerPage()
```
    Returns the maximum number of items per page.
    
    返回:
    the maximum number of items per page
  - getMetadata
```
public CmsListMetadata getMetadata()
```
    Returns the metadata.
    
    返回:
    the metadata
  - getName
```
public CmsMessageContainer getName()
```
    Returns the name of the list.
    
    返回:
    the list's name
  - getNumberOfPages
```
public int getNumberOfPages()
```
    Returns the filtered number of pages.
    Equals to getTotalNumberOfPages() if no filter is set.
    
    返回:
    the filtered of pages
  - getSearchFilter
```
public java.lang.String getSearchFilter()
```
    Returns the search filter.
    
    返回:
    the search filter
  - getSize
```
public int getSize()
```
    Return the filtered number of items.
    Equals to getTotalSize() if no filter is set.
    
    返回:
    the filtered number of items
  - getSortedColumn
```
public java.lang.String getSortedColumn()
```
    Returns the sorted column's name.
    
    返回:
    the sorted column's name
  - getState
```
public CmsListState getState()
```
    Returns a filled list state.
    
    返回:
    the state of the list
  - getTotalNumberOfPages
```
public int getTotalNumberOfPages()
```
    Returns the total number of pages.
    
    返回:
    the total number of pages
  - getTotalSize
```
public int getTotalSize()
```
    Return the total number of items.
    
    返回:
    the total number of items
  - getWp
```
public A_CmsListDialog getWp()
```
    Returns the workplace dialog object.
    
    返回:
    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.
    
    返回:
    the isBoxed flag
  - isPrintable
```
public boolean isPrintable()
```
    Returns the printable flag.
    
    返回:
    the printable flag
  - isShowTitle
```
public boolean isShowTitle()
```
    Returns if the list title is shown.
    
    返回:
    true if the list title is shown, otherwise false
  - listCsv
```
public java.lang.String listCsv()
```
    Generates the csv output for the list.
    
    返回:
    csv output
  - listHtml
```
public java.lang.String listHtml()
```
    Generates the html code for the list.
    
    返回:
    html code
  - listJs
```
public java.lang.String listJs()
```
    Generate the need js code for the list.
    
    返回:
    js code
  - newItem
```
public CmsListItem newItem(java.lang.String id)
```
    Returns a new list item for this list.
    
    参数:
    id - the id of the item has to be unique
    
    返回:
    a new list item
  - printableHtml
```
public java.lang.String printableHtml()
```
    Returns html code for printing the list.
    
    返回:
    html code
  - removeItem
```
public CmsListItem removeItem(java.lang.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().
    
    参数:
    id - the id of the item to remove
    
    返回:
    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.
    
    参数:
    isBoxed - the isBoxed flag to set
  - setContent
```
public void setContent(java.util.Collection<CmsListItem> listItems)
```
    Sets the list item to display in the list.
    
    参数:
    listItems - a collection of CmsListItem objects
  - setCurrentPage
```
public void setCurrentPage(int currentPage)
                    throws CmsIllegalArgumentException
```
    Sets the current page.
    
    参数:
    currentPage - the current page to set
    
    抛出:
    
    CmsIllegalArgumentException - if the argument is invalid
  - setMaxItemsPerPage
```
public void setMaxItemsPerPage(int maxItemsPerPage)
```
    Sets the maximum number of items per page.
    
    参数:
    maxItemsPerPage - the maximum number of items per page to set
  - setName
```
public void setName(CmsMessageContainer name)
```
    Sets the name of the list.
    
    参数:
    name - the name of the list
  - setSearchFilter
```
public void setSearchFilter(java.lang.String searchFilter)
```
    Sets the search filter.
    
    参数:
    searchFilter - the search filter to set
  - setShowTitle
```
public void setShowTitle(boolean showTitle)
```
    Sets if the list title is shown.
    
    参数:
    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.
    
    参数:
    size - the size to set
  - setSortedColumn
```
public void setSortedColumn(java.lang.String sortedColumn)
                     throws CmsIllegalArgumentException
```
    Sets the sorted column.
    
    参数:
    sortedColumn - the sorted column to set
    
    抛出:
    
    CmsIllegalArgumentException - if the sortedColumn argument is invalid
  - setState
```
public void setState(CmsListState listState)
```
    Sets the list state.
    This may involve sorting, filtering and paging.
    
    参数:
    listState - the state to be set
  - setTotalSize
```
public void setTotalSize(int totalSize)
```
    Sets the total Size, only used if data self managed.
    
    参数:
    totalSize - the total Size to set
  - setWp
```
public void setWp(A_CmsListDialog wp)
```
    Sets the workplace dialog object.
    
    参数:
    wp - the workplace dialog object to set
  - displayedFrom
```
protected int displayedFrom()
```
    Returns the number (from 1) of the first displayed item.
    
    返回:
    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.
    
    返回:
    the number (from 1) of the last displayed item, or zero if the list is empty
  - htmlBegin
```
protected java.lang.String htmlBegin()
```
    Generates the initial html code.
    
    返回:
    html code
  - htmlEnd
```
protected java.lang.String htmlEnd()
```
    Generates the need html code for ending a list.
    
    返回:
    html code
  - htmlPagingBar
```
protected java.lang.String htmlPagingBar()
```
    Generates the needed html code for the paging bar.
    
    返回:
    html code
  - htmlTitle
```
protected java.lang.String htmlTitle()
```
    Returns the html for the title of the list.
    
    返回:
    html code
  - htmlToolBar
```
protected java.lang.String htmlToolBar()
```
    Returns the html code for the toolbar (search bar + multiactions bar).
    
    返回:
    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.
    
    参数:
    metadata - the list metadata

类 CmsHtmlList

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ICON_LEFT

ICON_RIGHT

ITEM_SEPARATOR

NO_SELECTION_HELP_VAR

NO_SELECTION_MATCH_HELP_VAR

m_currentPage

m_currentSortOrder

m_filteredItems

m_id

m_isBoxed

m_maxItemsPerPage

m_metadata

m_name

m_originalItems

m_printable

m_searchFilter

m_showTitle

m_size

m_sortedColumn

m_totalSize

m_visibleItems

m_wp

构造器详细资料

CmsHtmlList

方法详细资料

htmlPageSelector

clear

getAllContent

getContent

getCurrentPage

getCurrentPageItems

getCurrentSortOrder

getId

getItem

getMaxItemsPerPage

getMetadata

getName

getNumberOfPages

getSearchFilter

getSize

getSortedColumn

getState

getTotalNumberOfPages

getTotalSize

getWp

isBoxed

isPrintable

isShowTitle

listCsv

listHtml

listJs

newItem

printableHtml

removeItem

setBoxed

setContent

setCurrentPage

setMaxItemsPerPage

setName

setSearchFilter

setShowTitle

setSize

setSortedColumn

setState

setTotalSize

setWp

displayedFrom

displayedTo

htmlBegin

htmlEnd

htmlPagingBar

htmlTitle

htmlToolBar

setMetadata