org.opencms.workplace.list
Interface I_CmsListDirectAction

All Superinterfaces:

I_CmsHtmlIconButton, I_CmsListAction

All Known Implementing Classes:

CmsListDirectAction

public interface I_CmsListDirectAction

extends I_CmsListAction

Interface for list direct action, that is an action that may be applied directly on a list item.

Since:

6.0.0

Version:

$Revision: 1.8 $

Author:

Michael Moossen

Method Summary

String	confirmationTextHtml(CmsWorkplace wp) Generates a confirmation text div tag, to use in lists where all items use the same confirmation text.
String	getColumn() Returns the id of the column to use as parameter for the helptext and confirmation message.
CmsListItem	getItem() Returns the current item.
String	helpTextHtml(CmsWorkplace wp) Generates a help text div tag, to use in lists where all items use the same help text.
void	setColumn(String columnId) Sets the id of the column to use as parameter for the helptext and confirmation message.
void	setItem(CmsListItem item) Sets the current item, should be called before the I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace) method.

Methods inherited from interface org.opencms.workplace.list.I_CmsListAction

getConfirmationMessage, getListId, setConfirmationMessage, setListId

Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton

buttonHtml, getHelpText, getIconPath, getId, getName, isEnabled, setEnabled, setHelpText, setIconPath, setName

Method Detail

confirmationTextHtml

public String confirmationTextHtml(CmsWorkplace wp)

Generates a confirmation text div tag, to use in lists where all items use the same confirmation text.

Parameters:

wp - the workplace instance

Returns:

html code

getColumn

public String getColumn()

Returns the id of the column to use as parameter for the helptext and confirmation message.

Returns:

the id of the column to use

getItem

public CmsListItem getItem()

Returns the current item.

Returns:

the current item

helpTextHtml

public String helpTextHtml(CmsWorkplace wp)

Generates a help text div tag, to use in lists where all items use the same help text.

Parameters:

wp - the workplace instance

Returns:

html code

setColumn

public void setColumn(String columnId)

Sets the id of the column to use as parameter for the helptext and confirmation message.

Parameters:

columnId - the id of the column to use

setItem

public void setItem(CmsListItem item)

Sets the current item, should be called before the I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace) method.

Parameters:

item - the item