com.sap.ui.commons.client
Class MenuItemBase

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.commons.client.MenuItemBase

Direct Known Subclasses:

MenuItem

public class MenuItemBase
extends com.sap.ui.core.client.Element

The class MenuItemBase is the GWT wrapper for the Phoenix control: sap.ui.commons.MenuItemBase.

Provides the standard properties for menu items.

• Properties
  • enabled : boolean
    Disabled items have different colors, depending on customer settings.
  • visible : boolean
    Invisible controls are not rendered.
  • startsSection : boolean
    If true, then a divider is shown before this item.
• Aggregations
  • submenu : com.sap.ui.commons.client.Menu
    Aggregation of a menu item's submenu.
• Associations
• Events
  • select Event is fired when an item is selected. The event is also available for items having a submenu. A mouse click or spacebar click on a submenu item fires the event.

For further parameters see {@link com.sap.ui.core.client.Element

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.MenuItemBase)

Constructor Summary

protected

MenuItemBase() constructs the class MenuItemBase hidden due to JavaScriptObject restriction

Method Summary

MenuItemBase	attachSelectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when an item is selected.
static MenuItemBase	create() creates a new instance of the class MenuItemBase
static MenuItemBase	create(String idOrConfig) creates a new instance of the class MenuItemBase
static MenuItemBase	create(String id, String config) creates a new instance of the class MenuItemBase
MenuItemBase	destroySubmenu() Destroys the submenu in the Submenu-aggregation.
MenuItemBase	detachSelectEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when an item is selected.
Menu	getSubmenu() Getter for aggregation submenu Aggregation of a menu item's submenu.
boolean	isEnabled() Getter for property enabled Disabled items have different colors, depending on customer settings.
boolean	isStartsSection() Getter for property startsSection If true, then a divider is shown before this item.
boolean	isVisible() Getter for property visible Invisible controls are not rendered.
MenuItemBase	setEnabled(boolean value) Setter for property enabled Default value is: true
MenuItemBase	setStartsSection(boolean value) Setter for property startsSection Default value is: false
MenuItemBase	setSubmenu(Menu submenu) Setter for the aggregated submenu.
MenuItemBase	setVisible(boolean value) Setter for property visible Default value is: true

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MenuItemBase

protected MenuItemBase()

constructs the class MenuItemBase
hidden due to JavaScriptObject restriction

Method Detail

create

public static MenuItemBase create()

creates a new instance of the class MenuItemBase

create

public static MenuItemBase create(String idOrConfig)

creates a new instance of the class MenuItemBase

Parameters:

id - id of the MenuItemBase or configuration JSON string

create

public static MenuItemBase create(String id,
                                  String config)

creates a new instance of the class MenuItemBase

Parameters:

id - id of the MenuItemBase

config - configuration JSON string

isEnabled

public final boolean isEnabled()

Getter for property enabled Disabled items have different colors, depending on customer settings.

Returns:

the value of property enabled

setEnabled

public final MenuItemBase setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible controls are not rendered.

Returns:

the value of property visible

setVisible

public final MenuItemBase setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isStartsSection

public final boolean isStartsSection()

Getter for property startsSection If true, then a divider is shown before this item.

Returns:

the value of property startsSection

setStartsSection

public final MenuItemBase setStartsSection(boolean value)

Setter for property startsSection
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getSubmenu

public final Menu getSubmenu()

Getter for aggregation submenu Aggregation of a menu item's submenu.

Returns:

com.sap.ui.commons.client.Menu

setSubmenu

public final MenuItemBase setSubmenu(Menu submenu)

Setter for the aggregated submenu.

Parameters:

osubmenu - {com.sap.ui.commons.client.Menu}

Returns:

this to allow method chaining

destroySubmenu

public final MenuItemBase destroySubmenu()

Destroys the submenu in the Submenu-aggregation.

Returns:

this to allow method chaining

attachSelectEvent

public final MenuItemBase attachSelectEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when an item is selected. The event is also available for items having a submenu. A mouse click or spacebar click on a submenu item fires the event.

Event Parameters:

{sap.ui.commons/MenuItemBase} item This item.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachSelectEvent

public final MenuItemBase detachSelectEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when an item is selected. The event is also available for items having a submenu. A mouse click or spacebar click on a submenu item fires the event.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining