View Source Improve this doc

ons

Onsen UIで利用できるグローバルなオブジェクトです。このオブジェクトは、AngularJSのスコープから参照することができます。

メソッド概要 #

シグネチャ 概要
ready(callback) アプリの初期化に利用するメソッドです。渡された関数は、Onsen UIの初期化が終了している時点で必ず呼ばれます。
bootstrap([moduleName, [dependencies]]) Onsen UIの初期化を行います。Angular.jsのng-app属性を利用すること無しにOnsen UIを読み込んで初期化してくれます。
enableAutoStatusBarFill() iOS7以上で、ステータスバー部分の高さを自動的に埋める処理を有効にします。
disableAutoStatusBarFill() iOS7以上で、ステータスバー部分の高さを自動的に埋める処理を無効にします。
findParentComponentUntil(name, [dom]) 指定されたdom引数の親要素をたどってコンポーネントを検索します。
findComponent(selector, [dom]) CSSセレクタを使ってコンポーネントのオブジェクトを検索します。
setDefaultDeviceBackButtonListener(listener) デバイスのバックボタンのためのデフォルトのハンドラを設定します。
disableDeviceBackButtonHandler() デバイスのバックボタンのイベントを受け付けないようにします。
enableDeviceBackButtonHandler() デバイスのバックボタンのイベントを受け付けるようにします。
isReady() Onsen UIがすでに初期化されているかどうかを返すメソッドです。
compile(dom) 通常のHTMLの要素をOnsen UIのコンポーネントにコンパイルします。
isWebView() Cordovaで実行されているかどうかを返すメソッドです。
createAlertDialog(page, [options]) テンプレートからアラートダイアログのインスタンスを生成します。
createDialog(page, [options]) テンプレートからダイアログのインスタンスを生成します。
createPopover(page, [options]) テンプレートからポップオーバーのインスタンスを生成します。

メソッド

ready(callback) #

アプリの初期化に利用するメソッドです。渡された関数は、Onsen UIの初期化が終了している時点で必ず呼ばれます。

パラメーター
名前 型 概要
callback Function Onsen UIが初期化が完了した後に呼び出される関数オブジェクトを指定します。

bootstrap([moduleName, [dependencies]]): Object #

Onsen UIの初期化を行います。Angular.jsのng-app属性を利用すること無しにOnsen UIを読み込んで初期化してくれます。

返り値: AngularJSのModuleオブジェクトを表します。

パラメーター
名前 型 概要
moduleName String Angular.jsでのモジュール名
dependencies Array 依存するAngular.jsのモジュール名の配列

enableAutoStatusBarFill() #

iOS7以上で、ステータスバー部分の高さを自動的に埋める処理を有効にします。

disableAutoStatusBarFill() #

iOS7以上で、ステータスバー部分の高さを自動的に埋める処理を無効にします。

findParentComponentUntil(name, [dom]): Object #

指定されたdom引数の親要素をたどってコンポーネントを検索します。

返り値: コンポーネントのオブジェクトを返します。もしコンポーネントが見つからなかった場合にはnullを返します。

パラメーター
名前 型 概要
name String コンポーネント名を指定します。例えばons-pageなどを指定します。
dom Object|jqLite|HTMLElement $eventオブジェクト、jqLiteオブジェクト、HTMLElementオブジェクトのいずれかを指定できます。

findComponent(selector, [dom]): Object #

CSSセレクタを使ってコンポーネントのオブジェクトを検索します。

返り値: コンポーネントのオブジェクトを返します。もしコンポーネントが見つからなかった場合にはnullを返します。

パラメーター
名前 型 概要
selector String CSSセレクターを指定します。
dom HTMLElement 検索対象とするDOM要素を指定します。

setDefaultDeviceBackButtonListener(listener) #

デバイスのバックボタンのためのデフォルトのハンドラを設定します。

パラメーター
名前 型 概要
listener Function デバイスのバックボタンが押された時に実行される関数オブジェクトを指定します。

disableDeviceBackButtonHandler() #

デバイスのバックボタンのイベントを受け付けないようにします。

enableDeviceBackButtonHandler() #

デバイスのバックボタンのイベントを受け付けるようにします。

isReady(): Boolean #

Onsen UIがすでに初期化されているかどうかを返すメソッドです。

返り値: 初期化されているかどうかを返します。

compile(dom) #

通常のHTMLの要素をOnsen UIのコンポーネントにコンパイルします。

パラメーター
名前 型 概要
dom HTMLElement コンパイルする要素を指定します。

isWebView(): Boolean #

Cordovaで実行されているかどうかを返すメソッドです。

返り値: Cordovaで実行されている場合にtrueになります。

createAlertDialog(page, [options]): Promise #

テンプレートからアラートダイアログのインスタンスを生成します。

返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。

パラメーター
名前 型 概要
page String pageのURLか、もしくはons-templateで宣言したテンプレートのid属性の値を指定できます。
options Object オプションを指定するオブジェクト。
options.parentScope Object ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。

createDialog(page, [options]): Promise #

テンプレートからダイアログのインスタンスを生成します。

返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。

パラメーター
名前 型 概要
page String pageのURLか、もしくはons-templateで宣言したテンプレートのid属性の値を指定できます。
options Object オプションを指定するオブジェクト。
options.parentScope Object ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。

createPopover(page, [options]): Promise #

テンプレートからポップオーバーのインスタンスを生成します。

返り値: ポップオーバーのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。

パラメーター
名前 型 概要
page String pageのURLか、もしくはons-templateで宣言したテンプレートのid属性の値を指定できます。
options Object オプションを指定するオブジェクト。
options.parentScope Object ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。

議論 #