Titanium.UI.iOS.MenuPopup

A menu popup provides the ability to create custom tooltip options using the items property covering the native UIMenuController class.

See also:

• iOS Developer Library: UIMenuController

Extends: Titanium.Proxy · Since: 5.2.0, 5.2.0, 9.2.0 · Platforms: iphone, ipad, macos

Properties

apiName

extended

3.2.0

3.2.0

3.2.0

9.2.0

Type: String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.

bubbleParent

extended

3.0.0

3.0.0

3.0.0

9.2.0

Type: Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.

items

0.9

0.9

0.9

9.2.0

Type: Array<String>

The items of the menu popup.

The items will be shown as soon in the menu popup when the show method is called.
To hide them again, use the hide method in conjunction.

lifecycleContainer

extended

3.6.0

Type: Titanium.UI.Window, Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.

Methods

addEventListener

extended

0.9

0.9

0.9

9.2.0

Adds the specified callback as an event listener for the named event.

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired.	No

applyProperties

extended

3.0.0

3.0.0

3.0.0

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.

Parameters:

Name	Type	Summary	Optional
props	Dictionary	A dictionary of properties to apply.	No

fireEvent

extended

0.9

0.9

0.9

9.2.0

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
event	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

hide

0.9

0.9

0.9

9.2.0

Hides the menu popup.

Parameters:

Name	Type	Summary	Optional
options	AnimatedOptions	Includes options how the menu popup should be hidden. Introduced in SDK 5.2.0. Note that the default here is equivalent to passing in { animated: true } (while typically the default for <AnimatedOptions> is false)	Yes

isVisible

0.9

0.9

0.9

9.2.0

Indicates whether the menu popup is currently visible.

removeEventListener

extended

0.9

0.9

0.9

9.2.0

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function
in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to addEventListener.	No

show

0.9

0.9

0.9

9.2.0

Shows the menu popup.

Parameters:

Name	Type	Summary	Optional
options	MenuPopupShowParams	Includes options how the menu popup should be shown. Note that the default is to be animated.	No

Events

click

0.9

0.9

0.9

9.2.0

Fired when the user clicks at one of the menu popup items.

This event provides the properties title and index which relate to the name and position
of the clicked item inside the items property.

Event Properties:

Name	Type	Summary
index	Number	The index of the clicked item.
title	String	The title of the clicked item.

Examples

Example using multiple `items` and a `click` event.

The example below creates a new menu popup and shows it when the user clicks on the button.

var win = Ti.UI.createWindow({
    backgroundColor: "#fff",
});

var button = Ti.UI.createButton({
    title: "Show options"
});

win.add(button);

var menu = Ti.UI.iOS.createMenuPopup({
    items: ["Option 1", "Option 2"]
});

menu.addEventListener("click", function(e) {
    alert(e);
});

button.addEventListener("click", function() {
    menu.show({
      view: button
    });
});

win.open();