|
| |
|
| java.lang.Object
 org.opencms.workplace.list.CmsHtmlList
| CmsHtmlList | | public class CmsHtmlList (Code) | | The main class of the html list widget.
author:
Michael Moossen
version:
$Revision: 1.38 $
since:
6.0.0 |
| ICON_LEFT | | final public static String ICON_LEFT(Code) | | Standard list button location.
|
| ICON_RIGHT | | final public static String ICON_RIGHT(Code) | | Standard list button location.
|
| ITEM_SEPARATOR | | final public static String ITEM_SEPARATOR(Code) | | Constant for item separator char used for coding/encoding multiselection.
|
| NO_SELECTION_HELP_VAR | | final public static String NO_SELECTION_HELP_VAR(Code) | | Var name for error message if no item has been selected.
|
| NO_SELECTION_MATCH_HELP_VAR | | final public static String NO_SELECTION_MATCH_HELP_VAR(Code) | | Var name for error message if number of selected items does not match.
|
| CmsHtmlList | | public CmsHtmlList(String id, CmsMessageContainer name, CmsListMetadata metadata)(Code) | | Default Constructor.
Parameters:
id - unique id of the list, is used as name for controls and js functions and vars
Parameters:
name - the display name
Parameters:
metadata - the list's metadata |
| clear | | public void clear()(Code) | | This method resets the content of the list (no the metadata).
|
| getAllContent | | public List getAllContent()(Code) | | Returns all list items in the list, may be not visible and sorted.
all list items |
| getCurrentPage | | public int getCurrentPage()(Code) | | returns the number of the current page.
the number of the current page |
| getCurrentPageItems | | public List getCurrentPageItems()(Code) | | Returns all items of the current page.
all items of the current page, a list of CmsListItem objects |
| getCurrentSortOrder | | public CmsListOrderEnum getCurrentSortOrder()(Code) | | Returns the current used sort order.
the current used sort order |
| getItem | | public CmsListItem getItem(String id)(Code) | | 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 the requested item or null if not found |
| getMaxItemsPerPage | | public int getMaxItemsPerPage()(Code) | | Returns the maximum number of items per page.
the maximum number of items per page |
| getSearchFilter | | public String getSearchFilter()(Code) | | Returns the search filter.
the search filter |
| getSortedColumn | | public String getSortedColumn()(Code) | | Returns the sorted column's name.
the sorted column's name |
| getState | | public CmsListState getState()(Code) | | Returns a filled list state.
the state of the list |
| getTotalNumberOfPages | | public int getTotalNumberOfPages()(Code) | | Returns the total number of pages.
the total number of pages |
| getTotalSize | | public int getTotalSize()(Code) | | Return the total number of items.
the total number of items |
| getWp | | public A_CmsListDialog getWp()(Code) | | Returns the workplace dialog object.
the workplace dialog object |
| htmlPageSelector | | public static String htmlPageSelector(int nrPages, int itemsPage, int nrItems, int curPage, Locale locale)(Code) | | 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
Parameters:
itemsPage - the maximum number of items per page
Parameters:
nrItems - the total number of items
Parameters:
curPage - the current page
Parameters:
locale - the locale html code |
| isBoxed | | public boolean isBoxed()(Code) | | Returns the isBoxed flag.
If this flag is set the list will be surrounded by a box.
the isBoxed flag |
| isPrintable | | public boolean isPrintable()(Code) | | Returns the printable flag.
the printable flag |
| isShowTitle | | public boolean isShowTitle()(Code) | | Returns if the list title is shown.
true if the list title is shown, otherwise false |
| listCsv | | public String listCsv()(Code) | | Generates the csv output for the list.
csv output |
| listHtml | | public synchronized String listHtml()(Code) | | Generates the html code for the list.
html code |
| listJs | | public String listJs()(Code) | | Generate the need js code for the list.
js code |
| newItem | | public CmsListItem newItem(String id)(Code) | | Returns a new list item for this list.
Parameters:
id - the id of the item has to be unique a new list item |
| printableHtml | | public String printableHtml()(Code) | | Returns html code for printing the list.
html code |
| setBoxed | | public void setBoxed(boolean isBoxed)(Code) | | 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 listItems)(Code) | | Sets the list item to display in the list.
Parameters:
listItems - a collection of CmsListItem objects |
| setMaxItemsPerPage | | public void setMaxItemsPerPage(int maxItemsPerPage)(Code) | | Sets the maximum number of items per page.
Parameters:
maxItemsPerPage - the maximum number of items per page to set |
| setName | | public void setName(CmsMessageContainer name)(Code) | | Sets the name of the list.
Parameters:
name - the name of the list |
| setSearchFilter | | public void setSearchFilter(String searchFilter)(Code) | | Sets the search filter.
Parameters:
searchFilter - the search filter to set |
| setShowTitle | | public void setShowTitle(boolean showTitle)(Code) | | Sets if the list title is shown.
Parameters:
showTitle - true if the list title is shown, otherwise false |
| setSize | | public void setSize(int size)(Code) | | Sets the current filtered size, only used if data self managed.
Parameters:
size - the size to set |
| setState | | public void setState(CmsListState listState)(Code) | | Sets the list state.
This may involve sorting, filtering and paging.
Parameters:
listState - the state to be set |
| setTotalSize | | public void setTotalSize(int totalSize)(Code) | | Sets the total Size, only used if data self managed.
Parameters:
totalSize - the total Size to set |
| setWp | | public void setWp(A_CmsListDialog wp)(Code) | | Sets the workplace dialog object.
Parameters:
wp - the workplace dialog object to set |
|
|
|