opensocial.Enum (v0.7)

 概要     詳細

Class opensocial.Enum

すべての enum オブジェクトのベース インターフェースです。このクラスを使うと、通常、いくつかの共通した値をとるフィールドで定数を使うことができます。このクラスの主な使い方は 2 つあります。

ガジェットで、ある人がどの程度喫煙するのかだけ表示するには、次のように記述します。

html = "This person smokes: " + person.getField('smoker').getValue();

この値フィールドは、コンテナにより正しくセットアップされます。ここで、コンテナはガジェットの値をローカライズして、常に適切な内容を示すようにすることもできます。

ガジェットで smoker フィールドを利用するロジックを利用するには、次のように記述します。

if (person.getField('smoker').getKey() != "NO") { //gadget logic here }

注: その個人の smoker フィールドが、必ず標準の enum タイプのいずれかをとるようにできない場合、キーが null になることがあります。一方、値が null になることはありません。

メソッドの概要

 String getDisplayValue()

この enum の値。

 String getKey()

ガジェットのロジックにはこれを使います。

 

メソッドの詳細

getDisplayValue

String getDisplayValue()

この enum の値。ユーザーに表示される文字列になります。コンテナでローカライズがサポートされている場合、文字列をローカライズできます。

戻り値:
String enum の値

getKey

String getKey()

ガジェットのロジックにはこれを使います。キーが null の場合、値は定義済みの enum に当てはまりません。

戻り値:
String enum のキー。以下の定義済み enum のいずれかである必要があります。

---