org.opencms.workplace.list
Interface I_CmsListDirectAction

All Superinterfaces:
I_CmsHtmlIconButton, I_CmsListAction
All Known Implementing Classes:
A_CmsListDefaultJsAction, A_CmsListDirectJsAction, CmsListDefaultAction, CmsListDirectAction, CmsListEditResourceAction, CmsListExplorerDirectAction, CmsListItemSelectionAction, CmsListItemSelectionCustomAction, CmsListOpenResourceAction, CmsListResourceIconAction, CmsListResourceLockAction, CmsListResourceProjStateAction, CmsListResourceTypeIconAction, CmsRestoreStateAction

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.11 $
Author:
Michael Moossen

Method Summary
 java.lang.String confirmationTextHtml()
          Generates a confirmation text div tag, to use in lists where all items use the same confirmation text.
 java.lang.String getColumnForTexts()
          Returns the id of the column to use as parameter for the helptext and confirmation message.
 CmsListItem getItem()
          Returns the current item.
 java.lang.String helpTextHtml()
          Generates a help text div tag, to use in lists where all items use the same help text.
 void setColumnForTexts(java.lang.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
buttonHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp
 
Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton
buttonHtml, getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
 

Method Detail

confirmationTextHtml

java.lang.String confirmationTextHtml()
Generates a confirmation text div tag, to use in lists where all items use the same confirmation text.

Returns:
html code

getColumnForTexts

java.lang.String getColumnForTexts()
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

CmsListItem getItem()
Returns the current item.

Returns:
the current item

helpTextHtml

java.lang.String helpTextHtml()
Generates a help text div tag, to use in lists where all items use the same help text.

Returns:
html code

setColumnForTexts

void setColumnForTexts(java.lang.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

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