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

Modifier and Type	Method	Description
java.lang.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
java.lang.String	getMenuBlockCss()	Get the css style to use for the menu block
java.lang.String	getMenuHeaderCss()	Get the css style to use for the menu header
java.lang.String	getMenuHeaderSelectedCss()	Get the css style to use for the selected menu header
java.lang.String	getMenuItemCss()	Get the css style to use for the menu items
java.lang.String	getMenuItemSelectedCss()	Get the css style to use for the selected menu item
java.lang.String	getMenuSeparatorCss()	Get the css style to use for the menu separator
MarkupOutput	renderElement()	Render the GUI Element represented by this instance
boolean	renderElement(MarkupOutput mo)	Render the current GUI Element with the information provided
void	setDynamicMenuName(java.lang.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(java.lang.String value)	Set the css style to use for the menu block
void	setMenuHeaderCss(java.lang.String value)	Set the css style to use for the menu header
void	setMenuHeaderSelectedCss(java.lang.String value)	Set the css style to use for the selected menu header
void	setMenuItemCss(java.lang.String value)	Set the css style to use for the menu items
void	setMenuItemSelectedCss(java.lang.String value)	Set the css style to use for the selected menu item
void	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

Constructor Detail

MenuImpl

public MenuImpl()

Method Detail

renderElement

public MarkupOutput renderElement()

Render the GUI Element represented by this instance

Specified by:

renderElement in interface GuiElement

Specified by:

renderElement in class AbstractGuiElement

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 interface GuiElement

Overrides:

renderElement in class AbstractGuiElement

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 interface Menu

Parameters:

value - a ShortcutListSet 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 interface Menu

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 interface Menu

Parameters:

value - a ShortcutListSet 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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

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 interface Menu

Returns:

the String representing the css style assigned to use