基礎的なUIのセットアップ

こちらの項目では、UIP APIに基礎的なUIをセットアップする方法を紹介します。このタイプのセットアップは極めてシンプルであり、最小限のコーディングで実現することができます。つまり、プラグインは、必要なユーザーインプットデータを表示し、保持する方法を定義するパラメーターオブジェクトの一覧としてUIを定義します。

シンプルな静的UIを作成するために必要なのは、以下の3つのメソッドに加え、パラメーターclassとViewOptionsの理解です。

protected void setupParameters()

プラグインは、構成に必要なUI定義とともにAPIを提供するために、こちらのメソッドを実装しなくてはいけません。一般的に、プラグインは「addParameter(Parameter)」を呼び出すことで、パラメーターオブジェクトを作成し、これを追加します。

例：

@Override
protected void setupParameters() {
    Parameter p = new Parameter();
    ...
 
    addParameter(p);
}

protected final void addParameter(Parameter p)

プラグインは、作成する新規パラメーターのAPIに通知をするために、このメソッドを使用します。新規パラメーターは、「setupParameters」メソッドの外部に追加された場合、保持されないことに注意をしてください。上記の例を参照してください。

public final Object getParameterValue(String key)

こちらのメソッドは、ユニークキー「key」とともに、パラメーターに現在の値を返します。

例：

Object paramVal = getParameterValue("SOME_KEY");
if (paramVal != null && paramVal.equals("INTERESTING_CONFIG")) {
   // Do something interesting
   ...
}

public void setParameterValue(String key, Object value)

こちらのメソッドは、パラメーターキーに格納された値を設定します。

例：

Object paramVal = getParameterValue("SOME_KEY");
if (shouldChangeThisValue(paramVal)) {
   Object newValue = new Object();
   setParameterValue("SOME_KEY", newValue);
}

public void clearParameterValue(String key)

「setParameterValue(key, null)」の呼び出しと同等です。しかし、このメソッドは、パラメーター値マップからパラメーターキーの削除も行います。

例：

Object paramVal = getParameterValue("SOME_KEY");
if (shouldRemoveThisValue(paramVal)) {
   clearParameterValue("SOME_KEY");
}

public void getParameter(String key)

すでにセットアップしたパラメーターを、与えられたキーとともに取得します。このキーのパラメーターが存在しない場合は、nullを返します。

例：

if (needToUpdateParameter()) {
   Parameter p = getParameter("SOME_KEY");
   ...
}

前項：パラメーターClass
後項：動的なUIのセットアップ