Package org.opencms.workplace.list

Class CmsListItemDetails

java.lang.Object

org.opencms.workplace.list.CmsListColumnDefinition

org.opencms.workplace.list.CmsListItemDetails

public class CmsListItemDetails
extends CmsListColumnDefinition

For adding detail information to the list items add an instance of this class to the list metadata and fill the data like an additional column.

For detail contents you may use HTML code.

Since:

6.0.0

Field Summary

Fields inherited from class org.opencms.workplace.list.CmsListColumnDefinition

ICON_DOWN, ICON_UP

Constructor Summary

Constructors

Constructor	Description
CmsListItemDetails(String id)	Default constructor.

Method Summary

Modifier and Type	Method	Description
I_CmsListAction	getAction()	Returns the current active action.
String	getAtColumn()	Returns the id of the first column to include.
void	setAtColumn(String atColumn)	Sets the id of the first column to include.
void	setHideAction(I_CmsListAction hideAction)	Sets the hide details Action.
void	setHideActionHelpText(org.opencms.i18n.CmsMessageContainer hideActionHelp)	Sets the help text of the hide action.
void	setHideActionName(org.opencms.i18n.CmsMessageContainer hideActionName)	Sets the name of the hide action.
void	setListId(String listId)	Sets the id of the list.
void	setShowAction(I_CmsListAction showAction)	Sets the show details Action.
void	setShowActionHelpText(org.opencms.i18n.CmsMessageContainer showActionHelp)	Sets the help text of the show action.
void	setShowActionName(org.opencms.i18n.CmsMessageContainer showActionName)	Sets the name of the show action.
void	setWp(A_CmsListDialog wp)	Sets the workplace dialog object.

Methods inherited from class org.opencms.workplace.list.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

Methods inherited from class java.lang.Object

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

Constructor Details

CmsListItemDetails

public CmsListItemDetails(String id)

Default constructor.

Parameters:

id - the unique id

Method Details

setWp

public void setWp(A_CmsListDialog wp)

Description copied from class: CmsListColumnDefinition

Sets the workplace dialog object.

Overrides:

setWp in class CmsListColumnDefinition

Parameters:

wp - the workplace dialog object to set

See Also:

• CmsListColumnDefinition.setWp(org.opencms.workplace.list.A_CmsListDialog)

getAction

public I_CmsListAction getAction()

Returns the current active action.

Returns:

the current active action

getAtColumn

public String getAtColumn()

Returns the id of the first column to include.

Returns:

the id of the first column to include

setAtColumn

public void setAtColumn(String atColumn)

Sets the id of the first column to include.

Parameters:

atColumn - the id of the first column to set

setHideAction

public void setHideAction(I_CmsListAction hideAction)

Sets the hide details Action.

Parameters:

hideAction - the hide details Action to set

setHideActionHelpText

public void setHideActionHelpText(org.opencms.i18n.CmsMessageContainer hideActionHelp)

Sets the help text of the hide action.

Parameters:

hideActionHelp - the help text of the hide action

setHideActionName

public void setHideActionName(org.opencms.i18n.CmsMessageContainer hideActionName)

Sets the name of the hide action.

Parameters:

hideActionName - the name of the hide action

setListId

public void setListId(String listId)

Sets the id of the list.

Parameters:

listId - the id of the list

setShowAction

public void setShowAction(I_CmsListAction showAction)

Sets the show details Action.

Parameters:

showAction - the showdetails Action to set

setShowActionHelpText

public void setShowActionHelpText(org.opencms.i18n.CmsMessageContainer showActionHelp)

Sets the help text of the show action.

Parameters:

showActionHelp - the help text of the show action

setShowActionName

public void setShowActionName(org.opencms.i18n.CmsMessageContainer showActionName)

Sets the name of the show action.

Parameters:

showActionName - the name of the show action