com.github.ilyes4j.gwt.mdl.components.menus

Interface IMenu

All Known Implementing Classes:

Dropdown, Menu, MenuCombo

public interface IMenu

Every component that has menu related features should implement this interface.

Author:

Mohamed Ilyes DIMASSI

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(String text, String value, boolean enabled) Adds a new option to the list of options in the menu.
void	addItemClickListener(Menu.ItemClickListener listener) When an object needs to be notified upon a MenuItem click, it must be be registered to the Menu as an Menu.ItemClickListener .
void	clearMenu() Remove all items from the menu.
int	getItemCount() Returns the items count in a menu.
String	getItemText(int index) return the text of the item located at the position provided as input.
String	getValue(int index) return the value of the item located at the position provided as input.
boolean	isEnabled(int index) Modify the enabled state of an item.
void	setAnchor(MenuAnchor anchor) Sets the position of the Menu on the screen related to its associated action button using one of the available anchoring options provided by MenuAnchor.
boolean	setEnabled(int index, boolean enabled) Modify the enabled state of an item.

Method Detail

setAnchor

void setAnchor(MenuAnchor anchor)

Sets the position of the Menu on the screen related to its associated action button using one of the available anchoring options provided by MenuAnchor.

An extra care should be taken when anchoring the menu. According to this thread , the menu's parent need a position:relative in order for the menu to be anchored correctly.

Parameters:

anchor - the requested Anchor position for the Menu .

clearMenu

void clearMenu()

Remove all items from the menu.

addItem

void addItem(String text,
           String value,
           boolean enabled)

Adds a new option to the list of options in the menu.

Parameters:

text - The text to be displayed

value - The value to be added

enabled - Defines whether the option can be chosen or not.

addItemClickListener

void addItemClickListener(Menu.ItemClickListener listener)

When an object needs to be notified upon a MenuItem click, it must be be registered to the Menu as an Menu.ItemClickListener .

In order to receive item click notifications, the object should :

1. Implement the Menu.ItemClickListener interface
2. Define the actions that should be performed when a MenuItem is clicked inside Menu.ItemClickListener.onItemClicked(ItemClickEvent)
3. Call Menu.addItemClickListener(ItemClickListener) to register itself to the menu and receive click notifications

Parameters:

listener - The object to be notified when a MenuItem is clicked.

See Also:

Menu.ItemClickListener

getItemCount

int getItemCount()

Returns the items count in a menu.

Returns:

the items count in a menu

getItemText

String getItemText(int index)

return the text of the item located at the position provided as input.

Parameters:

index - the position of the item

Returns:

the text of the item at input position

getValue

String getValue(int index)

return the value of the item located at the position provided as input.

Parameters:

index - the position of the item

Returns:

the value of the item at input position

setEnabled

boolean setEnabled(int index,
                 boolean enabled)

Modify the enabled state of an item. The position of the item is provided as input

Parameters:

index - the position of the item in the item list of the menu

enabled - the state to be set for the item

Returns:

true if the state was modified, false otherwise.

isEnabled

boolean isEnabled(int index)

Modify the enabled state of an item. The position of the item is provided as input

Parameters:

index - the position of the item in the item list of the menu

Returns:

true if the item is enabled, false otherwise.