org.opencms.workplace.list
Class CmsListItemSelectionCustomAction

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

All Implemented Interfaces:

I_CmsListAction, I_CmsListDirectAction, I_CmsHtmlIconButton

public class CmsListItemSelectionCustomAction
extends CmsListItemSelectionAction

Implementation of a list item selection action where to define name and the column with the value.

Since:

6.7.2

Field Summary

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

EMPTY_MESSAGE, m_id

Constructor Summary

CmsListItemSelectionCustomAction(java.lang.String id, java.lang.String columnValue)
Default Constructor.

CmsListItemSelectionCustomAction(java.lang.String id, java.lang.String name, java.lang.String columnValue)
Default Constructor.

Method Summary

java.lang.String	buttonHtml(CmsWorkplace wp) Returns the necessary html code.
java.lang.String	getAttributes() Returns the attributes.
java.lang.String	getColumn() Returns the column.
java.lang.String	getFieldName() Returns the fieldName.
void	setAttributes(java.lang.String attributes) Sets the attributes.
void	setColumn(java.lang.String column) Sets the column.
void	setFieldName(java.lang.String fieldName) Sets the fieldName.

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

getMultiActionId, getSelectedItemId, setSelectedItemId

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

confirmationTextHtml, getColumnForTexts, getItem, helpTextHtml, resolveButtonStyle, resolveHelpText, resolveName, 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

CmsListItemSelectionCustomAction

public CmsListItemSelectionCustomAction(java.lang.String id,
                                        java.lang.String columnValue)

Default Constructor.

Parameters:

id - the unique id

columnValue - the name of the column used for the value

CmsListItemSelectionCustomAction

public CmsListItemSelectionCustomAction(java.lang.String id,
                                        java.lang.String name,
                                        java.lang.String columnValue)

Default Constructor.

Parameters:

id - the unique id

name - the name of the input field

columnValue - the name of the column used for the value

Method Detail

buttonHtml

public java.lang.String buttonHtml(CmsWorkplace wp)

Description copied from interface: I_CmsHtmlIconButton

Returns the necessary html code.

Specified by:

buttonHtml in interface I_CmsHtmlIconButton

Overrides:

buttonHtml in class CmsListItemSelectionAction

Parameters:

wp - the jsp page to write the code to

Returns:

html code

See Also:

I_CmsHtmlIconButton.buttonHtml(CmsWorkplace)

getAttributes

public java.lang.String getAttributes()

Returns the attributes.

Returns:

the attributes

getColumn

public java.lang.String getColumn()

Returns the column.

Returns:

the column

getFieldName

public java.lang.String getFieldName()

Returns the fieldName.

Returns:

the fieldName

setAttributes

public void setAttributes(java.lang.String attributes)

Sets the attributes.

Parameters:

attributes - the attributes to set

setColumn

public void setColumn(java.lang.String column)

Sets the column.

Parameters:

column - the column to set

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the fieldName.

Parameters:

fieldName - the fieldName to set