org.opencms.workplace.list
Class CmsListDefaultAction

java.lang.Object
  org.opencms.workplace.tools.A_CmsHtmlIconButton
      org.opencms.workplace.list.A_CmsListAction
          org.opencms.workplace.list.CmsListDirectAction
              org.opencms.workplace.list.CmsListDefaultAction

All Implemented Interfaces:

I_CmsListAction, I_CmsListDirectAction, I_CmsHtmlIconButton

Direct Known Subclasses:

A_CmsListDefaultJsAction, CmsRestoreStateAction

public class CmsListDefaultAction
extends CmsListDirectAction

Implementation of a default action in a html list column.

Since:

6.0.0

Field Summary

Fields inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton

EMPTY_MESSAGE, m_id

Constructor Summary

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

Method Summary

java.lang.String	getColumnForLink() Resturns the id of column to use for the link.
I_CmsListFormatter	getColumnFormatter() Resturns the formatter to use for the link.
protected CmsHtmlIconButtonStyleEnum	resolveButtonStyle() Help method to resolve the style of the button.
protected java.lang.String	resolveName(java.util.Locale locale) Help method to resolve the name to use.
void	setColumnForLink(CmsListColumnDefinition columnForLink) Sets the id of column to use for the link.

Methods inherited from class org.opencms.workplace.list.CmsListDirectAction

buttonHtml, confirmationTextHtml, getColumnForTexts, getItem, helpTextHtml, resolveHelpText, resolveOnClic, setColumnForTexts, setItem

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.list.I_CmsListAction

buttonHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp

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

getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible

Constructor Detail

CmsListDefaultAction

public CmsListDefaultAction(java.lang.String id)

Default Constructor.

Parameters:

id - unique id

Method Detail

getColumnForLink

public java.lang.String getColumnForLink()

Resturns the id of column to use for the link.

Returns:

the id of column to use for the link

getColumnFormatter

public I_CmsListFormatter getColumnFormatter()

Resturns the formatter to use for the link.

Returns:

the formatter to use for the link

setColumnForLink

public void setColumnForLink(CmsListColumnDefinition columnForLink)

Sets the id of column to use for the link.

Parameters:

columnForLink - the column to use for the link to set

resolveButtonStyle

protected CmsHtmlIconButtonStyleEnum resolveButtonStyle()

Description copied from class: CmsListDirectAction

Help method to resolve the style of the button.

Overrides:

resolveButtonStyle in class CmsListDirectAction

Returns:

the style of the button

See Also:

CmsListDirectAction.resolveButtonStyle()

resolveName

protected java.lang.String resolveName(java.util.Locale locale)

Description copied from class: CmsListDirectAction

Help method to resolve the name to use.

Overrides:

resolveName in class CmsListDirectAction

Parameters:

locale - the used locale

Returns:

the name

See Also:

CmsListDirectAction.resolveName(java.util.Locale)