Class CmsHtmlWidgetOption


  • public class CmsHtmlWidgetOption
    extends java.lang.Object
    An option of a HTML type widget.

    Options can be defined for each element of the type OpenCmsHtml using the widget HtmlWidget. They have to be placed in the annotation section of a XSD describing an XML content. The configuration attribute in the layout node for the element must contain the activated options as a comma separated String value:

    Available options are:

    • anchor: the anchor dialog button
    • buttonbar:${button bar items, separated by ';'}: an individual button bar configuration, see BUTTONBAR_DEFAULT for an example.
    • css:/vfs/path/to/cssfile.css: the absolute path in the OpenCms VFS to the CSS style sheet to use to render the contents in the editor (availability depends on the integrated editor)
    • formatselect: the format selector for selecting text format like paragraph or headings
    • formatselect.options:${list of options, separated by ';'}: the options that should be available in the format selector, e.g. formatselect.options:p;h1;h2
    • fullpage: the editor creates an entire HTML page code
    • ${gallerytype}: Shows a gallery dialog button, e.g. imagegallery displays the image gallery button or downloadgallery displays the download gallery button
    • height:${editorheight}: the editor height, where the height can be specified in px or %, e.g. 400px
    • hidebuttons:${list of buttons to hide, separated by ';'}: the buttons to hide that usually appear in the default button bar, e.g. hidebuttons:bold;italic;underline;strikethrough hides some formatting buttons
    • image: the image dialog button (availability depends on the integrated editor)
    • link: the link dialog button
    • source: shows the source code toggle button(s)
    • stylesxml:/vfs/path/to/stylefile.xml: the absolute path in the OpenCms VFS to the user defined styles that should be displayed in the style selector (availability depends on the integrated editor)
    • stylesformat:/vfs/path/to/stylefile.xml: the absolute path in the OpenCms VFS to the user defined styles format that should be displayed in the style selector (availability depends on the integrated editor)
    • table: the table dialog button (availability depends on the integrated editor)
    Some things like the button bar items should be defined in the global widget configuration of the file opencms-vfs.xml.

    Since:
    6.0.1
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String BUTTONBAR_BLOCK_END
      The button bar end block indicator.
      static java.lang.String BUTTONBAR_BLOCK_START
      The button bar start block indicator.
      static java.lang.String BUTTONBAR_DEFAULT
      The default editor widget button bar configuration.
      static java.util.List<java.lang.String> BUTTONBAR_DEFAULT_LIST
      The default button bar configuration as List.
      static java.lang.String BUTTONBAR_SEPARATOR
      The button bar separator.
      static java.lang.String DELIMITER_OPTION
      The delimiter to use in the configuration String.
      static char DELIMITER_VALUE
      The delimiter to use for separation of option values.
      static java.lang.String EDITOR_DEFAULMAXTHEIGHT
      The editor widget default maximum height to use.
      static java.lang.String OPTION_ABBR
      Option for the "abbreviation" button.
      static java.lang.String OPTION_ABSOLUTE
      Option for the "absolute" button.
      static java.lang.String OPTION_ACRONYM
      Option for the "acronym" button.
      static java.lang.String OPTION_ADVHR
      Option for the "advanced hr" button.
      static java.lang.String OPTION_ALLOWSCRIPTS
      Allow scripts in source code editor.
      static java.lang.String OPTION_ANCHOR
      Option for the "anchor" dialog.
      static java.lang.String OPTION_ATTRIBS
      Option for the "insert/edit attributes" button.
      static java.lang.String OPTION_BACKCOLOR
      Option for the "background color" button.
      static java.lang.String OPTION_BLOCKQUOTE
      Option for the "block quote" button.
      static java.lang.String OPTION_BUTTONBAR
      Option for the "buttonbar" configuration.
      static java.lang.String OPTION_CITE
      Option for the "citation" button.
      static java.lang.String OPTION_CLEANUP
      Option for the "clean up messy code" button.
      static java.lang.String OPTION_CSS
      Option for the css style sheet VFS path to use in the widget area.
      static java.lang.String OPTION_DEL
      Option for the "mark text as deletion" button.
      static java.lang.String OPTION_EDITORCONFIG
      If this is set, the contents of the path following the ':' will be interpreted as JSON and passed to TinyMCE directly.
      static java.lang.String OPTION_EDITORLINK
      Option for the "editor link" dialog (editor specific).
      static java.lang.String OPTION_EMOTIONS
      Option for the "emotions" button.
      static java.lang.String OPTION_FIND
      Option for the "find" dialog.
      static java.lang.String OPTION_FONTSELECT
      Option for the "font select" button.
      static java.lang.String OPTION_FONTSIZESELECT
      Option for the "font size" button.
      static java.lang.String OPTION_FORECOLOR
      Option for the "text color" button.
      static java.lang.String OPTION_FORMATSELECT
      Option for the "formatselect" selector.
      static java.lang.String OPTION_FORMATSELECT_OPTIONS
      Option for the "formatselect" options selector.
      static java.lang.String OPTION_FULLPAGE
      Option for the "fullpage" editor variant.
      static java.lang.String OPTION_HEIGHT
      Option for the "height" configuration.
      static java.lang.String OPTION_HIDEBUTTONS
      Option for the "hidebuttons" configuration.
      static java.lang.String OPTION_HR
      Option for the "hr" button.
      static java.lang.String OPTION_IMAGE
      Option for the "image" dialog.
      static java.lang.String OPTION_IMPORTCSS
      Option to import styles from stylesheet into the style selector.
      static java.lang.String OPTION_INS
      Option for the "mark text as insertion" button.
      static java.lang.String OPTION_INSERTDATE
      Option for the "insert date" button.
      static java.lang.String OPTION_INSERTLAYER
      Option for the "insert layer" button.
      static java.lang.String OPTION_INSERTTIME
      Option for the "insert time" button.
      static java.lang.String OPTION_LINK
      Option for the "link" dialog.
      static java.lang.String OPTION_LINKDEFAULTPROTOCOL
      Option for the default protocol for links
      static java.lang.String OPTION_LTR
      Option for the "left to right text" button.
      static java.lang.String OPTION_MEDIA
      Option for the "insert media (flash, video, audio)" button.
      static java.lang.String OPTION_MOVEBACKWARD
      Option for the "move backward (layer context)" button.
      static java.lang.String OPTION_MOVEFORWARD
      Option for the "move forward (layer context)" button.
      static java.lang.String OPTION_NEWDOCUMENT
      Option for the "new document (remove existing content)" button.
      static java.lang.String OPTION_NONBREAKING
      Option for the "non breaking white space" button.
      static java.lang.String OPTION_PAGEBREAK
      Option for the "page break" button.
      static java.lang.String OPTION_PASTEWORD
      Option for the "paste from word" button.
      static java.lang.String OPTION_PRINT
      Option for the "print" button.
      static java.lang.String OPTION_REPLACE
      Option for the "replace" dialog.
      static java.lang.String OPTION_RTL
      Option for the "right to left text" button.
      static java.lang.String OPTION_SOURCE
      Option for the "source" code mode.
      static java.lang.String OPTION_SPECIALCHAR
      Option for the "special char dialog" button.
      static java.lang.String OPTION_SPELLCHECK
      Option for the "spell check" dialog.
      static java.lang.String OPTION_STYLE
      Option for the style select box.
      static java.lang.String OPTION_STYLEPROPS
      Option for the "edit CSS style" button.
      static java.lang.String OPTION_STYLES
      Option for the styles XML VFS path to use in the widget area.
      static java.lang.String OPTION_STYLES_FORMAT
      Option for the styles format VFS path to use in the widget area.
      static java.lang.String OPTION_TABLE
      Option for the "table" dialog.
      static java.lang.String OPTION_TEMPLATE
      Option for the "insert predefined template content" button.
      static java.lang.String OPTION_UNLINK
      Option for the "unlink" button.
      static java.lang.String OPTION_VISUALAID
      Option for the "show/hide guidelines/invisible elements" button.
      static java.lang.String OPTION_VISUALCHARS
      Option for the "show/hide visual control characters" button.
      static java.lang.String[] OPTIONAL_BUTTONS
      The optional buttons that can be additionally added to the button bar.
      static java.util.List<java.lang.String> OPTIONAL_BUTTONS_LIST
      The optional buttons that can be additionally added to the button bar as list.
      static java.util.regex.Pattern PATTERN_EMBEDDED_GALLERY_CONFIG
      Pattern used for matching embedded gallery configurations.
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsHtmlWidgetOption()
      Creates a new empty HTML widget object object.
      CmsHtmlWidgetOption​(java.lang.String configuration)
      Creates a new HTML widget object object, configured by the given configuration String.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addAdditionalButton​(java.lang.String buttonName)
      Adds a button to the list of defined additional buttons.
      static java.lang.String createConfigurationString​(CmsHtmlWidgetOption option)
      Returns a HTML widget configuration String created from the given HTML widget option.
      java.util.List<java.lang.String> getAdditionalButtons()
      Returns the buttons to show additionally as list with button names.
      java.lang.String getButtonBar​(java.util.Map<java.lang.String,​java.lang.String> buttonNamesLookUp, java.lang.String itemSeparator)
      Returns the specific editor button bar string generated from the configuration.
      java.lang.String getButtonBar​(java.util.Map<java.lang.String,​java.lang.String> buttonNamesLookUp, java.lang.String itemSeparator, boolean addMissingBlock)
      Returns the specific editor button bar string generated from the configuration.
      java.util.List<java.lang.String> getButtonBarOption()
      Returns the individual button bar configuration option.
      java.lang.String getButtonBarOptionString()
      Returns the individual button bar configuration option string.
      java.util.List<java.lang.String> getButtonBarShownItems()
      Returns the calculated button bar items, including blocks and separators, considering the current widget configuration.
      protected java.lang.String getButtonName​(java.lang.String barItem, java.util.Map<java.lang.String,​java.lang.String> buttonNamesLookUp)
      Returns the real button name matched with the look up map.
      java.lang.String getConfiguration()
      Returns the original configuration String that was used to initialize the HTML widget options.
      java.lang.String getCssPath()
      Returns the CSS style sheet VFS path to use in the widget area.
      java.lang.String getEditorConfigPath()
      Gets the path of a JSON file containing options to be passed directly into TinyMCE.
      java.lang.String getEditorHeight()
      Returns the widget editor height.
      java.util.Map<java.lang.String,​java.lang.String> getEmbeddedConfigurations()
      Gets the embedded gallery configurations.
      java.lang.String getFormatSelectOptions()
      Returns the options for the format select box as String.
      java.util.List<java.lang.String> getHiddenButtons()
      Returns the buttons to hide as list with button names.
      java.lang.String getLinkDefaultProtocol()
      Returns the link default protocol to use when inserting/editing links via the link dialog.
      java.lang.String getStylesFormatPath()
      Returns the styles format VFS path to use in the widget area.
      java.lang.String getStylesXmlPath()
      Returns the styles XML VFS path to use in the widget area.
      void init​(java.lang.String configuration)
      Initializes the widget options from the given configuration String.
      boolean isAllowScripts()
      Returns true if scripts should be allowed in the source code editor.
      boolean isButtonAdditional​(java.lang.String buttonName)
      Returns if the button with the given name should be additionally shown.
      boolean isButtonHidden​(java.lang.String buttonName)
      Returns if the button with the given name should be hidden.
      boolean isButtonOptional​(java.lang.String buttonName)
      Returns if the button with the given name is optional.
      boolean isFullPage()
      Returns if the editor should be used in full page mode.
      boolean isImportCss()
      Return true if the content stylesheet's styles should be imported into the style selector.
      static CmsPair<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> parseEmbeddedGalleryOptions​(java.lang.String configuration)
      Parses and removes embedded gallery configuration strings.
      protected void parseOptions​(java.lang.String configuration)
      Parses the given configuration String.
      void setAdditionalButtons​(java.util.List<java.lang.String> buttons)
      Sets the buttons to show additionally as list with button names.
      void setButtonBarOption​(java.util.List<java.lang.String> buttonBar)
      Sets the individual button bar configuration option.
      void setButtonBarOptionString​(java.lang.String buttonBar)
      Sets the individual button bar configuration option string.
      void setCssPath​(java.lang.String cssPath)
      Sets the CSS style sheet VFS path to use in the widget area.
      void setEditorConfigPath​(java.lang.String optionJsonPath)
      Sets the path for a file containing JSON options to be passed directly into TinyMCE.
      void setEditorHeight​(java.lang.String editorHeight)
      Sets the widget editor height.
      void setFormatSelectOptions​(java.lang.String formatSelectOptions)
      Sets the options for the format select box as String.
      void setFullPage​(boolean fullPage)
      Sets if the editor should be used in full page mode.
      void setHiddenButtons​(java.util.List<java.lang.String> buttons)
      Sets the buttons to hide as list with button names.
      void setLinkDefaultProtocol​(java.lang.String linkDefaultProtocol)
      Set the link default protocol to use when inserting/editing links via the link dialog
      void setStylesFormatPath​(java.lang.String stylesFormatPath)
      Sets the styles format VFS path to use in the widget area.
      void setStylesXmlPath​(java.lang.String stylesXmlPath)
      Sets the styles XML VFS path to use in the widget area.
      boolean showAnchorDialog()
      Returns true if the anchor dialog button should be available.
      boolean showFormatSelect()
      Returns true if the format selector should be available.
      boolean showGalleryDialog​(java.lang.String galleryType)
      Returns true if the specified gallery type dialog button is shown.
      boolean showImageDialog()
      Returns true if the image dialog button should be available.
      boolean showLinkDialog()
      Returns true if the link dialog button should be available.
      boolean showSourceEditor()
      Returns true if the source code button should be available.
      boolean showStylesFormat()
      Returns true if the styles format selector should be available.
      boolean showStylesXml()
      Returns true if the styles selector should be available.
      boolean showTableDialog()
      Returns true if the table dialog button should be available.
      boolean useCss()
      Returns true if the widget editor should use a defined CSS style sheet.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CmsHtmlWidgetOption

        public CmsHtmlWidgetOption()
        Creates a new empty HTML widget object object.

      • CmsHtmlWidgetOption

        public CmsHtmlWidgetOption​(java.lang.String configuration)
        Creates a new HTML widget object object, configured by the given configuration String.

        Parameters:
        configuration - configuration String to parse
    • Method Detail

      • createConfigurationString

        public static java.lang.String createConfigurationString​(CmsHtmlWidgetOption option)
        Returns a HTML widget configuration String created from the given HTML widget option.

        Parameters:
        option - the HTML widget options to create the configuration String for
        Returns:
        a select widget configuration String created from the given HTML widget option object
      • parseEmbeddedGalleryOptions

        public static CmsPair<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> parseEmbeddedGalleryOptions​(java.lang.String configuration)
        Parses and removes embedded gallery configuration strings.
        Parameters:
        configuration - the configuration string to parse
        Returns:
        a map containing both the string resulting from removing the embedded configurations, and the embedded configurations as a a map
      • getAdditionalButtons

        public java.util.List<java.lang.String> getAdditionalButtons()
        Returns the buttons to show additionally as list with button names.

        Returns:
        the buttons to show additionally as list with button names
      • getButtonBar

        public java.lang.String getButtonBar​(java.util.Map<java.lang.String,​java.lang.String> buttonNamesLookUp,
                                             java.lang.String itemSeparator)
        Returns the specific editor button bar string generated from the configuration.

        The lookup map can contain translations for the button names, the separator and the block names. The button bar will be automatically surrounded by block start and end items if they are not explicitly defined.

        It may be necessary to write your own method to generate the button bar string for a specific editor widget. In this case, use the method getButtonBarShownItems() to get the calculated list of shown button bar items.

        Parameters:
        buttonNamesLookUp - the lookup map with translations for the button names, the separator and the block names or null
        itemSeparator - the separator for the tool bar items
        Returns:
        the button bar string generated from the configuration
      • getButtonBar

        public java.lang.String getButtonBar​(java.util.Map<java.lang.String,​java.lang.String> buttonNamesLookUp,
                                             java.lang.String itemSeparator,
                                             boolean addMissingBlock)
        Returns the specific editor button bar string generated from the configuration.

        The lookup map can contain translations for the button names, the separator and the block names.

        It may be necessary to write your own method to generate the button bar string for a specific editor widget. In this case, use the method getButtonBarShownItems() to get the calculated list of shown button bar items.

        Parameters:
        buttonNamesLookUp - the lookup map with translations for the button names, the separator and the block names or null
        itemSeparator - the separator for the tool bar items
        addMissingBlock - flag indicating if the button bar should be automatically surrounded by a block if not explicitly defined
        Returns:
        the button bar string generated from the configuration
      • getButtonBarOption

        public java.util.List<java.lang.String> getButtonBarOption()
        Returns the individual button bar configuration option.

        Returns:
        the individual button bar configuration option
      • getButtonBarOptionString

        public java.lang.String getButtonBarOptionString()
        Returns the individual button bar configuration option string.

        Returns:
        the individual button bar configuration option string
      • getButtonBarShownItems

        public java.util.List<java.lang.String> getButtonBarShownItems()
        Returns the calculated button bar items, including blocks and separators, considering the current widget configuration.

        Use this method to get the calculated list of button bar items if getButtonBar(Map, String) can not be used for a specific editor widget.

        Returns:
        the calculated button bar items
      • getConfiguration

        public java.lang.String getConfiguration()
        Returns the original configuration String that was used to initialize the HTML widget options.

        Returns:
        the original configuration String
      • getCssPath

        public java.lang.String getCssPath()
        Returns the CSS style sheet VFS path to use in the widget area.

        Returns:
        the CSS style sheet VFS path to use in the widget area
      • getEditorConfigPath

        public java.lang.String getEditorConfigPath()
        Gets the path of a JSON file containing options to be passed directly into TinyMCE.
        Returns:
        the path of a JSON with direct TinyMCE options
      • getEditorHeight

        public java.lang.String getEditorHeight()
        Returns the widget editor height.

        Returns:
        the widget editor height
      • getEmbeddedConfigurations

        public java.util.Map<java.lang.String,​java.lang.String> getEmbeddedConfigurations()
        Gets the embedded gallery configurations.

        Returns:
        the embedded gallery configurations
      • getFormatSelectOptions

        public java.lang.String getFormatSelectOptions()
        Returns the options for the format select box as String.

        Returns:
        the options for the format select box as String
      • getHiddenButtons

        public java.util.List<java.lang.String> getHiddenButtons()
        Returns the buttons to hide as list with button names.

        Returns:
        the buttons to hide as list with button names
      • getLinkDefaultProtocol

        public java.lang.String getLinkDefaultProtocol()
        Returns the link default protocol to use when inserting/editing links via the link dialog.
        Returns:
        the link default protocol to use when inserting/editing links via the link dialog
      • getStylesFormatPath

        public java.lang.String getStylesFormatPath()
        Returns the styles format VFS path to use in the widget area.

        Returns:
        the styles XML format path to use in the widget area
      • getStylesXmlPath

        public java.lang.String getStylesXmlPath()
        Returns the styles XML VFS path to use in the widget area.

        Returns:
        the styles XML VFS path to use in the widget area
      • init

        public void init​(java.lang.String configuration)
        Initializes the widget options from the given configuration String.

        Parameters:
        configuration - the configuration String
      • isAllowScripts

        public boolean isAllowScripts()
        Returns true if scripts should be allowed in the source code editor.

        Returns:
        true if scripts should be allowed in the source code editor
      • isButtonAdditional

        public boolean isButtonAdditional​(java.lang.String buttonName)
        Returns if the button with the given name should be additionally shown.

        Parameters:
        buttonName - the button name to check
        Returns:
        true if the button with the given name should be additionally shown, otherwise false
      • isButtonHidden

        public boolean isButtonHidden​(java.lang.String buttonName)
        Returns if the button with the given name should be hidden.

        Parameters:
        buttonName - the button name to check
        Returns:
        true if the button with the given name should be hidden, otherwise false
      • isButtonOptional

        public boolean isButtonOptional​(java.lang.String buttonName)
        Returns if the button with the given name is optional.

        Parameters:
        buttonName - the button name to check
        Returns:
        true if the button with the given name is optional, otherwise false
      • isFullPage

        public boolean isFullPage()
        Returns if the editor should be used in full page mode.

        Returns:
        true if the editor should be used in full page mode, otherwise false
      • isImportCss

        public boolean isImportCss()
        Return true if the content stylesheet's styles should be imported into the style selector.

        Returns:
        true if the content stylesheet's styles should be imported into the style selector
      • setAdditionalButtons

        public void setAdditionalButtons​(java.util.List<java.lang.String> buttons)
        Sets the buttons to show additionally as list with button names.

        Parameters:
        buttons - the buttons to show additionally as list with button names
      • setButtonBarOption

        public void setButtonBarOption​(java.util.List<java.lang.String> buttonBar)
        Sets the individual button bar configuration option.

        Parameters:
        buttonBar - the individual button bar configuration option
      • setButtonBarOptionString

        public void setButtonBarOptionString​(java.lang.String buttonBar)
        Sets the individual button bar configuration option string.

        Parameters:
        buttonBar - the individual button bar configuration option string
      • setCssPath

        public void setCssPath​(java.lang.String cssPath)
        Sets the CSS style sheet VFS path to use in the widget area.

        Parameters:
        cssPath - the CSS style sheet VFS path to use in the widget area
      • setEditorConfigPath

        public void setEditorConfigPath​(java.lang.String optionJsonPath)
        Sets the path for a file containing JSON options to be passed directly into TinyMCE.
        Parameters:
        optionJsonPath - the path of a JSON file
      • setEditorHeight

        public void setEditorHeight​(java.lang.String editorHeight)
        Sets the widget editor height.

        Parameters:
        editorHeight - the widget editor height
      • setFormatSelectOptions

        public void setFormatSelectOptions​(java.lang.String formatSelectOptions)
        Sets the options for the format select box as String.

        Parameters:
        formatSelectOptions - the options for the format select box as String
      • setFullPage

        public void setFullPage​(boolean fullPage)
        Sets if the editor should be used in full page mode.

        Parameters:
        fullPage - true if the editor should be used in full page mode, otherwise false
      • setHiddenButtons

        public void setHiddenButtons​(java.util.List<java.lang.String> buttons)
        Sets the buttons to hide as list with button names.

        Parameters:
        buttons - the buttons to hide as list with button names
      • setLinkDefaultProtocol

        public void setLinkDefaultProtocol​(java.lang.String linkDefaultProtocol)
        Set the link default protocol to use when inserting/editing links via the link dialog
        Parameters:
        linkDefaultProtocol - the link default protocol to use when inserting/editing links via the link dialog
      • setStylesFormatPath

        public void setStylesFormatPath​(java.lang.String stylesFormatPath)
        Sets the styles format VFS path to use in the widget area.

        Parameters:
        stylesFormatPath - the styles XML VFS path to use in the widget area
      • setStylesXmlPath

        public void setStylesXmlPath​(java.lang.String stylesXmlPath)
        Sets the styles XML VFS path to use in the widget area.

        Parameters:
        stylesXmlPath - the styles XML VFS path to use in the widget area
      • showAnchorDialog

        public boolean showAnchorDialog()
        Returns true if the anchor dialog button should be available.

        Returns:
        if the anchor dialog button should be available
      • showFormatSelect

        public boolean showFormatSelect()
        Returns true if the format selector should be available.

        Returns:
        if the format selector should be available
      • showGalleryDialog

        public boolean showGalleryDialog​(java.lang.String galleryType)
        Returns true if the specified gallery type dialog button is shown.

        Parameters:
        galleryType - the gallery type to check
        Returns:
        true if the specified gallery type dialog button is shown, otherwise false
      • showImageDialog

        public boolean showImageDialog()
        Returns true if the image dialog button should be available.

        Returns:
        if the image dialog button should be available
      • showLinkDialog

        public boolean showLinkDialog()
        Returns true if the link dialog button should be available.

        Returns:
        if the link dialog button should be available
      • showSourceEditor

        public boolean showSourceEditor()
        Returns true if the source code button should be available.

        Returns:
        if the source code button should be available
      • showStylesFormat

        public boolean showStylesFormat()
        Returns true if the styles format selector should be available.

        Returns:
        if the styles format selector should be available
      • showStylesXml

        public boolean showStylesXml()
        Returns true if the styles selector should be available.

        Returns:
        if the styles selector should be available
      • showTableDialog

        public boolean showTableDialog()
        Returns true if the table dialog button should be available.

        Returns:
        if the table dialog button should be available
      • useCss

        public boolean useCss()
        Returns true if the widget editor should use a defined CSS style sheet.

        Returns:
        if the widget editor should use a defined CSS style sheet
      • addAdditionalButton

        protected void addAdditionalButton​(java.lang.String buttonName)
        Adds a button to the list of defined additional buttons.

        Parameters:
        buttonName - the button name to add
      • getButtonName

        protected java.lang.String getButtonName​(java.lang.String barItem,
                                                 java.util.Map<java.lang.String,​java.lang.String> buttonNamesLookUp)
        Returns the real button name matched with the look up map.

        If no value is found in the look up map, the button name is returned unchanged.

        Parameters:
        barItem - the button bar item name to look up
        buttonNamesLookUp - the look up map containing the button names and/or separator name to use
        Returns:
        the translated button name
      • parseOptions

        protected void parseOptions​(java.lang.String configuration)
        Parses the given configuration String.

        Parameters:
        configuration - the configuration String to parse