Package com.microstrategy.web.app.gui
Class MenuImpl
- java.lang.Object
-
- com.microstrategy.web.app.gui.AbstractGuiElement
-
- com.microstrategy.web.app.gui.MenuImpl
-
- All Implemented Interfaces:
GuiElement
,Menu
public class MenuImpl extends AbstractGuiElement implements Menu
Title: MenuImpl.
Description: represent the menu bar on top of report/document page
Copyright: Copyright (c) 2002
Company: Microstrategy, Inc.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement
_appContext, _name, _webComponent
-
-
Constructor Summary
Constructors Constructor Description MenuImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDynamicMenuName()
Get the name of the list of shortcuts that shall be rendered as a menuShortcutListSet
getDynamicMenus()
Get the list of shortcuts that shall be rendered as a menujava.lang.String
getMenuBlockCss()
Get the css style to use for the menu blockjava.lang.String
getMenuHeaderCss()
Get the css style to use for the menu headerjava.lang.String
getMenuHeaderSelectedCss()
Get the css style to use for the selected menu headerjava.lang.String
getMenuItemCss()
Get the css style to use for the menu itemsjava.lang.String
getMenuItemSelectedCss()
Get the css style to use for the selected menu itemjava.lang.String
getMenuSeparatorCss()
Get the css style to use for the menu separatorMarkupOutput
renderElement()
Render the GUI Element represented by this instanceboolean
renderElement(MarkupOutput mo)
Render the current GUI Element with the information providedvoid
setDynamicMenuName(java.lang.String value)
Set the name of the list of shortcuts that shall be rendered as a menuvoid
setDynamicMenus(ShortcutListSet value)
Set the list of shortcuts that shall be rendered as a menuvoid
setMenuBlockCss(java.lang.String value)
Set the css style to use for the menu blockvoid
setMenuHeaderCss(java.lang.String value)
Set the css style to use for the menu headervoid
setMenuHeaderSelectedCss(java.lang.String value)
Set the css style to use for the selected menu headervoid
setMenuItemCss(java.lang.String value)
Set the css style to use for the menu itemsvoid
setMenuItemSelectedCss(java.lang.String value)
Set the css style to use for the selected menu itemvoid
setMenuSeparatorCss(java.lang.String value)
Set the css style to use for the menu separator-
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 MarkupOutput renderElement()
Render the GUI Element represented by this instance- Specified by:
renderElement
in interfaceGuiElement
- Specified by:
renderElement
in classAbstractGuiElement
- Returns:
- a
MarkupOutput
instance initialized with the HTML code to render for this element
-
renderElement
public boolean renderElement(MarkupOutput mo)
Description copied from class:AbstractGuiElement
Render the current GUI Element with the information provided- Specified by:
renderElement
in interfaceGuiElement
- Overrides:
renderElement
in classAbstractGuiElement
- Parameters:
mo
-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- See Also:
GuiElement.renderElement(com.microstrategy.web.beans.MarkupOutput)
-
setDynamicMenus
public void setDynamicMenus(ShortcutListSet value)
Set the list of shortcuts that shall be rendered as a menu- Specified by:
setDynamicMenus
in interfaceMenu
- Parameters:
value
- aShortcutListSet
instance initialized with the shortcuts to render.
-
getDynamicMenus
public ShortcutListSet getDynamicMenus()
Get the list of shortcuts that shall be rendered as a menu- Specified by:
getDynamicMenus
in interfaceMenu
- Returns:
- the
ShortcutListSet
instance associated with this instance.
-
setDynamicMenuName
public void setDynamicMenuName(java.lang.String value)
Set the name of the list of shortcuts that shall be rendered as a menu- Specified by:
setDynamicMenuName
in interfaceMenu
- Parameters:
value
- aShortcutListSet
instance initialized with the shortcuts to render.- Since:
- MicroStrategy Web 8.0.0
-
getDynamicMenuName
public java.lang.String getDynamicMenuName()
Get the name of the list of shortcuts that shall be rendered as a menu- Specified by:
getDynamicMenuName
in interfaceMenu
- Returns:
- the
ShortcutListSet
instance associated with this instance. - Since:
- MicroStrategy Web 8.0.0
-
setMenuHeaderCss
public void setMenuHeaderCss(java.lang.String value)
Set the css style to use for the menu header- Specified by:
setMenuHeaderCss
in interfaceMenu
- Parameters:
value
- String representing the css style to use
-
getMenuHeaderCss
public java.lang.String getMenuHeaderCss()
Get the css style to use for the menu header- Specified by:
getMenuHeaderCss
in interfaceMenu
- Returns:
- the String representing the css style assigned to use
-
setMenuHeaderSelectedCss
public void setMenuHeaderSelectedCss(java.lang.String value)
Set the css style to use for the selected menu header- Specified by:
setMenuHeaderSelectedCss
in interfaceMenu
- Parameters:
value
- String representing the css style to use
-
getMenuHeaderSelectedCss
public java.lang.String getMenuHeaderSelectedCss()
Get the css style to use for the selected menu header- Specified by:
getMenuHeaderSelectedCss
in interfaceMenu
- Returns:
- the String representing the css style assigned to use
-
setMenuItemCss
public void setMenuItemCss(java.lang.String value)
Set the css style to use for the menu items- Specified by:
setMenuItemCss
in interfaceMenu
- Parameters:
value
- String representing the css style to use
-
getMenuItemCss
public java.lang.String getMenuItemCss()
Get the css style to use for the menu items- Specified by:
getMenuItemCss
in interfaceMenu
- Returns:
- the String representing the css style assigned to use
-
setMenuItemSelectedCss
public void setMenuItemSelectedCss(java.lang.String value)
Set the css style to use for the selected menu item- Specified by:
setMenuItemSelectedCss
in interfaceMenu
- Parameters:
value
- String representing the css style to use
-
getMenuItemSelectedCss
public java.lang.String getMenuItemSelectedCss()
Get the css style to use for the selected menu item- Specified by:
getMenuItemSelectedCss
in interfaceMenu
- Returns:
- the String representing the css style assigned to use
-
setMenuBlockCss
public void setMenuBlockCss(java.lang.String value)
Set the css style to use for the menu block- Specified by:
setMenuBlockCss
in interfaceMenu
- Parameters:
value
- String representing the css style to use
-
getMenuBlockCss
public java.lang.String getMenuBlockCss()
Get the css style to use for the menu block- Specified by:
getMenuBlockCss
in interfaceMenu
- Returns:
- the String representing the css style assigned to use
-
setMenuSeparatorCss
public void setMenuSeparatorCss(java.lang.String value)
Set the css style to use for the menu separator- Specified by:
setMenuSeparatorCss
in interfaceMenu
- Parameters:
value
- String representing the css style to use
-
getMenuSeparatorCss
public java.lang.String getMenuSeparatorCss()
Get the css style to use for the menu separator- Specified by:
getMenuSeparatorCss
in interfaceMenu
- Returns:
- the String representing the css style assigned to use
-
-