|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.tools.A_CmsHtmlIconButton
org.opencms.workplace.list.A_CmsListAction
public abstract class A_CmsListAction
The default skeleton for a list action.
Field Summary |
---|
Fields inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton |
---|
EMPTY_MESSAGE, m_id |
Constructor Summary | |
---|---|
A_CmsListAction(java.lang.String id)
Default Constructor. |
Method Summary | |
---|---|
java.lang.String |
buttonHtml()
The same using I_CmsListAction.getWp() . |
static java.lang.String |
defaultConfirmationHtml(java.lang.String confId,
java.lang.String confText)
Generates html for the confirmation message when having one confirmation message for several actions. |
CmsMessageContainer |
getConfirmationMessage()
Returns an optional confirmation message for the action. |
java.lang.String |
getListId()
Returns the id of the associated list. |
A_CmsListDialog |
getWp()
Returns the related workplace dialog object, to be able to access dynamic data. |
void |
setConfirmationMessage(CmsMessageContainer confirmationMsg)
Sets the confirmation message. |
void |
setListId(java.lang.String listId)
Sets the list id. |
void |
setWp(A_CmsListDialog wp)
Sets the workplace dialog object. |
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 |
---|
buttonHtml, getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible |
Constructor Detail |
---|
public A_CmsListAction(java.lang.String id)
id
- unique idMethod Detail |
---|
public static java.lang.String defaultConfirmationHtml(java.lang.String confId, java.lang.String confText)
confId
- the id of the confirmation messageconfText
- the confirmation message
public java.lang.String buttonHtml()
I_CmsListAction
I_CmsListAction.getWp()
.
buttonHtml
in interface I_CmsListAction
I_CmsListAction.buttonHtml()
public CmsMessageContainer getConfirmationMessage()
I_CmsListAction
It will be escaped for usage in java script code.
getConfirmationMessage
in interface I_CmsListAction
I_CmsListAction.getConfirmationMessage()
public java.lang.String getListId()
I_CmsListAction
getListId
in interface I_CmsListAction
I_CmsListAction.getListId()
public A_CmsListDialog getWp()
I_CmsListAction
getWp
in interface I_CmsListAction
I_CmsListAction.getWp()
public void setConfirmationMessage(CmsMessageContainer confirmationMsg)
I_CmsListAction
setConfirmationMessage
in interface I_CmsListAction
confirmationMsg
- the confirmation message to setI_CmsListAction.setConfirmationMessage(org.opencms.i18n.CmsMessageContainer)
public void setListId(java.lang.String listId)
I_CmsListAction
setListId
in interface I_CmsListAction
listId
- the id of the list to setI_CmsListAction.setListId(java.lang.String)
public void setWp(A_CmsListDialog wp)
I_CmsListAction
setWp
in interface I_CmsListAction
wp
- the workplace dialog objectI_CmsListAction.setWp(org.opencms.workplace.list.A_CmsListDialog)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |