Package org.opencms.workplace.list
Class CmsListDirectAction
- java.lang.Object
-
- org.opencms.workplace.tools.A_CmsHtmlIconButton
-
- org.opencms.workplace.list.A_CmsListAction
-
- org.opencms.workplace.list.CmsListDirectAction
-
- All Implemented Interfaces:
I_CmsListAction
,I_CmsListDirectAction
,org.opencms.workplace.tools.I_CmsHtmlIconButton
- Direct Known Subclasses:
A_CmsListDirectJsAction
,CmsChangeLogLevelAction
,CmsListDefaultAction
,CmsListEditResourceAction
,CmsListExplorerDirectAction
,CmsListItemSelectionAction
,CmsListResourceIconAction
public class CmsListDirectAction extends A_CmsListAction implements I_CmsListDirectAction
Default implementation of a direct action for a html list column.- Since:
- 6.0.0
-
-
Constructor Summary
Constructors Constructor Description CmsListDirectAction(java.lang.String id)
Default Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
buttonHtml(org.opencms.workplace.CmsWorkplace wp)
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.protected org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum
resolveButtonStyle()
Help method to resolve the style of the button.protected java.lang.String
resolveHelpText(java.util.Locale locale)
Help method to resolve the help text to use.protected java.lang.String
resolveName(java.util.Locale locale)
Help method to resolve the name to use.protected java.lang.String
resolveOnClic(java.util.Locale locale)
Help method to resolve the on clic text to use.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
method.I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace)
-
Methods inherited from class org.opencms.workplace.list.A_CmsListAction
buttonHtml, defaultConfirmationHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp
-
Methods inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton
defaultButtonHtml, defaultButtonHtml, defaultHelpHtml, getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton
getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
-
Methods inherited from interface org.opencms.workplace.list.I_CmsListAction
buttonHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp
-
-
-
-
Constructor Detail
-
CmsListDirectAction
public CmsListDirectAction(java.lang.String id)
Default Constructor.- Parameters:
id
- unique id
-
-
Method Detail
-
resolveHelpText
protected java.lang.String resolveHelpText(java.util.Locale locale)
Help method to resolve the help text to use.- Parameters:
locale
- the used locale- Returns:
- the help text
-
resolveOnClic
protected java.lang.String resolveOnClic(java.util.Locale locale)
Help method to resolve the on clic text to use.- Parameters:
locale
- the used locale- Returns:
- the on clic text
-
resolveName
protected java.lang.String resolveName(java.util.Locale locale)
Help method to resolve the name to use.- Parameters:
locale
- the used locale- Returns:
- the name
-
resolveButtonStyle
protected org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum resolveButtonStyle()
Help method to resolve the style of the button.- Returns:
- the style of the button
-
buttonHtml
public java.lang.String buttonHtml(org.opencms.workplace.CmsWorkplace wp)
- Specified by:
buttonHtml
in interfaceorg.opencms.workplace.tools.I_CmsHtmlIconButton
- See Also:
I_CmsHtmlIconButton.buttonHtml(CmsWorkplace)
-
confirmationTextHtml
public java.lang.String confirmationTextHtml()
Description copied from interface:I_CmsListDirectAction
Generates a confirmation text div tag, to use in lists where all items use the same confirmation text.- Specified by:
confirmationTextHtml
in interfaceI_CmsListDirectAction
- Returns:
- html code
- See Also:
I_CmsListDirectAction.confirmationTextHtml()
-
getColumnForTexts
public java.lang.String getColumnForTexts()
Description copied from interface:I_CmsListDirectAction
Returns the id of the column to use as parameter for the helptext and confirmation message.- Specified by:
getColumnForTexts
in interfaceI_CmsListDirectAction
- Returns:
- the id of the column to use
- See Also:
I_CmsListDirectAction.getColumnForTexts()
-
getItem
public CmsListItem getItem()
Description copied from interface:I_CmsListDirectAction
Returns the current item.- Specified by:
getItem
in interfaceI_CmsListDirectAction
- Returns:
- the current item
- See Also:
I_CmsListDirectAction.getItem()
-
helpTextHtml
public java.lang.String helpTextHtml()
Description copied from interface:I_CmsListDirectAction
Generates a help text div tag, to use in lists where all items use the same help text.- Specified by:
helpTextHtml
in interfaceI_CmsListDirectAction
- Returns:
- html code
- See Also:
I_CmsListDirectAction.helpTextHtml()
-
setColumnForTexts
public void setColumnForTexts(java.lang.String columnId)
Description copied from interface:I_CmsListDirectAction
Sets the id of the column to use as parameter for the helptext and confirmation message.- Specified by:
setColumnForTexts
in interfaceI_CmsListDirectAction
- Parameters:
columnId
- the id of the column to use- See Also:
I_CmsListDirectAction.setColumnForTexts(java.lang.String)
-
setItem
public void setItem(CmsListItem item)
Description copied from interface:I_CmsListDirectAction
Sets the current item, should be called before the
method.I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace)
- Specified by:
setItem
in interfaceI_CmsListDirectAction
- Parameters:
item
- the item- See Also:
I_CmsListDirectAction.setItem(org.opencms.workplace.list.CmsListItem)
-
-