背景情報とタスク

汎用のクライアント変数と関数

参照情報として、このセクションでは Zen Mojo クライアント・メソッド内で使用できる主な汎用の変数と関数をいくつか示します。

• this — この標準 JavaScript 変数は、変数を使用する場所に応じて、テンプレートまたはページの現在のインスタンスを表します。

  つまり、テンプレート・メソッド内で this を使用すると、テンプレート・インスタンスが返されます。ページ・メソッド内で this を使用すると、ページ・インスタンスが返されます。

• zenPage — このインターシステムズ変数は、現在のページオブジェクトを表します。

• zen(id) — このインターシステムズ関数は、documentView、または指定された ID を持つ他のコンポーネントへの参照を返します。

  レイアウト・オブジェクトはコンポーネントではないため、この関数を使用してレイアウト・オブジェクトにアクセスすることはできないことに注意してください。レイアウト・オブジェクトにアクセスするには、documentView コンポーネントのメソッドを使用します。このドキュメントで後述する “レイアウト・オブジェクトとの対話操作” を参照してください。

• zenGet(property_or_array_item, optional_default_value) — このインターシステムズ関数は、指定されたオブジェクト・プロパティまたは配列項目を検査して、シナリオに応じてその値、オプションの既定値、または空の文字列を返します。

  具体的には、プロパティまたは配列項目が定義されている場合、関数はその値を返します。項目が定義されておらず、2 番目の引数が指定されている場合、この関数は 2 番目の引数によって指定された値を返します。項目が定義されておらず、2 番目の引数が指定されていない場合、この関数は空の文字列 ('') を返します。

  例えば、以下のコードを考えてみます。

  if (myobj.prop4 == undefined) {
      var returnval = 'No information available';
  }
  

  

  このコードは、以下と同等です。

  var returnval=zenGet(myobj.prop4,'No information available');
  

  

• console.log(argument) — この標準 JavaScript 関数は、Web コンソール・ログにエントリを生成します。

• alert(argument) — この標準 JavaScript 関数は、指定したメッセージを表示するポップアップを生成します。この関数は、診断目的にのみ使用することをお勧めします。

• zenPage.showMessage(argument) — このインターシステムズ関数は、指定したメッセージを表示するポップアップ・メッセージを生成します。この関数は、ユーザ向けのメッセージにのみ使用することをお勧めします。

インターシステムズ提供のその他の変数と関数については、"Zen アプリケーションの開発" の “クライアント側の関数、変数、およびオブジェクト” を参照してください。その他の標準 JavaScript オプションについては、該当する JavaScript ドキュメントを参照してください。

stash ファイルへの値の保存

場合によっては、複数のレイアウト内でデータを使用できるように、クライアント側データを一時的に保存する必要が生じることがあります。例えば、サーバにデータを送信する前に、複数のレイアウトを使用してユーザからデータを収集する必要があることが考えられます。または、あるレイアウトのデータを別のレイアウト内で表示したい場合もあります。あるいは、内部 ID を追跡する必要が生じることもあります。このような場合には、値を stash ファイルに保存してから、後で使用できます。値を stash ファイルに保存するには、状況に応じて、ページ・インスタンスまたはテンプレート・インスタンスのプロパティにその値を保存します。

• ページ・インスタンスのプロパティに値を保存する場合は、zenPage 変数のプロパティを設定します。zenPage 変数は、ページ・クラスとテンプレート・クラスの両方のクライアント・メソッド内で使用できます。

  プロパティ名の先頭にアンダースコア文字 (_) を付けることにより、このプロパティがクライアント上でのみ定義されるようにします。内部で使用されるプロパティ名との競合を避けるために、プロパティ名の最初を _myApp や同様の短い文字列にすることを検討してください。

• テンプレート・インスタンスのプロパティに値を保存する場合は、テンプレート・クラスのクライアント・メソッド内で this 変数のプロパティを設定します。

  this はページ・クラス内でも使用できることに注意してください。そのコンテキストでは、this はページ・インスタンスを指します。混乱を避けるために、stash ファイルに保存される値 (ページまたはテンプレート) に対して単一のコンテキストを選択し、そのコンテキストを一貫して使用することをお勧めします。

stash ファイルに保存された値が必要なくなったときは、delete を使用して削除します。以下に例を示します。

delete this._MyNewValues;

JSON オブジェクトの文字列への変換

Zen Mojo は、以下のように、クライアントとサーバの間の通信をすべて JSON オブジェクトとしてパッケージ化します。

• サーバからデータを取得するには、テンプレート・メソッド %OnGetJSONContent() を (間接的に) 呼び出します。このメソッドは、出力として Zen プロキシ・オブジェクトを返します。Zen Mojo はこのオブジェクトを使用して同等の JSON オブジェクトを作成し、その JSON オブジェクトをクライアントに送信します。

• サーバにデータを送信するには、ページの submitData() メソッドを呼び出します。入力として、データを含む JSON オブジェクトを使用する必要があります。

ただし、値を stash ファイルに保存する際には、stash ファイルに保存できるのが単一の JavaScript 値 (オブジェクトでない) のみであることに注意してください。JSON オブジェクト全体を stash ファイルに保存する必要がある場合は、まずユーティリティ・メソッド JSON.stringify() を使用します。このメソッドは、1 つの引数 (JSON オブジェクト) を取り、文字列を返します。その後、返された文字列を stash ファイルに保存します。

JSON.stringify() ユーティリティ・メソッドは、クライアント・メソッド内で使用できます。

名前付け規約の設定

名前付け規約を定めておくと、混乱を避けるのに役立ちます。このセクションでは、以下の項目について説明します。

• クラス名

• メソッド名

• コンテンツ・オブジェクトと JSON プロバイダ

• キー

Zen Mojo プログラムでは大文字と小文字が区別されます。つまり、a と A は同じではありません。