Menu

Class Overview

The Menu of the native platform.

This class doesn't need to be instantiated. Each menu belongs to a Screen, which you can retrieve by overriding the Screen.onMenuCreate(Menu) method.

Add a menu to a Screen

The following code explains how to add a menu in a screen by overriding onMenuCreate(Menu):

 public MyScreen extends Screen {
 
 	protected void onMenuCreate(Menu menu) {
 		menu.addItem(new MenuItem("Item 1"));
 	}
 
 }
 

Menu in composed screens (SplitScreen, SlideScreen, TabScreen...)

Menu can be added in complex screens like TabScreen, SplitScreen or SlideScreen and in their child screens inside. The menu in composed screens (parent screen) will be shared between all the child screens which composed the parent screen. If a child screen has its own menu, it will be combined with the parent screen menu. The first items in the menu will be the menu items in the parent screen.

MenuItem in the action bar (title bar)

MenuItem can be added in the action bar using setAsLeftAction() and setAsRightAction(). Items will be placed to the left or to the right of the title in the bar. Only one item can be set to the left of the title. If there are several items set as left, only the first will be set to the left, the others will be set to the right. The left action bar button item is by default the back button. If it is replaced by an other menu entry, be sure to implement an other way to exit the screen.

Cross Platform Considerations

Android

Contextual menu or action bar

In Android, the default menu is an Options Menu associated with the menu button. It is opened by clicking on the menu button. By default, MenuItem will be added in this menu.

If the action bar is activated in the application (done by using setActionBarEnabled(boolean) in the application main class), MenuItem can be added in the action bar. Use setAsLeftAction() and setAsRightAction() to place items to the right or to the left of the title in the action bar.

iOS

Tool bar or action bar

In iOS platform, the default menu is shown as an UIToolbar. This tool bar will occupy around 40dp at the bottom of the screen and will be displayed only if the menu contains simple menu items.

Otherwise, MenuItem can be added in the action bar using setAsLeftAction() and setAsRightAction(). Items will be placed to the left or to the right of the title in the bar.

Note: To provide the right image sizes for each platform, see MenuItem documentation.

Summary

[Expand] Inherited Methods

From class java.lang.Object boolean equals(Object obj) Indicates whether some other object is "equal to" this one. final Class<?> getClass() Returns the runtime class of an object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.