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

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

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

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)