public interface

ShortcutListElement

implements GuiElement
com.microstrategy.web.app.gui.ShortcutListElement
Known Indirect Subclasses

Class Overview

This is the interface for a GUI Element that renders a single ShortcutList Configuration Element. It just extends the GuiElement interface.

Summary

Public Methods
abstract String getGroupCss()
Get the css class for the main div that contains the ShortcutList.
abstract String getId()
Get the id for the main div that contains the ShortcutList.
abstract ShortcutList getShortcutList()
Get the ShortcutList instance to be rendered by this element
abstract boolean isIncludeSubItems()
Get the flag value that indicates whether the HTML should include the subitems content when this element is rendered.
abstract boolean isShowPrefixElements()
Indicates whether there are children elements maked as "Prefix" that should be included in the output as such.
abstract boolean isShowSuffixElements()
Indicates whether there are children elements maked as "Suffix" that should be included in the output as such.
abstract void setGroupCss(String name)
Set the css class for the main div that contains the ShortcutList.
abstract void setId(String id)
Set the id for the main div that contains the ShortcutList.
abstract void setIncludeSubItems(boolean value)
Set the flag value that indicates whether the HTML should include the subitems content when this element is rendered.
abstract void setShortcutList(ShortcutList _config)
Set the ShortcutList instance to be rendered by this element
abstract 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.
abstract void setShowSuffixElements(boolean showSuffixElements)
Set the boolean flag value that indicates whether there are children elements maked as "Suffix" that should be included in the output as such.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.GuiElement

Public Methods

public abstract String getGroupCss ()

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

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

public abstract String getId ()

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

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

public abstract ShortcutList getShortcutList ()

Get the ShortcutList instance to be rendered by this element

Returns
  • the current ShortcutList instance associated with this element

public abstract boolean isIncludeSubItems ()

Get the flag value that indicates whether the HTML should include the subitems content when this element is rendered.

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

public abstract boolean isShowPrefixElements ()

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

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

public abstract boolean isShowSuffixElements ()

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

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

public abstract void setGroupCss (String name)

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

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

public abstract void setId (String id)

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

Parameters
id String value with the identifier for the instance.

public abstract void setIncludeSubItems (boolean value)

Set the flag value that indicates whether the HTML should include the subitems content when this element is rendered.

Parameters
value boolean true if shortcut should include it automatically.

public abstract void setShortcutList (ShortcutList _config)

Set the ShortcutList instance to be rendered by this element

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

public abstract 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.

Parameters
value boolean true if these children should be rendered.

public abstract void setShowSuffixElements (boolean showSuffixElements)

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

Parameters
showSuffixElements boolean value indicating if these children should be rendered.