com.sap.ui.commons.client
Class MenuBarWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.MenuBarWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class MenuBarWidget
extends com.sap.ui.core.client.ControlWidget

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

Used to present actions in a structure. It represents a UI area which is the container for the menus and menu items. The menu bar contains the menu titles from where users navigate to the single items. The control supports for example long menu item texts, automated scrolling for menu items when the browser space is not large enough to display all items, defining images for single or all items in a menu, automated layouting of items with or w/o image, and active/non-active out-greyed items.

• Properties
  • enabled : boolean
    When the MenuBar is not enabled all menu items are displayed disabled.
  • visible : boolean
    Invisible controls are not rendered.
  • width : String
    Sets the width of the control
  • design : com.sap.ui.commons.client.MenuBarDesign
    Design settings are theme-dependent.
• Aggregations
  • items : com.sap.ui.commons.client.MenuItem
    Aggregation of menu items.
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: SAP AG)

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	MenuBarWidget() constructs the class MenuBarWidget
protected	MenuBarWidget(MenuBar control) constructs the class MenuBarWidget
	MenuBarWidget(String id) constructs the class MenuBarWidget

Method Summary

void	addItem(MenuItem item) Appends some item to the items-aggregation.
void	destroyItems() Destroys all the items in the Items-aggregation.
MenuBar	getControl() returns the reference to the Phoenix Control
MenuBarDesign	getDesign() Getter for property design Design settings are theme-dependent.
com.sap.ui.core.client.js.JsArray<MenuItem>	getItems() Getter for aggregation items Aggregation of menu items.
String	getWidth() Getter for property width Sets the width of the control
int	indexOfItem(MenuItem item) Checks for the provided com.sap.ui.commons.client.MenuItem in the items-aggregation and returns its index if found or -1 otherwise.
void	insertItem(MenuItem item, int index) Inserts some item into the aggregation named items.
boolean	isEnabled() Getter for property enabled When the MenuBar is not enabled all menu items are displayed disabled.
boolean	isVisible() Getter for property visible Invisible controls are not rendered.
void	removeAllItems() Removes all the items in the items-aggregation.
void	removeItem(int index) Removes the item at position index in the items-aggregation named.
void	setDesign(MenuBarDesign value) Setter for property design Default value is: Standard
void	setEnabled(boolean value) Setter for property enabled Default value is: true
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width Default value is: 100%

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MenuBarWidget

public MenuBarWidget()

constructs the class MenuBarWidget

MenuBarWidget

public MenuBarWidget(String id)

constructs the class MenuBarWidget

Parameters:

id - id of the MenuBarWidget

MenuBarWidget

protected MenuBarWidget(MenuBar control)

constructs the class MenuBarWidget

Parameters:

control - reference to an existing MenuBar

Method Detail

getControl

public MenuBar getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

isEnabled

public boolean isEnabled()

Getter for property enabled When the MenuBar is not enabled all menu items are displayed disabled.

Returns:

the value of property enabled

setEnabled

public void setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

isVisible

public boolean isVisible()

Getter for property visible Invisible controls are not rendered.

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

getWidth

public String getWidth()

Getter for property width Sets the width of the control

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width
Default value is: 100%

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getDesign

public MenuBarDesign getDesign()

Getter for property design Design settings are theme-dependent.

Returns:

the value of property design

setDesign

public void setDesign(MenuBarDesign value)

Setter for property design
Default value is: Standard

Parameters:

value - com.sap.ui.commons.client.MenuBarDesign

getItems

public com.sap.ui.core.client.js.JsArray<MenuItem> getItems()

Getter for aggregation items Aggregation of menu items.

Returns:

com.sap.ui.commons.client.MenuItem[]

insertItem

public void insertItem(MenuItem item,
                       int index)

Inserts some item into the aggregation named items.

Parameters:

item - the item to insert

index - int the 0-based index the item should be inserted at.

addItem

public void addItem(MenuItem item)

Appends some item to the items-aggregation.

Parameters:

item - com.sap.ui.commons.client.MenuItem the item to add

removeItem

public void removeItem(int index)

Removes the item at position index in the items-aggregation named.

Parameters:

index - int the position of the item to remove.

removeAllItems

public void removeAllItems()

Removes all the items in the items-aggregation.

indexOfItem

public int indexOfItem(MenuItem item)

Checks for the provided com.sap.ui.commons.client.MenuItem in the items-aggregation and returns its index if found or -1 otherwise.

Parameters:

item - the item whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyItems

public void destroyItems()

Destroys all the items in the Items-aggregation.