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

Class AbstractShortcutList

java.lang.Object

com.microstrategy.web.app.gui.AbstractGuiElement

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

All Implemented Interfaces:

GuiElement, ShortcutListElement

Direct Known Subclasses:

ShortcutListPicker, ShortcutListStyles

public abstract class AbstractShortcutList
extends AbstractGuiElement
implements ShortcutListElement

This abstract GuiElement implementation serves as base for rendering information about the different types of ShortcutListElement a toolbar might use for displaying its different options to the user.

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
AbstractShortcutList()	Class constructor

Method Summary

Modifier and Type	Method	Description
protected void	addAttributesToTag(Tag tag, WebAttributeList attributes)	Convenience method for adding properties to the Tag instance, based on the attribute information sent as parameter.
protected WebComponent	getFeaturesRoot()	Get the WebComponent instance that will be used as base for testing features.
java.lang.String	getGroupCss()	Get the css class for the main div that contains the ShortcutList.
java.lang.String	getId()	Get the id for the main div that contains the ShortcutList.
ShortcutList	getShortcutList()	Get the ShortcutList instance to be rendered by this element
protected boolean	isEnabled(ShortcutList list)	Utility method that tests if the ShortcutList instance shall be enabled for the user.
boolean	isIncludeSubItems()	This flag indicates whether the HTML should include the subitems content when this element is rendered.
boolean	isShowPrefixElements()	Indicates whether there are children elements maked as "Prefix" that should be included in the output as such.
boolean	isShowSuffixElements()	Indicates whether there are children elements maked as "Suffix" that should be included in the output as such.
MarkupOutput	renderElement()	Render the instance according to the information provided on its configuration.
void	setGroupCss(java.lang.String css)	Set the css class for the main div that contains the ShortcutList.
void	setId(java.lang.String id)	Set the id for the main div that contains the ShortcutList.
void	setIncludeSubItems(boolean value)	This flag indicates whether the HTML should include the subitems content when this element is rendered.
void	setShortcutList(ShortcutList _config)	Set the ShortcutList instance to be rendered by this element
void	setShowPrefixElements(boolean value)	Set the boolean flag value that indicates whether there are children elements maked as "Prefix" that should be included in the output as such.
void	setShowSuffixElements(boolean value)	Set the boolean flag value that indicates whether there are children elements maked as "Suffix" that should be included in the output as such.

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, renderElement, 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, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Constructor Detail

AbstractShortcutList

public AbstractShortcutList()

Class constructor

Method Detail

renderElement

public MarkupOutput renderElement()

Render the instance according to the information provided on its configuration.

Specified by:

renderElement in interface GuiElement

Specified by:

renderElement in class AbstractGuiElement

Returns:

MarkupOutput instance initialized with the HTML information to display to the user.

getFeaturesRoot

protected WebComponent getFeaturesRoot()

Get the WebComponent instance that will be used as base for testing features.

Returns:

the WebComponent to use as the root to check features (i.e. check-feature, active-feature, etc.)

addAttributesToTag

protected void addAttributesToTag(Tag tag,
                                  WebAttributeList attributes)

Convenience method for adding properties to the Tag instance, based on the attribute information sent as parameter.

Parameters:

tag - Tag instance where the attribute information shall be added

attributes - WebAttributeList instance with the attribute information to add to the Tag, as name and value pairs.

setShortcutList

public void setShortcutList(ShortcutList _config)

Set the ShortcutList instance to be rendered by this element

Specified by:

setShortcutList in interface ShortcutListElement

Parameters:

_config - ShortcutList instance to be rendered by this GUI element.

getShortcutList

public ShortcutList getShortcutList()

Get the ShortcutList instance to be rendered by this element

Specified by:

getShortcutList in interface ShortcutListElement

Returns:

the current ShortcutList instance associated with this element

setIncludeSubItems

public void setIncludeSubItems(boolean value)

This flag indicates whether the HTML should include the subitems content when this element is rendered.

Specified by:

setIncludeSubItems in interface ShortcutListElement

Parameters:

value - boolean value of true if shortcut should include it automatically.

isIncludeSubItems

public boolean isIncludeSubItems()

This flag indicates whether the HTML should include the subitems content when this element is rendered.

Specified by:

isIncludeSubItems in interface ShortcutListElement

Returns:

boolean true if subitems content will be included when the element is rendered.

setShowPrefixElements

public void setShowPrefixElements(boolean value)

Set the boolean flag value that indicates whether there are children elements maked as "Prefix" that should be included in the output as such.

Specified by:

setShowPrefixElements in interface ShortcutListElement

Parameters:

value - boolean true if these children should be rendered.

isShowPrefixElements

public boolean isShowPrefixElements()

Indicates whether there are children elements maked as "Prefix" that should be included in the output as such.

Specified by:

isShowPrefixElements in interface ShortcutListElement

Returns:

boolean true if children marked as "Prefix" are included when the element is rendered.

setShowSuffixElements

public void setShowSuffixElements(boolean value)

Set the boolean flag value that indicates whether there are children elements maked as "Suffix" that should be included in the output as such.

Specified by:

setShowSuffixElements in interface ShortcutListElement

Parameters:

value - boolean value indicating if these children should be rendered.

isShowSuffixElements

public boolean isShowSuffixElements()

Indicates whether there are children elements maked as "Suffix" that should be included in the output as such.

Specified by:

isShowSuffixElements in interface ShortcutListElement

Returns:

boolean true if children marked as "Suffix" are included when the element is rendered.

setGroupCss

public void setGroupCss(java.lang.String css)

Set the css class for the main div that contains the ShortcutList.

Specified by:

setGroupCss in interface ShortcutListElement

Parameters:

css - the new css class to use. By default the value is "group:

setId

public void setId(java.lang.String id)

Set the id for the main div that contains the ShortcutList.

Specified by:

setId in interface ShortcutListElement

Parameters:

id - String value with the identifier for the instance.

getId

public java.lang.String getId()

Get the id for the main div that contains the ShortcutList.

Specified by:

getId in interface ShortcutListElement

Returns:

the current id for the main div that contains the ShortcutList. If an id has not been set it uses the name of the associated ShortcutList If no ShortcutList is associated, it then returns null.

getGroupCss

public java.lang.String getGroupCss()

Get the css class for the main div that contains the ShortcutList.

Specified by:

getGroupCss in interface ShortcutListElement

Returns:

the current css class for the main div that contains the ShortcutList.

isEnabled

protected boolean isEnabled(ShortcutList list)

Utility method that tests if the ShortcutList instance shall be enabled for the user.

Parameters:

list - ShortcutList instance to test

Returns:

boolean value indicating if the instance tested is enabled or not.