Class ShortcutListPickerElement

  • All Implemented Interfaces:
    GuiElement, ShortcutListElement

    public class ShortcutListPickerElement
    extends ShortcutListPicker
    This class is used to render a picker (combo or list).
    It renders both the Picker elements and the dropdown as well as the Javascript necessary to display the picker.
    It is a combination of a ShortcutListPicker, used to render the picker, and a ShortcutElement, used for the dropdown.

    To render the pulldown list it reads the ShortcutList set.

    The class also registers a mstrPickerImpl bone that takes care of displaying the picker.
    All users need to do to use it is set the appliesTo property to the respective bone that will take care of the action submitted when the user selects the option on the pulldown or clicks on the button.
    Note: this class is intended to be used outside of a toolbar, since a toolbar renders all the pickers at the same time and only once.
    MicroStrategy Web 9.0.0
    • Constructor Detail

      • ShortcutListPickerElement

        public ShortcutListPickerElement()
    • Method Detail

      • renderElement

        public boolean renderElement​(MarkupOutput out)
        Description copied from class: ShortcutListPicker
        Render the picker with the information provided when this instance was initialized.
        Specified by:
        renderElement in interface GuiElement
        renderElement in class ShortcutListPicker
        out - MarkupOutput instance where the HTML information to display to the user is to be saved.
        boolean value indicating if the render operation was successful or not
      • setDescriptor

        public void setDescriptor​(java.lang.String value)
        Sets the descriptor of the pulldown/button
        value - descriptor
      • setType

        public void setType​(int value)
        Sets the type of the pulldown
        The supported types are Shortcut.TYPE_COMBO && Shortcut.TYPE_PULLDOWN
        value - string the name of the pulldown/button
      • setIsEnabled

        public void setIsEnabled​(boolean value)
        Sets whether the picker is enabled
        value - whether the picker is enabled
      • setAppliesTo

        public void setAppliesTo​(java.lang.String value)
        Sets the name of the bone that will take care of the action submited by clicking on a pulldown option or the button.
        value - id