Titanium 2.X

Titanium.UI.iPhone

> Titanium.UI.iPhone

The iPhone/iPad-specific UI capabilities. All properties, methods and events in this namespace will only work on Apple iOS systems.

  • 0.5
  • 0.5
Defined By

Properties

Titanium.UI.iPhone
MODAL_PRESENTATION_CURRENT_CONTEXT : Numberreadonly

View presented with the same style as its parent window.

View presented with the same style as its parent window.

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window presentation style constants MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.

Titanium.UI.iPhone
MODAL_PRESENTATION_FORMSHEET : Numberreadonly

Window width and height are smaller than those of the screen and the view is centered on the screen.

Window width and height are smaller than those of the screen and the view is centered on the screen.

If the system is in a landscape orientation and the keyboard is visible, the position of the view is adjusted upward so that the view remains visible. All uncovered areas are dimmed and do not respond to touch to prevent the user from interacting with them.

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window presentation style constants MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.

Titanium.UI.iPhone
MODAL_PRESENTATION_FULLSCREEN : Numberreadonly

Window covers the screen.

Window covers the screen.

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window presentation style constants MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.

Titanium.UI.iPhone
MODAL_PRESENTATION_PAGESHEET : Numberreadonly

Window height is the height of the screen and width is equal to screen width in a portrait orientation.

Window height is the height of the screen and width is equal to screen width in a portrait orientation.

Any uncovered areas are dimmed and do not respond to touch, to prevent the user from interacting with them. In portrait orientations, this option is essentially the same as MODAL_PRESENTATION_FULLSCREEN.

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window presentation style constants MODAL_PRESENTATION_CURRENT_CONTEXT, MODAL_PRESENTATION_FORMSHEET, MODAL_PRESENTATION_FULLSCREEN, and MODAL_PRESENTATION_PAGESHEET.

Titanium.UI.iPhone
: Numberreadonly
When the window is presented, its view slides up from the bottom of the screen. ...

When the window is presented, its view slides up from the bottom of the screen. On dismissal, the view slides back down (default.)

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.

Titanium.UI.iPhone
: Numberreadonly
When the window is presented, the current view fades out while the new view fades in at the same time. ...

When the window is presented, the current view fades out while the new view fades in at the same time. On dismissal, a similar type of cross-fade is used to return to the original view.

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.

Titanium.UI.iPhone
: Numberreadonly
When the window is presented, the current view initiates a horizontal 3D flip from right-to-left, resulting in the r...

When the window is presented, the current view initiates a horizontal 3D flip from right-to-left, resulting in the revealing of the new view as if it were on the back of the previous view. On dismissal, the flip occurs from left-to-right, returning to the original view.

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.

Titanium.UI.iPhone
: Numberreadonly
When the window is presented, one corner of the current view curls up to reveal the modal view underneath. ...

When the window is presented, one corner of the current view curls up to reveal the modal view underneath. On dismissal, the curled up page unfurls itself back on top of the modal view.

A modal view presented using this transition is itself prevented from presenting any additional modal views. This transition style is supported only if the window is presenting a MODAL_PRESENTATION_FULLSCREEN modal presentation style.

Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.

One of the group of modal window transition style constants MODAL_TRANSITION_STYLE_COVER_VERTICAL, MODAL_TRANSITION_STYLE_CROSS_DISSOLVE, MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL, and MODAL_TRANSITION_STYLE_PARTIAL_CURL.

Titanium.UI.iPhone
appBadge : Number

Value of the badge for the application's springboard icon.

Value of the badge for the application's springboard icon.

Titanium.UI.iPhone
appSupportsShakeToEdit : Boolean

Determines whether the shake to edit system-wide capability is enabled.

Determines whether the shake to edit system-wide capability is enabled.

Titanium.UI.iPhone
statusBarHidden : Boolean

Determines whether the status bar is hidden.

Determines whether the status bar is hidden.

Titanium.UI.iPhone
statusBarStyle : Number

Determines the status bar color style.

Defined By

Methods

( String name, Callback<Object> callback )
Adds the specified callback as an event listener for the named event. ...

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Creates and returns an instance of Titanium.UI.iPhone.NavigationGroup. ...

Creates and returns an instance of Titanium.UI.iPhone.NavigationGroup.

  • 1.2
  • 1.2

Parameters

Returns

( String name, Dictionary event )
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • name : String

    Name of the event.

  • event : Dictionary

    A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

  • void
Titanium.UI.iPhone
( ) : Number
Gets the value of the appBadge property. ...

Gets the value of the appBadge property.

Returns

  • Number
Titanium.UI.iPhone
( ) : Boolean
Gets the value of the appSupportsShakeToEdit property. ...

Gets the value of the appSupportsShakeToEdit property.

Returns

  • Boolean
Titanium.UI.iPhone
( ) : Boolean
Gets the value of the statusBarHidden property. ...

Gets the value of the statusBarHidden property.

Returns

  • Boolean
Titanium.UI.iPhone
( ) : Number
Gets the value of the statusBarStyle property. ...

Gets the value of the statusBarStyle property.

Returns

  • Number
Titanium.UI.iPhone
( [hideStatusBarParams params] )
Hides the status bar. ...

Hides the status bar.

Parameters

Returns

  • void
( String name, Callback<Object> callback )
Removes the specified callback as an event listener for the named event. ...

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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Titanium.UI.iPhone
( Number appBadge )
Sets the value of the appBadge property. ...

Sets the value of the appBadge property.

Parameters

  • appBadge : Number

    New value for the property.

Returns

  • void
Titanium.UI.iPhone
( Boolean appSupportsShakeToEdit )
Sets the value of the appSupportsShakeToEdit property. ...

Sets the value of the appSupportsShakeToEdit property.

Parameters

  • appSupportsShakeToEdit : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.iPhone
( Boolean statusBarHidden )
Sets the value of the statusBarHidden property. ...

Sets the value of the statusBarHidden property.

Parameters

  • statusBarHidden : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.iPhone
( Number statusBarStyle )
Sets the value of the statusBarStyle property. ...

Sets the value of the statusBarStyle property.

Parameters

  • statusBarStyle : Number

    New value for the property.

Returns

  • void
Titanium.UI.iPhone
( [showStatusBarParams params] )
Shows the status bar. ...

Shows the status bar.

Parameters

Returns

  • void