org.opencms.workplace.list
Class CmsListOpenResourceAction

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
                  org.opencms.workplace.list.A_CmsListDefaultJsAction
                      org.opencms.workplace.list.CmsListOpenResourceAction

All Implemented Interfaces:

I_CmsListAction, I_CmsListDirectAction, I_CmsHtmlIconButton

public class CmsListOpenResourceAction
extends A_CmsListDefaultJsAction

Opens the selected resource in a new window.

Be sure your list updates the cms context, overriding the A_CmsListDialog.getList() method, like:

       // assure we have the right cms
       CmsHtmlList list = super.getList();
       if (list != null) {
           CmsListColumnDefinition col = list.getMetadata().getColumnDefinition(LIST_COLUMN_NAME);
           if (col != null) {
               ((CmsListOpenResourceAction)col.getDefaultAction(LIST_DEFACTION_OPEN)).setCms(getCms());
           }
       }
       return list;
 

Since:

6.0.0

Version:

$Revision: 1.2 $

Author:

Michael Moossen

Field Summary

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

EMPTY_MESSAGE, m_id

Constructor Summary

CmsListOpenResourceAction(String id, CmsObject cms, String resColumnPathId)
Default Constructor.

Method Summary

CmsMessageContainer	getHelpText() Returns the help text.
boolean	isEnabled() Returns if enabled or disabled.
String	jsCode() The js code to execute.
void	setCms(CmsObject cms) Sets the cms context.

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

resolveOnClic

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

resolveButtonStyle, resolveName, setColumnForLink

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

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

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

defaultConfirmationHtml, getConfirmationMessage, getListId, setConfirmationMessage, setListId

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

defaultButtonHtml, defaultButtonHtml, defaultHelpHtml, getIconPath, getId, getName, 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

getConfirmationMessage, getListId, setConfirmationMessage, setListId

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

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

Constructor Detail

CmsListOpenResourceAction

public CmsListOpenResourceAction(String id,
                                 CmsObject cms,
                                 String resColumnPathId)

Default Constructor.

Parameters:

id - the unique id

cms - the cms context

resColumnPathId - the id of the column with the resource root path

Method Detail

getHelpText

public CmsMessageContainer getHelpText()

Description copied from interface: I_CmsHtmlIconButton

Returns the help text.

Specified by:

getHelpText in interface I_CmsHtmlIconButton

Overrides:

getHelpText in class A_CmsHtmlIconButton

Returns:

the help text

See Also:

I_CmsHtmlIconButton.getHelpText()

isEnabled

public boolean isEnabled()

Description copied from interface: I_CmsHtmlIconButton

Returns if enabled or disabled.

Specified by:

isEnabled in interface I_CmsHtmlIconButton

Overrides:

isEnabled in class A_CmsHtmlIconButton

Returns:

if enabled or disabled

See Also:

I_CmsHtmlIconButton.isEnabled()

jsCode

public String jsCode()

Description copied from class: A_CmsListDefaultJsAction

The js code to execute.

Specified by:

jsCode in class A_CmsListDefaultJsAction

Returns:

js code to execute

See Also:

A_CmsListDefaultJsAction.jsCode()

setCms

public void setCms(CmsObject cms)

Sets the cms context.

Parameters:

cms - the cms context to set