Class CmsListResourceIconAction

    • Constructor Detail

      • CmsListResourceIconAction

        public CmsListResourceIconAction​(java.lang.String id,
                                         java.lang.String resColumnTypeId,
                                         org.opencms.file.CmsObject cms)
        Default Constructor.

        Parameters:
        id - the unique id
        resColumnTypeId - the id of the column with the resource type
        cms - the cms context
    • Method Detail

      • getCms

        public org.opencms.file.CmsObject getCms()
        Returns the cms context.

        Returns:
        the cms context
      • getIconPath

        public java.lang.String getIconPath()
        Specified by:
        getIconPath in interface org.opencms.workplace.tools.I_CmsHtmlIconButton
        Overrides:
        getIconPath in class org.opencms.workplace.tools.A_CmsHtmlIconButton
        See Also:
        A_CmsHtmlIconButton.getIconPath()
      • defButtonHtml

        protected java.lang.String defButtonHtml​(org.opencms.file.CmsObject cms,
                                                 java.lang.String id,
                                                 java.lang.String helpId,
                                                 java.lang.String name,
                                                 java.lang.String helpText,
                                                 boolean enabled,
                                                 java.lang.String iconPath,
                                                 java.lang.String confirmationMessage,
                                                 java.lang.String onClick,
                                                 boolean singleHelp)
        Generates a default html code where several buttons can have the same help text.

        the only diff to A_CmsHtmlIconButton.defaultButtonHtml(org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String) is that the icons are 16x16.

        Parameters:
        cms - the cms context, can be null
        id - the id
        helpId - the id of the helptext div tag
        name - the name, if empty only the icon is displayed
        helpText - the help text, if empty no mouse events are generated
        enabled - if enabled or not, if not set be sure to take an according helptext
        iconPath - the path to the icon, if empty only the name is displayed
        onClick - the js code to execute, if empty no link is generated
        confirmationMessage - the confirmation message
        singleHelp - if set, no helptext is written, you have to use the defaultHelpHtml() method later
        Returns:
        html code
        See Also:
        A_CmsHtmlIconButton.defaultButtonHtml(org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String)