CmsListColumnDefinition

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

直接已知子类:

CmsListExplorerColumn, CmsListItemDetails, CmsListResourceLinkRelationExplorerColumn
```
public class CmsListColumnDefinition
extends java.lang.Object
```
Html list column definition.

从以下版本开始:

6.0.0

字段概要

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

static java.lang.String ICON_DOWN
Standard list button location.

static java.lang.String ICON_UP
Standard list button location.

字段
限定符和类型	字段和说明
`static java.lang.String`	`ICON_DOWN` Standard list button location.
`static java.lang.String`	`ICON_UP` Standard list button location.

构造器概要

构造器
构造器和说明

CmsListColumnDefinition(java.lang.String id)
Default Constructor.

构造器
构造器和说明
`CmsListColumnDefinition(java.lang.String id)` Default Constructor.

方法概要

方法
限定符和类型	方法和说明
`void`	`addDefaultAction(CmsListDefaultAction defaultAction)` Adds a default Action.
`void`	`addDirectAction(I_CmsListDirectAction listAction)` Adds a new action to the column.
`java.lang.String`	`csvCell(CmsListItem item)` returns the csv output for a cell.
`java.lang.String`	`csvHeader()` Returns the csv output for a column header.
`CmsListColumnAlignEnum`	`getAlign()` Returns the align.
`CmsListDefaultAction`	`getDefaultAction(java.lang.String actionId)` Returns a default action by id.
`java.util.List<java.lang.String>`	`getDefaultActionIds()` Returns the default Action Ids list.
`java.util.List<CmsListDefaultAction>`	`getDefaultActions()` Returns the default Actions list.
`I_CmsListDirectAction`	`getDirectAction(java.lang.String actionId)` Returns a direct action by id.
`java.util.List<java.lang.String>`	`getDirectActionIds()` Returns the direct Action Ids list.
`java.util.List<I_CmsListDirectAction>`	`getDirectActions()` Returns all direct actions.
`I_CmsListFormatter`	`getFormatter()` Returns the data formatter.
`CmsMessageContainer`	`getHelpText()` Returns the customized help Text.
`java.lang.String`	`getId()` Returns the id.
`I_CmsListItemComparator`	`getListItemComparator()` Returns the comparator, used for sorting.
`CmsMessageContainer`	`getName()` Returns the name.
`java.lang.String`	`getWidth()` Returns the width.
`A_CmsListDialog`	`getWp()` Returns the workplace dialog object.
`java.lang.String`	`htmlCell(CmsListItem item, boolean isPrintable)` returns the html for a cell.
`java.lang.String`	`htmlHeader(CmsHtmlList list)` Returns the html code for a column header.
`boolean`	`isPrintable()` Returns the printable .
`boolean`	`isSorteable()` Returns the sorteable.
`boolean`	`isTextWrapping()` Returns the text Wrapping flag.
`boolean`	`isVisible()` Returns the visible.
`CmsListDefaultAction`	`removeDefaultAction(java.lang.String actionId)` Removes the default action from this column by id.
`I_CmsListDirectAction`	`removeDirectAction(java.lang.String actionId)` Removes a direct action from this column by id.
`void`	`setAlign(CmsListColumnAlignEnum align)` Sets the align.
`void`	`setFormatter(I_CmsListFormatter formatter)` Sets the data formatter.
`void`	`setHelpText(CmsMessageContainer helpText)` Sets the customized help Text.
`void`	`setListItemComparator(I_CmsListItemComparator comparator)` Sets the comparator, used for sorting.
`void`	`setName(CmsMessageContainer name)` Sets the name.
`void`	`setPrintable(boolean printable)` Sets the printable flag.
`void`	`setSorteable(boolean sorteable)` Indicates if the current column is sorteable or not.
`void`	`setTextWrapping(boolean textWrapping)` Sets the text Wrapping flag.
`void`	`setVisible(boolean visible)` Sets the visible.
`void`	`setWidth(java.lang.String width)` Sets the width.
`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_DOWN
```
public static final java.lang.String ICON_DOWN
```
    Standard list button location.
    
    另请参阅:
    常量字段值
  - ICON_UP
```
public static final java.lang.String ICON_UP
```
    Standard list button location.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsListColumnDefinition
```
public CmsListColumnDefinition(java.lang.String id)
```
    Default Constructor.
    
    参数:
    id - the unique id
- 方法详细资料
  - addDefaultAction
```
public void addDefaultAction(CmsListDefaultAction defaultAction)
```
    Adds a default Action.
    A column could have more than one default action if the visibilities are complementary.
    
    参数:
    defaultAction - the default Action to add
  - addDirectAction
```
public void addDirectAction(I_CmsListDirectAction listAction)
```
    Adds a new action to the column.
    
    参数:
    listAction - the action to add
  - csvCell
```
public java.lang.String csvCell(CmsListItem item)
```
    returns the csv output for a cell.
    
    参数:
    item - the item to render the cell for
    
    返回:
    csv output
  - csvHeader
```
public java.lang.String csvHeader()
```
    Returns the csv output for a column header.
    
    返回:
    csv header
  - getAlign
```
public CmsListColumnAlignEnum getAlign()
```
    Returns the align.
    
    返回:
    the align
  - getDefaultAction
```
public CmsListDefaultAction getDefaultAction(java.lang.String actionId)
```
    Returns a default action by id.
    
    参数:
    actionId - the id of the action
    
    返回:
    the action if found or null
  - getDefaultActionIds
```
public java.util.List<java.lang.String> getDefaultActionIds()
```
    Returns the default Action Ids list.
    
    返回:
    the default Action Ids list
  - getDefaultActions
```
public java.util.List<CmsListDefaultAction> getDefaultActions()
```
    Returns the default Actions list.
    
    返回:
    a list of CmsListDefaultAction objects
  - getDirectAction
```
public I_CmsListDirectAction getDirectAction(java.lang.String actionId)
```
    Returns a direct action by id.
    
    参数:
    actionId - the id of the action
    
    返回:
    the action if found or null
  - getDirectActionIds
```
public java.util.List<java.lang.String> getDirectActionIds()
```
    Returns the direct Action Ids list.
    
    返回:
    the direct Action Ids list
  - getDirectActions
```
public java.util.List<I_CmsListDirectAction> getDirectActions()
```
    Returns all direct actions.
    
    返回:
    a list of I_CmsListDirectActions.
  - getFormatter
```
public I_CmsListFormatter getFormatter()
```
    Returns the data formatter.
    
    返回:
    the data formatter
  - getHelpText
```
public CmsMessageContainer getHelpText()
```
    Returns the customized help Text.
    if null a default help text indicating the sort actions is used.
    
    返回:
    the customized help Text
  - getId
```
public java.lang.String getId()
```
    Returns the id.
    
    返回:
    the id
  - getListItemComparator
```
public I_CmsListItemComparator getListItemComparator()
```
    Returns the comparator, used for sorting.
    if no comparator was set, the default list item comparator is used.
    
    返回:
    the comparator
    另请参阅:
    CmsListItemDefaultComparator
  - getName
```
public CmsMessageContainer getName()
```
    Returns the name.
    
    返回:
    the name
  - getWidth
```
public java.lang.String getWidth()
```
    Returns the width.
    
    返回:
    the width
  - getWp
```
public A_CmsListDialog getWp()
```
    Returns the workplace dialog object.
    
    返回:
    the workplace dialog object
  - htmlCell
```
public java.lang.String htmlCell(CmsListItem item,
                        boolean isPrintable)
```
    returns the html for a cell.
    
    参数:
    item - the item to render the cell for
    isPrintable - if the list is to be printed
    
    返回:
    html code
  - htmlHeader
```
public java.lang.String htmlHeader(CmsHtmlList list)
```
    Returns the html code for a column header.
    
    参数:
    list - the list to generate the header code for
    
    返回:
    html code
  - isPrintable
```
public boolean isPrintable()
```
    Returns the printable .
    
    返回:
    the printable flag
  - isSorteable
```
public boolean isSorteable()
```
    Returns the sorteable.
    
    返回:
    the sorteable
  - isTextWrapping
```
public boolean isTextWrapping()
```
    Returns the text Wrapping flag.
    
    返回:
    the text Wrapping flag
  - isVisible
```
public boolean isVisible()
```
    Returns the visible.
    
    返回:
    the visible
  - removeDefaultAction
```
public CmsListDefaultAction removeDefaultAction(java.lang.String actionId)
```
    Removes the default action from this column by id.
    
    参数:
    actionId - the id of the action to remove
    
    返回:
    the action if found or null
  - removeDirectAction
```
public I_CmsListDirectAction removeDirectAction(java.lang.String actionId)
```
    Removes a direct action from this column by id.
    
    参数:
    actionId - the id of the action to remove
    
    返回:
    the action if found or null
  - setAlign
```
public void setAlign(CmsListColumnAlignEnum align)
```
    Sets the align.
    
    参数:
    align - the align to set
  - setFormatter
```
public void setFormatter(I_CmsListFormatter formatter)
```
    Sets the data formatter.
    
    参数:
    formatter - the data formatter to set
  - setHelpText
```
public void setHelpText(CmsMessageContainer helpText)
```
    Sets the customized help Text.
    if null a default help text indicating the sort actions is used.
    
    参数:
    helpText - the customized help Text to set
  - setListItemComparator
```
public void setListItemComparator(I_CmsListItemComparator comparator)
```
    Sets the comparator, used for sorting.
    
    参数:
    comparator - the comparator to set
  - setName
```
public void setName(CmsMessageContainer name)
```
    Sets the name.
    
    参数:
    name - the name to set
  - setPrintable
```
public void setPrintable(boolean printable)
```
    Sets the printable flag.
    
    参数:
    printable - the printable flag to set
  - setSorteable
```
public void setSorteable(boolean sorteable)
```
    Indicates if the current column is sorteable or not.
    if true a default list item comparator is used.
    if false any previously set list item comparator is removed.
    
    参数:
    sorteable - the sorteable flag
  - setTextWrapping
```
public void setTextWrapping(boolean textWrapping)
```
    Sets the text Wrapping flag.
    
    参数:
    textWrapping - the text Wrapping flag to set
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets the visible.
    This will set also the printable flag to false.
    
    参数:
    visible - the visible to set
  - setWidth
```
public void setWidth(java.lang.String width)
```
    Sets the width.
    
    参数:
    width - the width to set
  - setWp
```
public void setWp(A_CmsListDialog wp)
```
    Sets the workplace dialog object.
    
    参数:
    wp - the workplace dialog object to set

类 CmsListColumnDefinition

字段概要

构造器概要

方法概要

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

字段详细资料

ICON_DOWN

ICON_UP

构造器详细资料

CmsListColumnDefinition

方法详细资料

addDefaultAction

addDirectAction

csvCell

csvHeader

getAlign

getDefaultAction

getDefaultActionIds

getDefaultActions

getDirectAction

getDirectActionIds

getDirectActions

getFormatter

getHelpText

getId

getListItemComparator

getName

getWidth

getWp

htmlCell

htmlHeader

isPrintable

isSorteable

isTextWrapping

isVisible

removeDefaultAction

removeDirectAction

setAlign

setFormatter

setHelpText

setListItemComparator

setName

setPrintable

setSorteable

setTextWrapping

setVisible

setWidth

setWp