com.sap.tc.webdynpro.clientserver.uielib.standard.api

Interface IWDMenuBar

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDMenuBar

extends IWDUIElement

Web Dynpro MenuBar API. A menu bar.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static WDMenuBarDesign	DEFAULT_DESIGN Default value of the design property is WDMenuBarDesign.STANDARD.
static String	DEFAULT_WIDTH Default value of the width property is "".

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addMenu(IWDMenu menu) Adds the given Menu at the end of the Menus list.
void	addMenu(IWDMenu menu, int index) Inserts the given Menu at the specified (zero-based) index into the Menus list.
void	bindDesign(IWDAttributeInfo attributeInfo) Binds the design property to the context attribute specified by the given attribute info.
void	bindDesign(String path) Binds the design property to the context attribute specified by the given path.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
void	destroyAllMenus() Destroys all elements in the Menus list.
WDMenuBarDesign	getDesign() Returns the value of the design property.
IWDMenu	getMenu(int index) Returns the Menu at the given index.
IWDMenu[]	getMenus() Returns the Menus list as an array
String	getWidth() Returns the value of the width property.
boolean	hasMenus() Returns true if there exists a Menu.
int	indexOfMenu(IWDMenu menu) Returns the index of the given element in the Menus list, returns -1 if the element is not in the list.
Iterator	iterateMenus() Returns an iterator over the Menus list.
int	numberOfMenus() Returns the number of Menus.
void	removeAllMenus() Removes all elements from the Menus list.
IWDMenu	removeMenu(int index) Removes the Menu at the given index from the Menus list.
IWDMenu	removeMenu(String id) Removes the Menu with the given ID from the Menus list.
void	setDesign(WDMenuBarDesign value) Sets the design property to the given value.
void	setWidth(String value) Sets the width property to the given value.
void	swapMenus(int i, int j) Swaps the Menus at the given indices.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDMenuBarDesign DEFAULT_DESIGN

Default value of the design property is WDMenuBarDesign.STANDARD.

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

Method Detail

bindDesign

public void bindDesign(String path)

Binds the design property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the design property will be bound

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

Binds the design property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the design property will be bound

bindingOfDesign

public String bindingOfDesign()

Returns the binding path of the design property.

Returns:

the path of the context attribute to which the design property is currently bound

getDesign

public WDMenuBarDesign getDesign()

Returns the value of the design property.

The initial value is WDMenuBarDesign.STANDARD.

Controls the design of the menu bar.

Returns:

the current value of the design property

See Also:

setDesign(WDMenuBarDesign)

setDesign

public void setDesign(WDMenuBarDesign value)

Sets the design property to the given value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindWidth

public void bindWidth(String path)

Binds the width property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

Binds the width property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the width property will be bound

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

the path of the context attribute to which the width property is currently bound

getWidth

public String getWidth()

Returns the value of the width property.

The initial value is "".

Controls the width of the menu bar.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

addMenu

public void addMenu(IWDMenu menu)

Adds the given Menu at the end of the Menus list.

Parameters:

menu - the Menu to be added to the list

See Also:

getMenus()

addMenu

public void addMenu(IWDMenu menu,
                    int index)

Inserts the given Menu at the specified (zero-based) index into the Menus list.

Parameters:

menu - the Menu to be inserted into the list

index - (zero-based) insertion position in the list

See Also:

getMenus()

swapMenus

public void swapMenus(int i,
                      int j)

Swaps the Menus at the given indices.

Parameters:

i - index of the first Menu to swap

j - index of the second Menu to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getMenus

public IWDMenu[] getMenus()

Returns the Menus list as an array.

Returns:

an array containing the current Menus list

getMenu

public IWDMenu getMenu(int index)

Returns the Menu at the given index.

Returns:

Menu at the given index

indexOfMenu

public int indexOfMenu(IWDMenu menu)

Returns the index of the given element in the Menus list, returns -1 if the element is not in the list.

numberOfMenus

public int numberOfMenus()

Returns the number of Menus.

Returns:

the number of Menus

See Also:

getMenus()

hasMenus

public boolean hasMenus()

Returns true if there exists a Menu.

Returns:

true if there exists a Menu, otherwise returns false

See Also:

getMenus()

iterateMenus

public Iterator iterateMenus()

Returns an iterator over the Menus list.

Returns:

an iterator over the Menus list

See Also:

getMenus()

removeMenu

public IWDMenu removeMenu(int index)

Removes the Menu at the given index from the Menus list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

index - (zero-based) index of the removal position in the list

Returns:

the removed element

See Also:

addMenu(IWDMenu), getMenus()

removeMenu

public IWDMenu removeMenu(String id)

Removes the Menu with the given ID from the Menus list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

id - unique ID of the element to be removed from the list

Returns:

the removed element

See Also:

addMenu(IWDMenu), getMenus()

removeAllMenus

public void removeAllMenus()

Removes all elements from the Menus list. This does not destroy the removed elements, i.e. they may be added again!

See Also:

addMenu(IWDMenu), getMenus()

destroyAllMenus

public void destroyAllMenus()

Destroys all elements in the Menus list. Destroyed view elements do not exist any longer in their view, i.e. new elements may be created with the same IDs.