| Oracle® Enterprise Pack for Eclipse Oracle Mobile Application Framework (OEPE Edition)でのモバイル・アプリケーションの開発 リリース2.0 E56275-01 |
|
 前 |
 次 |
| Oracle® Enterprise Pack for Eclipse Oracle Mobile Application Framework (OEPE Edition)でのモバイル・アプリケーションの開発 リリース2.0 E56275-01 |
|
前 |
次 |
この章では、アプリケーションレベルとアプリケーション機能レベルの両方のユーザー・プリファレンス・ページを作成する方法について説明します。
この章には次の項が含まれます:
プリファレンスによって、エンド・ユーザーが構成可能な設定を追加できます。maf-application.xmlおよびmaf-feature.xmlの両方のファイル内で、<adfmf:preferences>要素を使用してユーザー・プリファレンス・ページを定義します。例14-1に示すとおり、<adfmf:preferenceGroup>と呼ばれる<adfmf:preferences>の子要素とその子要素によってユーザー・プリファレンスを定義します。これには、テキスト文字列、ドロップダウン・メニューや、例14-1のケースのようにアプリケーション設定の追加オプションをユーザーに提示する子ページなど、様々な形でオプションを提示するページを作成します。
また、<adfmf:preferences>要素を使用して、各アプリケーション機能内でユーザーが管理するプリファレンスを作成します。
例14-1 <adfmf:preferences>要素を使用したアプリケーションレベルのプリファレンスの定義
<?xml version="1.0" encoding="UTF-8" ?>
<adfmf:application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:adfmf="http://xmlns.oracle.com/adf/mf"
name="MobileApplication"
id="com.company.MobileApplication"
appControllerFolder="ApplicationController"
version="1"
vendor="oracle"
listener-class="application.LifeCycleListenerImpl">
<adfmf:description>This app created by Mobile Application Framework</adfmf:description>
<adfmf:featureReference id="PROD"/>
<adfmf:featureReference id="HCM"/>
<adfmf:featureReference id="Customers"/>
<adfmf:preferences>
<adfmf:preferenceGroup id="a" label="Prefs Group A">
<adfmf:preferenceBoolean id="a1_sound" label="Sound Effects"/>
<adfmf:preferenceNumber id="a2_retries" label="Retries" default="3"/>
<adfmf:preferenceList id="a3_background" label="Background" default="3">
<adfmf:preferenceValue name="None" value="0" id="pv4"/>
<adfmf:preferenceValue name="Field" value="1" id="pv1"/>
<adfmf:preferenceValue name="Galaxy" value="2" id="pv5"/>
<adfmf:preferenceValue name="Mountain" value="3" id="pv6"/>
</adfmf:preferenceList>
<adfmf:preferenceText id="a4_name" label="Default Name"/>
<adfmf:preferencePage id="aa" label="Prefs SubGroup AA">
<adfmf:preferenceGroup id="aa_sec" label="Security">
<adfmf:preferenceBoolean id="aa_sec_useSec" label="Use Security"/>
<adfmf:preferenceNumber id="aa_sec_timeout" label="Timeout (secs)" default="120"/>
</adfmf:preferenceGroup>
</adfmf:preferencePage>
</adfmf:preferenceGroup>
<adfmf:preferenceGroup id="b" label="Prefs Group B">
<adfmf:preferenceBoolean id="b_cloudSync" label="Cloud Sync"/>
<adfmf:preferenceList id="b_dispUsage" label="Display Usage As" default="1">
<adfmf:preferenceValue name="Percent" value="1" id="pv2"/>
<adfmf:preferenceValue name="Minutes" value="2" id="pv3"/>
</adfmf:preferenceList>
</adfmf:preferenceGroup>
</adfmf:preferences>
</adfmf:application>
図14-1では、子ユーザー・プリファレンス・ページを開くことでそれに続くオプションを提供する方法の例を示しています。
プリファレンス・ページは<adfmf:preferenceGroup>要素内で定義され、次の子要素が存在します。
<adfmf:preferencePage>: ユーザー・インタフェースに新しいページを指定します。
<adfmf:preferenceList>: ユーザーに特定のオプション・セットを提供します。
<adfmf:preferenceValue>: リスト要素を定義する子要素です。
<adfmf:preferenceBoolean>: ブール設定です。
<adfmf:preferenceText>: テキスト・プリファレンス設定です。
これらの要素とその属性の詳細は、Oracle Fusion Middleware Oracle Mobile Application Frameworkのタグ・リファレンスを参照してください。
アプリケーションおよびアプリケーション機能レベルの両方のプリファレンス・ページを作成する例については、PrefDemoサンプル・アプリケーションを参照してください。このサンプル・アプリケーションは、「ファイル」→「新」→「MAFサンプル」にあります。
PrefDemoアプリケーションは、アプリケーションレベルの設定ページと、MAF AMXとして実装されている3つのアプリケーション機能のプリファレンス・ページで構成されています。図14-2は、通常の設定ページから起動する、PrefDemoアプリケーションの設定ページを示しています。この図では、プリファレンス設定ページをiOSの設定アプリケーションから起動しています。
図14-3で「App」、「Feature1」(これが選択されています)および「Feature 2」と表示されているアプリケーション機能のプリファレンス・ページでは、MAF AMXブール・スイッチ、入力テキストおよび出力テキストの各コンポーネントから構築されたプリファレンス・ページの例が示されています。これらのコンポーネントは、EL(式言語)を使用してアプリケーション機能やその内部に構成されている様々な<adfmf:preferences>コンポーネントにアクセスします。詳細は、第14.3項「ユーザー・プリファレンス・ページ用に格納された値を取得するEL式の使用方法」を参照してください。
PrefDemoアプリケーションでは、ビュー・アクティビティとページ・リフレッシュが可能な制御フロー・ケースで構成される単一のバインド・タスク・フローによって、MAF AMXの各プリファレンス・ページが参照されます。
MAFアプリケーション機能エディタの「プリファレンス」セクション(図14-4を参照)では、<adfmf:preferenceGroup>内の子プリファレンス・ページ要素をネストすることでアプリケーションレベルのプリファレンス・ページ・セットを構築できます。このセクションでは、<adfmf:preferencesGroup>およびその子要素が同様に名付けられたオプション(「プリファレンス・グループ」、「プリファレンス・ページ」、「プリファレンス・リスト」など)として示され、これらを階層(またはツリー)にアセンブルします。
maf-application.xmlファイルを正しく構成するには、図14-4に示すMAFアプリケーション・エディタを使用してユーザー・プリファレンス・ページを構築します。そうすることで、選択したプリファレンス要素に対して適切な親、子、または兄弟関係を設定できる要素のみを選択できます。たとえば、図14-5には、プリファレンス・グループ要素であるOracleモバイル・アプリケーション内に挿入できるコンポーネントのみが示されています。また、このエディタでは、各プリファレンス要素に固有の属性に対して値を入力できます。
プリファレンス・ページを作成するには:
MAFアプリケーション・エディタで、「プリファレンス」を右クリックして「新」→「プリファレンス・グループ」を選択し、親<adfmf:preferenceGroup>要素を作成します。
新しいプリファレンス・グループに関して次の情報を入力します(図14-6を参照)。
プリファレンス・グループID要素の一意の識別子を入力します。
ユーザー・インタフェースに表示される説明テキストを入力します。ユーザー・インタフェースにこのテキストを表示する方法の例は、図14-1の例を参照してください。
|
注意: ELで無効な識別子とみなされる文字がプリファレンスIDに含まれている場合、ランタイムでそれを適切にサポートできないため、Oracle Enterprise Pack for Eclipseによって警告が表示されます。機能コンテンツ・ページでELを使用してプリファレンスを参照しようとしないかぎり、問題はありません。 |
プリファレンス・ページ・コンポーネントでは新しいユーザー・インタフェース・ページを作成できます。
始める前に:
プリファレンス・グループ要素を作成する必要があります。
新しいユーザー・プリファレンス・ページを作成するには:
「プリファレンス・グループ」要素を選択します。
右クリックして「新」→「プリファレンス・ページ」を選択します(図14-7を参照)。
「プリファレンス・ページの挿入」ダイアログ(図14-8を参照)に次のプリファレンス・ページ属性を定義します。
プリファレンス・ページ要素の一意の識別子を入力します。
ユーザー・インタフェースに表示される説明テキストを入力します。
子プリファレンス・グループ要素を挿入することでプリファレンス・ページのボディを作成します。
プリファレンス・ページを右クリックして「新」→「プリファレンス・グループ」を選択します。図14-8の場合、application_versionを右クリックします。
子プリファレンス・グループの一意の識別子と表示名を定義すると、これにプリファレンス・リスト要素などの他の要素を移入できます。
概要エディタでプリファレンス・ページとその子プリファレンス・グループ・コンポーネントを定義すると、Oracle Enterprise Pack for Eclipseでは、例14-2と同様の属性を使用して<adfmf:preferencePage>が生成されます。<adfmf:preferencePage>は、親<adfmf:preferenceGroup>要素内にネストされます。
例14-2 <adfmf:PreferencePage element>の追加
<adfmf:preferences>
<adfmf:preferenceGroup id="gen"
label="Oracle Mobile App">
<adfmf:preferencePage id="application_version"
label="Version">
<adfmf:preferenceGroup id="version_select"
label="Select Your Version">
<adfmf:preferenceList id="edition"
label="Edition"
default="PERSONAL">
adfmf:preferenceValue name="Enterprise"
id="pv2"/>
<adfmf:preferenceValue name="Personal"
value="PERSONAL"
id="pv1"/>
</adfmf:preferenceList>
</adfmf:preferenceGroup>
</adfmf:preferencePage>
</adfmf:preferences>
プリファレンス・リスト・コンポーネントを追加してオプションのリストを作成します。
始める前に:
プリファレンス・リストまたは他のすべてのリストに関連するコンポーネントの親としてプリファレンス・グループを作成する必要があります。
ユーザー・プリファレンス・リストを作成するには:
「プリファレンス・グループ」または「プリファレンス・ページ」を選択して、「追加」→「内部に挿入」→「プリファレンス・リスト」の順にクリックします。例14-2には、Select Your Versionという名前のプリファレンス・グループ・コンポーネントの子としてプリファレンス・リストを追加する例が示されています。
図14-10のように、リスト・プリファレンスに使用する次の属性を定義します。
一意の識別子を入力します。
ユーザー・インタフェースに表示される説明テキストを入力します。
リスト・プリファレンス(図14-10ではリスト・プリファレンスはedition)を右クリックして「プリファレンス値」を選択することで、アイテムのリストを定義します。
これで、リストの値を定義できます。図14-11に示すように、「ID」、「値」、「ラベル」に入力します。
ユーザーにデフォルト設定を提供するには、「デフォルト」を選択します。例14-2に示すように、<adfmf:preferenceList>要素内でデフォルト・ステータスは、default="ENTERPRISE"と定義されています。
プリファレンス・リスト・コンポーネントをプリファレンス・グループに追加し、一連のプリファレンス値を定義すると、例14-2に示すように、Oracle Enterprise Pack for Eclipseでは<adfmf:preferenceList>要素を使用して<adfmf:preferences>セクションが更新されます。
たとえば、例14-1を参照してください。
始める前に:
<adfmf:preferenceBoolean>要素は<adfmf:preferenceGroup>要素内にネストされる必要があるため、まずプリファレンス・グループ・コンポーネントを階層に挿入する必要があります。
ブール型のプリファレンス・リストを作成するには:
ブール型のプリファレンスを追加してそのデフォルト値を指定すると、例14-3に示すように、Oracle Enterprise Pack for Eclipseでは、<adfmf:preferenceBoolean>要素を使用してmaf-application.xmlファイルの<adfmf:preferences>セクションが更新されます。
図14-14に示すように、挿入オプションを使用して、ユーザーが情報を格納したりデフォルト・テキストを閲覧できるようにする「テキストのプリファレンス」というダイアログを作成します。
始める前に:
プリファレンス・グループ要素を作成します。
テキストのプリファレンスを作成するには:
プリファレンス・グループ要素を選択します。
右クリックして「新」→「テキストのプリファレンス」を選択します。
「テキストのプリファレンスの挿入」ダイアログ(図14-15を参照)に次の情報を入力して、「OK」をクリックします。
一意の識別子を入力します。
ユーザー・インタフェースに表示される説明テキストを入力します。
デフォルトのテキスト値を入力します。
テキストのプリファレンスを追加してそのデフォルト値を指定すると、例14-4に示すように、Oracle Enterprise Pack for Eclipseでは、<adfmf:preferenceText>要素を使用してmaf-application.xmlファイルの<adfmf:preferences>セクションが更新されます。
例14-4 <adfmf:preferenceText>要素の追加
<adfmf:preferenceGroup id="security" label="Security">
<adfmf:preferenceText id="serviceURL"
label="Security URL"
default="http://security.example.com/provider"/>
<adfmf:preferenceText id="username"
label="User Name"/>
<adfmf:preferenceText id="password"
label="Password"
secret="true"/>
</adfmf:preferenceGroup>
セキュリティURL、ユーザー名およびパスワードのプリファレンス設定を定義するプリファレンス・グループ要素は図14-16のように表示されます。
図14-16は、セキュリティURLがシードされた値、ユーザー名が入力値の<adfmf:preferenceText>要素を示しています。MAFのプリファレンスはiOS設定アプリケーションと統合されているため、パスワード入力テキストのsecret="true"属性により、ユーザーの入力を黒丸で覆うiOSの表記規則に従うアプリケーションとなります。詳細は、iOS Developer Library (http://developer.apple.com/library/ios/navigation/)で入手可能な『Settings Application Schema Reference』のisSecureテキスト・フィールド要素の説明および第14.4項「プラットフォームによる表示の差異」を参照してください。
モバイル・アプリケーションをデプロイすると、アプリケーション全体のプリファレンス設定ページがiOSデバイスの設定アプリケーションなど、デバイスのグローバル設定アプリケーションに伝播されます。詳細は、付録C「デプロイメントでのプリファレンスの変換」を参照してください。
第4.14項「機能アーカイブ・ファイルの使用」で説明するように、アプリケーション機能をモバイル・アプリケーションと別個に配布するには、そのアプリケーション機能を含む機能アプリケーション・アーカイブ(FAR) .jarファイルを、別のモバイル・アプリケーションに追加します。その後、このアプリケーション機能を、アプリケーションのmaf-application.xmlファイル内で参照します。アプリケーション機能において、使用先のアプリケーション用に定義した全般的なプリファレンスだけでなく、特定のユーザー・プリファレンスのセットが必要になる場合は、MAF機能エディタの「プリファレンス」タブを使用して、該当するプリファレンスを定義できます(図14-17を参照)。第14.1項「モバイル・アプリケーションのユーザー・プリファレンス・ページの作成」の説明に従い、アプリケーション・レベルのプリファレンスを構築する方法で、アプリケーション機能のプリファレンスを構築します。MAF機能エディタでプリファレンスを定義したら、次は第6.3項「UIコンポーネントの作成と使用方法」で説明したブール・スイッチ、入力および出力の各コンポーネントに埋め込むMAF AMXページを参照するアプリケーション機能を作成することによって実際のプリファレンス・ページを作成します。
アプリケーション機能レベルのプリファレンス・ページを作成する場合、例14-5の入力テキスト・コンポーネントなど、MAF AMXコンポーネントに対してEL式を追加します。
機能レベルのプリファレンス・ページを作成するには:
ページのAMXエディタを開きます。
XML要素を選択します(たとえば、例14-5の場合は<amx:inputTest ...>)。
「プロパティ」ペインを開きます。
「プロパティ」ペインで「共通」タブを選択します。
Value属性の「バインディング」ボタンをクリックします。これによって、Oracle Enterprise Pack for EclipseのEL式ビルダーが開きます。
例14-5 MAF AMXコンポーネントでELを使用したプリファレンス値の参照
<amx:inputText label="Number" id="it1" inputType="number"
value="#{preferenceScope.feature.Feature1.f1top.f1Number}"/>
例14-5に示すとおり、EL式では、preferenceScopeオブジェクトを使用して、アプリケーションがアプリケーション機能レベルのプリファレンスにアクセスできるようにします。これらのEL式の書式は次のとおりです。
preferenceScope.feature.feature-id.group-id.property-id
図14-18は、式ビルダーを使用したEL式の作成について説明しています。アプリケーション機能(<adfmf:feature id="Feature1">)のID、プリファレンス・グループ(<adfmf:preferenceGroup id="f1top">)のID、プリファレンス・プロパティ(<adfmf:preferenceNumber id="f1Number">)のIDなど、maf-feature.xml内の様々なコンポーネントに対して構成されるIDによってプリファレンス自体が指定されています。
EL式には、ゼロ個以上のgroup-id要素およびproperty-id要素が含まれる可能性があります。
EL式には次の解決パターンがあります。
JavaScriptレイヤーから、次のJavaScript関数を使用してEL値式を解決します。
adf.mf.el.getValue(expression, success, failed)
adf.mf.el.getValueの解決では、まずJS-ELパーサーとJavaScriptコンテキスト・キャッシュをローカルで使用して式の解決を試みます。式がローカルで解決できない場合は、その式を埋込みJavaレイヤーに評価用として渡し、そこでJava ELパーサーによって解決されます。これは、モデルのgetValueメソッドに対するGenericInvokeRequestを使用して処理されます。
Javaレイヤーで、次の手法を使用してEL値式を解決します。
String val = AdfmfJavaUtilities.evaluateELExpression("#{preferenceScope.feature.f0.vendor}");
setValueメソッドでは、次のように式を解決します。
ValueExpression ve = AdfmfJavaUtilities.getValueExpression("#{preferenceScope.feature.f0.vendor}");
ve.setValue(AdfmfJavaUtilities.getADFELContext(), value);
EL式の評価には、preferenceScopeオブジェクトの検索が含まれます。評価は左から右に行われ、各トークンは別個に解決されます。トークンが解決されると、これは次の(その右側の)トークンの解決に使用されます。
preferenceScopeオブジェクトがない場合は、プリファレンスを公開できません。preferenceScopeオブジェクトの詳細は、第7.3.5.3項「モバイル・アプリケーション・フレームワークのオブジェクト・カテゴリについて」を参照してください。
MAFでは、ネイティブUI (UIView、UIViewControllerなど)に提供されているAPIが統合され、iOSプラットフォームで一定の構成が可能です。
ネイティブUIを初期化すると、ADFSession オブジェクトのインスタンスが利用可能になります。そのgetPreferencesメソッドを使用して、MAFに対し、maf-application.xmlファイルで定義されているアプリケーションで利用可能なプリファレンスのリストを提供するように命令できます。例14-6に示すとおり、このメソッドでは、プリファレンスにid、valueおよびlabelを含めることができるプリファレンス・プロパティ・オブジェクトのNSArray*が戻されます。このAPIコールでは、エンド・ユーザーによって特定のプリファレンスの値が提供されたこと、またはプリファレンスのデフォルト値が戻されていることのいずれかを確認します。
例14-6 プリファレンスの取得
//...
-(id) initWithADFSession:(id<ADFSession>) providedSession
{
id me = [self init];
session = providedSession;
//...
// Dump the preferences to the data display
NSArray* prefsArray = [session getPreferences];
NSString* prefs = [prefsArray JSONRepresentation];
self.theData.text = [[NSString alloc ] initWithFormat:
:@"%@\nUser Preferences = --> %@ <--", self.theData.text, prefs];
//...
return me;
}
MAFのプリファレンス・ページでは、iOSおよびAndroidの両プラットフォームでネイティブのルック・アンド・フィールが維持されます。その結果、MAFのプリファレンス・ページの表示は2つのプラットフォームで異なります。表14-1に示すとおり、iOSプラットフォームではプリファレンスがインラインで表示されるため、そのシステムではダイアログ・ページを起動しません。いくつかの例外を除いて、Androidプラットフォームではこれらのコンポーネントがダイアログで表示されます。
表14-1 プラットフォームごとのプリファレンス・コンポーネントの比較
| コンポーネント | iOS | iOSの表示例 | Android | Androidの表示例 |
|---|---|---|---|---|
|
プリファレンス・グループ(カテゴリ選択) |
iOSでは、その親プリファレンス・グループ内にプリファレンス要素が表示されます。 |
 |
Androidでは、その親プリファレンス・グループ内にプリファレンス要素が表示されます。 |
 |
|
ブール型のプリファレンス・リスト |
ブール型のプリファレンスは、onとoffなどのペアの値で表示されます。 |
 |
Androidでは、ブール型のプリファレンスをチェック・ボックスで表示します。 |
 |
|
テキストのプリファレンス |
iOSはテキストをインラインで表示します。 |
 |
Androidはデフォルト・テキストを入力フィールド内に表示します。 |
 |
|
テキストのプリファレンス(機密入力テキスト) |
iOSプラットフォームでは、ユーザーはテキストをインラインで入力し、各文字はその入力後に黒丸で覆われます。詳細は、第14.1.1.8項「テキストのプリファレンスを定義する場合の処理」を参照してください。 |
 |
Androidでは、入力テキスト・ダイアログが起動し、各文字はその入力後に黒丸で覆われます。 |
 |
|
単一のアイテム選択リスト(プリファレンス・リストから) |
iOSプラットフォームでは別のプリファレンス・ページに単一のアイテム選択リストが表示されます。 |
 |
Androidでは、ダイアログ内に単一のアイテム選択リストが表示されます。 |
 |
|
プリファレンス・ページ |
iOSでは、プリファレンス・グループから子プリファレンス・ページを起動します。 |
 |
Androidでは、プリファレンス・グループから子プリファレンス・ページを起動します。 |
 |
iOSおよびAndroidのプラットフォームには設定アプリケーションがありますが、図14-19のプリファレンスで示すように、設定アプリケーションへのアプリケーション・レベルのプリファレンスの統合はiOSプラットフォームのみでサポートされます。
Androidデバイスでは、ユーザーは、アプリケーションが実行されている場合のみ、図14-20のようなアプリケーション固有のプリファレンス・ページにアクセスします。
