Class ShortcutListPicker
- java.lang.Object
-
- com.microstrategy.web.app.gui.AbstractGuiElement
-
- com.microstrategy.web.app.gui.shortcuts.AbstractShortcutList
-
- com.microstrategy.web.app.gui.shortcuts.ShortcutListPicker
-
- All Implemented Interfaces:
GuiElement
,ShortcutListElement
- Direct Known Subclasses:
ShortcutListPickerElement
public class ShortcutListPicker extends AbstractShortcutList
This class takes care of rendering a picker as part of options as provided on a toolbar or editor interface. A picker represents a series of options from where the user can select the manipulation to submit. For example, a list with different font sizes from which the user can pick one and request the selected target object on the interface to be updated with that size.The different options can be organized as
Shortcut.LOCATION_PREFIX
, which will be positioned as the first options on the picker to generate;Shortcut.LOCATION_DEFAULT
which will be rendered after the prefix and in the same order as defined on the configuration XML; finally, those defined asShortcut.LOCATION_SUFFIX
will be rendered last.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement
_appContext, _name, _webComponent
-
-
Constructor Summary
Constructors Constructor Description ShortcutListPicker()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getGroupCss()
Get the css class that will be used on the HTML tag that will act as a wrapper for all the options to be displayed as part of this picker.boolean
renderElement(MarkupOutput out)
Render the picker with the information provided when this instance was initialized.protected void
renderOption(Tag parent, Shortcut option)
Renders a single option as part of the picker.-
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
-
-
-
-
Method Detail
-
renderElement
public boolean renderElement(MarkupOutput out)
Render the picker with the information provided when this instance was initialized.- Specified by:
renderElement
in interfaceGuiElement
- Overrides:
renderElement
in classAbstractGuiElement
- 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
-
renderOption
protected void renderOption(Tag parent, Shortcut option)
Renders a single option as part of the picker. This option will be internally represented by aShortcutElement
instance and then called to be rendered from there.
-
getGroupCss
public java.lang.String getGroupCss()
Get the css class that will be used on the HTML tag that will act as a wrapper for all the options to be displayed as part of this picker.- Specified by:
getGroupCss
in interfaceShortcutListElement
- Overrides:
getGroupCss
in classAbstractShortcutList
- Returns:
- the css class to use for this picker's definition. If the
ShortcutList
has been assigned, this method actually resolves the name based on the availability of the option and the name of thegroupCss
as defined for the picker.
-
-