Package com.microstrategy.web.app.gui.shortcuts

Class ShortcutListPickerElement

java.lang.Object

com.microstrategy.web.app.gui.AbstractGuiElement

com.microstrategy.web.app.gui.shortcuts.AbstractShortcutList

com.microstrategy.web.app.gui.shortcuts.ShortcutListPicker

com.microstrategy.web.app.gui.shortcuts.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.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement

_appContext, _name, _webComponent

Constructor Summary

Constructors

Constructor	Description
ShortcutListPickerElement()

Method Summary

Modifier and Type	Method	Description
boolean	renderElement(MarkupOutput out)	Render the picker with the information provided when this instance was initialized.
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.
void	setDescriptor(java.lang.String value)	Sets the descriptor of the pulldown/button
void	setIsEnabled(boolean value)	Sets whether the picker is enabled
void	setType(int value)	Sets the type of the pulldown The supported types are Shortcut.TYPE_COMBO && Shortcut.TYPE_PULLDOWN

Methods inherited from class com.microstrategy.web.app.gui.shortcuts.ShortcutListPicker

getGroupCss, renderOption

Methods inherited from class com.microstrategy.web.app.gui.shortcuts.AbstractShortcutList

addAttributesToTag, getFeaturesRoot, getId, getShortcutList, isEnabled, isIncludeSubItems, isShowPrefixElements, isShowSuffixElements, renderElement, setGroupCss, setId, setIncludeSubItems, setShortcutList, setShowPrefixElements, setShowSuffixElements

Methods inherited from class com.microstrategy.web.app.gui.AbstractGuiElement

getAppContext, getDescriptor, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getTagsFactory, getUseIFrame, getWebComponent, isDhtml, isIFrameEnabled, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.gui.GuiElement

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

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

Overrides:

renderElement in class ShortcutListPicker

Parameters:

out - MarkupOutput instance where the HTML information to display to the user is to be saved.

Returns:

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

Parameters:

value - descriptor

setType

public void setType(int value)

Sets the type of the pulldown
The supported types are Shortcut.TYPE_COMBO && Shortcut.TYPE_PULLDOWN

Parameters:

value - string the name of the pulldown/button

setIsEnabled

public void setIsEnabled(boolean value)

Sets whether the picker is enabled

Parameters:

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.

Parameters:

value - id