CmsListMetadata

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

```
public class CmsListMetadata
extends java.lang.Object
```
This is class contains all the information for defining a whole html list.

从以下版本开始:

6.0.0

嵌套类概要

嵌套类
限定符和类型类和说明

static interface CmsListMetadata.I_CsvItemFormatter
Interface used for formatting list data in text form.

嵌套类
限定符和类型	类和说明
`static interface`	`CmsListMetadata.I_CsvItemFormatter` Interface used for formatting list data in text form.

字段概要

字段
限定符和类型字段和说明

static java.lang.String SEARCH_BAR_INPUT_ID
the html id for the input element of the search bar.

字段
限定符和类型	字段和说明
`static java.lang.String`	`SEARCH_BAR_INPUT_ID` the html id for the input element of the search bar.

构造器概要

构造器
构造器和说明

CmsListMetadata(java.lang.String listId)
Default Constructor.

构造器
构造器和说明
`CmsListMetadata(java.lang.String listId)` Default Constructor.

方法概要

方法
限定符和类型	方法和说明
`void`	`addColumn(CmsListColumnDefinition listColumn)` Adds a new column definition at the end.
`void`	`addColumn(CmsListColumnDefinition listColumn, int position)` Adds a new column definition at the given position.
`void`	`addIndependentAction(I_CmsListAction action)` Adds a list item independent action.
`void`	`addItemDetails(CmsListItemDetails itemDetail)` Adds a new item detail definition at the end.
`void`	`addItemDetails(CmsListItemDetails itemDetail, int position)` Adds a new item detail definition at the given position.
`void`	`addMultiAction(CmsListMultiAction multiAction)` Adds an action applicable to more than one list item at once.
`java.lang.String`	`csvEmptyList()` Generates the csv output for an empty table.
`java.lang.String`	`csvHeader()` Returns the csv output for the header of the list.
`java.lang.String`	`csvItem(CmsListItem item)` Returns the csv output for a list item.
`CmsListColumnDefinition`	`getColumnDefinition(java.lang.String columnId)` Returns a column definition object for a given column id.
`java.util.List<CmsListColumnDefinition>`	`getColumnDefinitions()` Returns all columns definitions.
`I_CmsListAction`	`getIndependentAction(java.lang.String actionId)` Returns an independent action object for a given id.
`java.util.List<I_CmsListAction>`	`getIndependentActions()` Returns the list of independent actions.
`CmsListItemDetails`	`getItemDetailDefinition(java.lang.String itemDetailId)` Returns the item details definition object for a given id.
`java.util.List<CmsListItemDetails>`	`getItemDetailDefinitions()` Returns all detail definitions.
`java.lang.String`	`getListId()` Returns the id of the list.
`CmsListMultiAction`	`getMultiAction(java.lang.String actionId)` Returns a multi action object for a given id.
`java.util.List<CmsListMultiAction>`	`getMultiActions()` Returns the list of multi actions.
`CmsListSearchAction`	`getSearchAction()` Returns the search action.
`int`	`getWidth()` Returns the total number of displayed columns.
`A_CmsListDialog`	`getWp()` Returns the related workplace dialog.
`boolean`	`hasActions()` Returns `true` if the list definition contains an action.
`boolean`	`hasCheckMultiActions()` Returns `true` if at least 'check' multiaction has been set.
`boolean`	`hasMultiActions()` Returns `true` if the list definition contains a multi action.
`boolean`	`hasSingleActions()` Returns `true` if any column definition contains a single action.
`java.lang.String`	`htmlActionBar()` Returns the html code for the action bar.
`java.lang.String`	`htmlEmptyTable()` Generates the hml code for an empty table.
`java.lang.String`	`htmlHeader(CmsHtmlList list)` Returns the html code for the header of the list.
`java.lang.String`	`htmlItem(CmsListItem item, boolean odd, boolean isPrintable)` Returns the html code for a list item.
`java.lang.String`	`htmlMultiActionBar()` Returns the html code for the multi action bar.
`java.lang.String`	`htmlSearchBar()` Generates the html code for the search bar.
`boolean`	`isSearchable()` Returns `true` if the list is searchable.
`boolean`	`isSelfManaged()` Returns the self Managed flag.
`boolean`	`isSorteable()` Returns `true` if any column is sorteable.
`boolean`	`isVolatile()` Returns `true` if this metadata object should not be cached.
`void`	`setCsvItemFormatter(CmsListMetadata.I_CsvItemFormatter formatter)` Sets the CSV item formatter to use.
`void`	`setSearchAction(CmsListSearchAction searchAction)` Sets the search action.
`void`	`setSelfManaged(boolean selfManaged)` Sets the self Managed flag.
`void`	`setVolatile(boolean volatileFlag)` Sets the volatile flag.
`void`	`setWp(A_CmsListDialog wp)` Sets the related workplace dialog.
`void`	`toogleDetailState(java.lang.String itemDetailId)` Toggles the given item detail state from visible to hidden or from hidden to visible.

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

- 字段详细资料
  - SEARCH_BAR_INPUT_ID
```
public static final java.lang.String SEARCH_BAR_INPUT_ID
```
    the html id for the input element of the search bar.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsListMetadata
```
public CmsListMetadata(java.lang.String listId)
```
    Default Constructor.
    
    参数:
    listId - the id of the list
- 方法详细资料
  - addColumn
```
public void addColumn(CmsListColumnDefinition listColumn)
```
    Adds a new column definition at the end.
    By default a column is printable if it is the first column in the list, or if it is sorteable.
    If you want to override this behaviour, use the CmsListColumnDefinition.setPrintable(boolean) method after calling this one.
    
    参数:
    listColumn - the column definition
    另请参阅:
    CmsIdentifiableObjectContainer
  - addColumn
```
public void addColumn(CmsListColumnDefinition listColumn,
             int position)
```
    Adds a new column definition at the given position.
    By default a column is printable if it is the first column in the list, or if it is sorteable.
    If you want to override this behaviour, use the CmsListColumnDefinition.setPrintable(boolean) method after calling this one.
    
    参数:
    listColumn - the column definition
    position - the position
    另请参阅:
    CmsIdentifiableObjectContainer
  - addIndependentAction
```
public void addIndependentAction(I_CmsListAction action)
```
    Adds a list item independent action.
    
    参数:
    action - the action
  - addItemDetails
```
public void addItemDetails(CmsListItemDetails itemDetail)
```
    Adds a new item detail definition at the end.
    
    参数:
    itemDetail - the item detail definition
    另请参阅:
    CmsIdentifiableObjectContainer
  - addItemDetails
```
public void addItemDetails(CmsListItemDetails itemDetail,
                  int position)
```
    Adds a new item detail definition at the given position.
    
    参数:
    itemDetail - the item detail definition
    position - the position
    另请参阅:
    CmsIdentifiableObjectContainer
  - addMultiAction
```
public void addMultiAction(CmsListMultiAction multiAction)
```
    Adds an action applicable to more than one list item at once.
    It will be executed with a list of CmsListItems.
    
    参数:
    multiAction - the action
  - csvEmptyList
```
public java.lang.String csvEmptyList()
```
    Generates the csv output for an empty table.
    
    返回:
    csv output
  - csvHeader
```
public java.lang.String csvHeader()
```
    Returns the csv output for the header of the list.
    
    返回:
    csv output
  - csvItem
```
public java.lang.String csvItem(CmsListItem item)
```
    Returns the csv output for a list item.
    
    参数:
    item - the list item to render
    
    返回:
    csv output
  - getColumnDefinition
```
public CmsListColumnDefinition getColumnDefinition(java.lang.String columnId)
```
    Returns a column definition object for a given column id.
    
    参数:
    columnId - the column id
    
    返回:
    the column definition, or null if not present
  - getColumnDefinitions
```
public java.util.List<CmsListColumnDefinition> getColumnDefinitions()
```
    Returns all columns definitions.
    
    返回:
    a list of CmsListColumnDefinitions.
  - getIndependentAction
```
public I_CmsListAction getIndependentAction(java.lang.String actionId)
```
    Returns an independent action object for a given id.
    
    参数:
    actionId - the id
    
    返回:
    the independent action, or null if not present
  - getIndependentActions
```
public java.util.List<I_CmsListAction> getIndependentActions()
```
    Returns the list of independent actions.
    
    返回:
    a list of I_CmsListActions
  - getItemDetailDefinition
```
public CmsListItemDetails getItemDetailDefinition(java.lang.String itemDetailId)
```
    Returns the item details definition object for a given id.
    
    参数:
    itemDetailId - the id
    
    返回:
    the item details definition, or null if not present
  - getItemDetailDefinitions
```
public java.util.List<CmsListItemDetails> getItemDetailDefinitions()
```
    Returns all detail definitions.
    
    返回:
    a list of CmsListItemDetails.
  - getListId
```
public java.lang.String getListId()
```
    Returns the id of the list.
    
    返回:
    the id of list
  - getMultiAction
```
public CmsListMultiAction getMultiAction(java.lang.String actionId)
```
    Returns a multi action object for a given id.
    
    参数:
    actionId - the id
    
    返回:
    the multi action, or null if not present
  - getMultiActions
```
public java.util.List<CmsListMultiAction> getMultiActions()
```
    Returns the list of multi actions.
    
    返回:
    a list of CmsListMultiActions
  - getSearchAction
```
public CmsListSearchAction getSearchAction()
```
    Returns the search action.
    
    返回:
    the search action
  - getWidth
```
public int getWidth()
```
    Returns the total number of displayed columns.
    
    返回:
    the total number of displayed columns
  - getWp
```
public A_CmsListDialog getWp()
```
    Returns the related workplace dialog.
    
    返回:
    the related workplace dialog
  - hasActions
```
public boolean hasActions()
```
    Returns true if the list definition contains an action.
    
    返回:
    true if the list definition contains an action
  - hasCheckMultiActions
```
public boolean hasCheckMultiActions()
```
    Returns true if at least 'check' multiaction has been set.
    
    返回:
    true if at least 'check' multiaction has been set
  - hasMultiActions
```
public boolean hasMultiActions()
```
    Returns true if the list definition contains a multi action.
    
    返回:
    true if the list definition contains a multi action
  - hasSingleActions
```
public boolean hasSingleActions()
```
    Returns true if any column definition contains a single action.
    
    返回:
    true if any column definition contains a single action
  - htmlActionBar
```
public java.lang.String htmlActionBar()
```
    Returns the html code for the action bar.
    
    返回:
    html code
  - htmlEmptyTable
```
public java.lang.String htmlEmptyTable()
```
    Generates the hml code for an empty table.
    
    返回:
    html code
  - htmlHeader
```
public java.lang.String htmlHeader(CmsHtmlList list)
```
    Returns the html code for the header of the list.
    
    参数:
    list - the list to generate the code for
    
    返回:
    html code
  - htmlItem
```
public java.lang.String htmlItem(CmsListItem item,
                        boolean odd,
                        boolean isPrintable)
```
    Returns the html code for a list item.
    
    参数:
    item - the list item to render
    odd - if the position is odd or even
    isPrintable - if the list is to be printed
    
    返回:
    html code
  - htmlMultiActionBar
```
public java.lang.String htmlMultiActionBar()
```
    Returns the html code for the multi action bar.
    
    返回:
    html code
  - htmlSearchBar
```
public java.lang.String htmlSearchBar()
```
    Generates the html code for the search bar.
    
    返回:
    html code
  - isSearchable
```
public boolean isSearchable()
```
    Returns true if the list is searchable.
    
    返回:
    true if the list is searchable
  - isSelfManaged
```
public boolean isSelfManaged()
```
    Returns the self Managed flag.
    
    返回:
    the self Managed flag
  - isSorteable
```
public boolean isSorteable()
```
    Returns true if any column is sorteable.
    
    返回:
    true if any column is sorteable
  - isVolatile
```
public boolean isVolatile()
```
    Returns true if this metadata object should not be cached.
    
    返回:
    true if this metadata object should not be cached.
  - setCsvItemFormatter
```
public void setCsvItemFormatter(CmsListMetadata.I_CsvItemFormatter formatter)
```
    Sets the CSV item formatter to use.
    
    参数:
    formatter - the CSV item formatter
  - setSearchAction
```
public void setSearchAction(CmsListSearchAction searchAction)
```
    Sets the search action.
    
    参数:
    searchAction - the search action to set
  - setSelfManaged
```
public void setSelfManaged(boolean selfManaged)
```
    Sets the self Managed flag.
    
    参数:
    selfManaged - the self Managed flag to set
  - setVolatile
```
public void setVolatile(boolean volatileFlag)
```
    Sets the volatile flag.
    
    参数:
    volatileFlag - the volatile flag to set
  - setWp
```
public void setWp(A_CmsListDialog wp)
```
    Sets the related workplace dialog.
    
    参数:
    wp - the related workplace dialog to set
  - toogleDetailState
```
public void toogleDetailState(java.lang.String itemDetailId)
```
    Toggles the given item detail state from visible to hidden or from hidden to visible.
    
    参数:
    itemDetailId - the item detail id

类 CmsListMetadata

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

SEARCH_BAR_INPUT_ID

构造器详细资料

CmsListMetadata

方法详细资料

addColumn

addColumn

addIndependentAction

addItemDetails

addItemDetails

addMultiAction

csvEmptyList

csvHeader

csvItem

getColumnDefinition

getColumnDefinitions

getIndependentAction

getIndependentActions

getItemDetailDefinition

getItemDetailDefinitions

getListId

getMultiAction

getMultiActions

getSearchAction

getWidth

getWp

hasActions

hasCheckMultiActions

hasMultiActions

hasSingleActions

htmlActionBar

htmlEmptyTable

htmlHeader

htmlItem

htmlMultiActionBar

htmlSearchBar

isSearchable

isSelfManaged

isSorteable

isVolatile

setCsvItemFormatter

setSearchAction

setSelfManaged

setVolatile

setWp

toogleDetailState