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

Interface IMenu

All Superinterfaces:

com.google.gwt.user.client.ui.IsWidget, IUpgrade

All Known Subinterfaces:

IMenuCombo

All Known Implementing Classes:

Dropdown, Menu, MenuCombo

public interface IMenu
extends com.google.gwt.user.client.ui.IsWidget, IUpgrade

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 item, boolean enabled) Syntactic sugar for addItem(String, String, boolean) where the text and value are the same.
void	addItem(String text, String value, boolean enabled) Adds a new option to the list of options in the menu.
void	addItem(String text, String value, int index, boolean enabled) Adds a an option into the set of options of the menu at a specified position.
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 : Implement the Menu.ItemClickListener interface Define the actions that should be performed when a MenuItem is clicked inside Menu.ItemClickListener.onItemClicked(ItemClickEvent) Call Menu.addItemClickListener(ItemClickListener) to register itself to the menu and receive click notifications
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	removeItem(int index) Removes an item from the menu.
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.
boolean	setEnabled(int index, boolean enabled) Modify the enabled state of an item.

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Methods inherited from interface com.github.ilyes4j.gwt.mdl.components.IUpgrade

isUpgraded, upgrade

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.

addItem

void addItem(String item,
           boolean enabled)

Syntactic sugar for addItem(String, String, boolean) where the text and value are the same.

Parameters:

item - The text to be displayed

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

addItem

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

Adds a an option into the set of options of the menu at a specified position.

Parameters:

text - The text to be displayed

value - The value to be added

enabled - Defines whether the option is available for selection.

index - the insertion position of the item

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.

removeItem

void removeItem(int index)

Removes an item from the menu.

Parameters:

index - the position of the item to be removed