Package com.jalios.jcms.taglib.settings

Class AbstractChooserSettings<T extends AbstractChooserSettings<T>>

    • Constructor Detail

      • AbstractChooserSettings

        public AbstractChooserSettings()

    • Method Detail

      • getChooserName

        protected abstract java.lang.String getChooserName()
        Chooser name used by the databroker when there is a click event in the chooser button.
        Returns:
        The chooser name
        See Also:
        "/js/jalios/core/jalios-widget-chooser.js"

      • getAcChooserName

        protected java.lang.String getAcChooserName()
        Autocomplete chooser name used by the databroker when there is a change event in the control.
        Returns:
        the autocomplete chooser name
        See Also:
        "/js/jalios/core/jalios-autocomplete-chooser.js"

      • getChooserOption

        protected abstract java.lang.String getChooserOption​(java.util.Map<java.lang.String,​java.lang.String[]> customOptionMap)
        Options used by the databroker when there is a click event in the chooser button.
        Parameters:
        customOptionMap - Extra chooser options forwarded by the option ChooserConstants.EXTRA_CHOOSER_OPTION and appended to the query string
        Returns:
        String representing the options as query string

      • getAcChooserOption

        protected java.lang.String getAcChooserOption​(java.util.Map<java.lang.String,​java.lang.String[]> customOptionMap)
        Options used by the databroker when there is a change event in the control.
        Parameters:
        customOptionMap - Extra chooser options forwarded by the option ChooserConstants.EXTRA_CHOOSER_OPTION and appended to the query string
        Returns:
        String representing the options as query string

      • getChooserIcon

        protected java.lang.String getChooserIcon()
        Property key whose value corresponds to the icon used for the chooser button.

        Example:
        If we declare the following icon property: 

         icon.chooser-publication: glyph: icomoon-file-text2
        The method return chooser-publication
        Returns:
        Property key representing the chooser button icon

      • getChooserTitle

        protected java.lang.String getChooserTitle()
        Title added on the chooser button.
        Returns:
        The chooser button title

      • useCurrentWorkspace

        protected boolean useCurrentWorkspace()
        Override this method and return 'true' to add current Workspace in chooser option if not defined by WORKSPACE option.
        Returns:
        true to use the current workspace, false instead

      • superGetOption

        protected final <V> V superGetOption​(java.lang.String optionName)
        Method used internally by CommonChooserSettings to call the getOption(String) method in the parent class of the current class.
        Parameters:
        optionName - Option name
        Returns:
        Option value

      • addChooserOption

        public T addChooserOption​(java.lang.String name,
                          java.lang.String... values)
        Adds new chooser option with the specified value(s). If the given value is null, the option is ignored.
        Parameters:
        name - Chooser option name
        values - Chooser option value(s)
        Returns:
        a reference to this object - used to chain calls

      • addAcChooserOption

        public T addAcChooserOption​(java.lang.String name,
                            java.lang.String... values)
        Adds new autocomplete chooser option with the specified value(s). If the given value is null, the option is ignored.
        Parameters:
        name - Autocomplete chooser option name
        values - Autocomplete chooser option value(s)
        Returns:
        a reference to this object - used to chain calls

      • workspace

        public T workspace​(java.lang.String workspaceId)
        Set the Workspace ID to which you filter in the chooser window and in the autocomplete.
        Parameters:
        workspaceId - Workspace ID
        Returns:
        a reference to this object - used to chain calls

      • workspace

        public T workspace​(Workspace workspace)
        Set the Workspace to which you filter in the chooser window and in the autocomplete.
        Parameters:
        workspace - Workspace
        Returns:
        a reference to this object - used to chain calls

      • popupWidth

        public T popupWidth​(int width)
        Set the chooser window with.
        Parameters:
        width - Chooser window width
        Returns:
        a reference to this object - used to chain calls

      • popupHeight

        public T popupHeight​(int height)
        Set the chooser window height.
        Parameters:
        height - Chooser window height
        Returns:
        a reference to this object - used to chain calls