public class

MenuImpl

extends AbstractGuiElement
implements Menu
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
     ↳ com.microstrategy.web.app.gui.MenuImpl

Class Overview

Title: MenuImpl.

Description: represent the menu bar on top of report/document page

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

[Expand]
Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement
Public Constructors
MenuImpl()
Public Methods
String getDynamicMenuName()
Get the name of the list of shortcuts that shall be rendered as a menu
ShortcutListSet getDynamicMenus()
Get the list of shortcuts that shall be rendered as a menu
String getMenuBlockCss()
Get the css style to use for the menu block
String getMenuHeaderCss()
Get the css style to use for the menu header
String getMenuHeaderSelectedCss()
Get the css style to use for the selected menu header
String getMenuItemCss()
Get the css style to use for the menu items
String getMenuItemSelectedCss()
Get the css style to use for the selected menu item
String getMenuSeparatorCss()
Get the css style to use for the menu separator
boolean renderElement(MarkupOutput mo)
Render the current GUI Element with the information provided
MarkupOutput renderElement()
Render the GUI Element represented by this instance
void setDynamicMenuName(String value)
Set the name of the list of shortcuts that shall be rendered as a menu
void setDynamicMenus(ShortcutListSet value)
Set the list of shortcuts that shall be rendered as a menu
void setMenuBlockCss(String value)
Set the css style to use for the menu block
void setMenuHeaderCss(String value)
Set the css style to use for the menu header
void setMenuHeaderSelectedCss(String value)
Set the css style to use for the selected menu header
void setMenuItemCss(String value)
Set the css style to use for the menu items
void setMenuItemSelectedCss(String value)
Set the css style to use for the selected menu item
void setMenuSeparatorCss(String value)
Set the css style to use for the menu separator
[Expand]
Inherited Methods
From class com.microstrategy.web.app.gui.AbstractGuiElement
From class java.lang.Object
From interface com.microstrategy.web.app.gui.GuiElement
From interface com.microstrategy.web.app.gui.Menu

Public Constructors

public MenuImpl ()

Public Methods

public String getDynamicMenuName ()

Get the name of the list of shortcuts that shall be rendered as a menu

Returns

public ShortcutListSet getDynamicMenus ()

Get the list of shortcuts that shall be rendered as a menu

Returns

public String getMenuBlockCss ()

Get the css style to use for the menu block

Returns
  • the String representing the css style assigned to use

public String getMenuHeaderCss ()

Get the css style to use for the menu header

Returns
  • the String representing the css style assigned to use

public String getMenuHeaderSelectedCss ()

Get the css style to use for the selected menu header

Returns
  • the String representing the css style assigned to use

public String getMenuItemCss ()

Get the css style to use for the menu items

Returns
  • the String representing the css style assigned to use

public String getMenuItemSelectedCss ()

Get the css style to use for the selected menu item

Returns
  • the String representing the css style assigned to use

public String getMenuSeparatorCss ()

Get the css style to use for the menu separator

Returns
  • the String representing the css style assigned to use

public boolean renderElement (MarkupOutput mo)

Render the current GUI Element with the information provided

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

public MarkupOutput renderElement ()

Render the GUI Element represented by this instance

Returns
  • a MarkupOutput instance initialized with the HTML code to render for this element

public void setDynamicMenuName (String value)

Set the name of the list of shortcuts that shall be rendered as a menu

Parameters
value a ShortcutListSet instance initialized with the shortcuts to render.

public void setDynamicMenus (ShortcutListSet value)

Set the list of shortcuts that shall be rendered as a menu

Parameters
value a ShortcutListSet instance initialized with the shortcuts to render.

public void setMenuBlockCss (String value)

Set the css style to use for the menu block

Parameters
value String representing the css style to use

public void setMenuHeaderCss (String value)

Set the css style to use for the menu header

Parameters
value String representing the css style to use

public void setMenuHeaderSelectedCss (String value)

Set the css style to use for the selected menu header

Parameters
value String representing the css style to use

public void setMenuItemCss (String value)

Set the css style to use for the menu items

Parameters
value String representing the css style to use

public void setMenuItemSelectedCss (String value)

Set the css style to use for the selected menu item

Parameters
value String representing the css style to use

public void setMenuSeparatorCss (String value)

Set the css style to use for the menu separator

Parameters
value String representing the css style to use