フォームのフィールド タイプ
この付録では、Open Automation モジュールでフォームを作成する際にフォーム フィールドのタイプを定義するために使用するフォームのフィールド タイプの一覧を提供します。フォームのフィールドを定義するには、フォームのフィールドのラベルとタイプを指定することが必須です。
-
FIELD_TYPE_TEXT
FIELD_TYPE_TEXT はフィールドをテキスト フィールドとして定義します。これは、デフォルトのフィールド タイプです。フォームのフィールド注釈にフィールド タイプが定義されていないと、フォームのフィールドはデフォルトでテキスト タイプとして分類されます。
属性 -
maxLength:テキスト フィールドに入力できる最大文字数を指定します。
-
Size:次のいずれかの値を使用して、テキスト フィールドのサイズを設定します。 -
FIELD_SIZE_SMALL
-
FIELD_SIZE_MEDIUM
-
FIELD_SIZE_LARGE
-
FIELD_SIZE_MEDIUM_SMALL
-
FIELD_SIZE_LARGE_SMALL
-
FIELD_SIZE_SMALL_MEDIUM
-
FIELD_SIZE_LARGE_MEDIUM
-
FIELD_SIZE_SMALL_LARGE
-
FIELD_SIZE_MEDIUM_LARGE
-
サンプル @FormField(label = "Name", help = "Name", size =FormFieldDefinition.FIELD_SIZE_SMALL) private String name;
-
-
FIELD_TYPE_NUMBER
FIELD_TYPE_NUMBER はフィールドを数値フィールドとして定義します。
属性 -
minValue:数値フィールドの最小許容値を指定します。たとえば、1 です。
-
maxValue:数値フィールドの最大許容値を指定します。たとえば 65535 と入力します。
サンプル @FormField(label = "FIELD_TYPE_NUMBER", type = FormFieldDefinition.FIELD_TYPE_NUMBER, minValue = 1, maxValue = 65535) private int number;
-
-
FIELD_TYPE_TABULAR
FIELD_TYPE_TABULAR はフィールドをテーブルとして定義します。
属性 -
table:表形式フィールドの名前を指定します。
-
multiline:この属性はブール型です。テーブルに複数の行を追加できるようにするには、true に設定します。
サンプル @FormField(label = "FIELD_TYPE_TABULAR", type = FormFieldDefinition.FIELD_TYPE_TABULAR, table = SimpleTabularProvider.SIMPLE_TABULAR_PROVIDER, multiline = true) private String[] plainTabularValues;
-
-
FIELD_TYPE_BOOLEAN
FIELD_TYPE_BOOLEAN はフィールドをブール型として設定します。フィールドを選択するとフィールドの値が true に設定され、フィールドを選択しなければフィールドの値が false に設定されます。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_BOOLEAN", type = FormFieldDefinition.FIELD_TYPE_BOOLEAN) private boolean boolType;
-
FIELD_TYPE_LABEL
FIELD_TYPE_LABEL 引数を使用して、フィールドのラベルを指定できます。
属性 -
htmlPopupTag:ポップアップ ウィンドウにロードする URL を指定します。
-
htmlPopupLabel:ポップアップ ウィンドウのラベルを指定します。
-
htmlPopupStyle:次のいずれかの値を使用して、ラベルのポップアップ スタイルを設定します。
-
INFO_TAG
-
HELP_TAG
-
CUSTOM_TAG
-
INFO_URL
-
HELP_URL
-
CUSTOM_URL
-
サンプル @FormField(type = FormFieldDefinition.FIELD_TYPE_LABEL, label = "FIELD_TYPE_LABEL", htmlPopupTag = "http://www.cisco.com",htmlPopupLabel = "http://www.cisco.com", htmlPopupStyle = HtmlPopupStyles.CUSTOM_URL) private String dummyLink;
-
-
FIELD_TYPE_EMBEDDED_LOV
FIELD_TYPE_EMBEDDED_LOV は、フィールドを値のリスト(LOV)が組み込まれるタイプとして定義し、ユーザが値のリストからいずれかの値を選択できるようにします。
属性 -
lov または lovProvider のいずれかを属性として指定できます。
サンプル @FormField(label = "FIELD_TYPE_EMBEDDED_LOV", help = "Value", type = FormFieldDefinition.FIELD_TYPE_EMBEDDED_LOV, lovProvider = SimpleLovProvider.SIMPLE_LOV_PROVIDER) private String value;
-
-
FIELD_TYPE_PASSWORD
FIELD_TYPE_PASSWORD はフィールドをパスワード フィールドとして設定します。パスワード フィールドに入力する文字はマスクされます(アスタリスクまたは円として表示されます)。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_PASSWORD", type = FormFieldDefinition.FIELD_TYPE_PASSWORD) private String password;
-
FIELD_TYPE_DATE
FIELD_TYPE_DATE はフィールドを日付入力フィールドとして定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_DATE", type = FormFieldDefinition.FIELD_TYPE_DATE) private long dateLong;
-
FIELD_TYPE_DATE_TIME
FIELD_TYPE_DATE_TIME はフィールドを日時入力フィールドとして定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_DATE_TIME", type = FormFieldDefinition.FIELD_TYPE_DATE_TIME) private long dateTime;
-
FIELD_TYPE_MULTI_SELECT_LIST
FIELD_TYPE_MULTI_SELECT_LIST は、複数の値から入力を受け入れる入力フィールドを定義します。
属性 -
lovProvider:入力フィールドに表示する値のリストを設定します。
サンプル @FormField(label = "FIELD_TYPE_MULTI_SELECT_LIST", type = FormFieldDefinition.FIELD_TYPE_MULTI_SELECT_LIST, lovProvider = SimpleLovProvider.SIMPLE_LOV_PROVIDER) private String listValue;
-
-
FIELD_TYPE_HTML_LABEL
FIELD_TYPE_HTML_LABEL はフィールドを HTML ラベルとして定義します。この場合、HTML タグが文字列として受け入れられます。
属性 -
size:HTML ラベルのサイズを設定します。
サンプル @FormField(type = FormFieldDefinition.FIELD_TYPE_HTML_LABEL, label = "FIELD_TYPE_HTML_LABEL", htmlPopupLabel = "<a href='http://www.cisco.com'>Cisco</a>") private String dummyLink2;
-
-
FIELD_TYPE_FILE_UPLOAD
FIELD_TYPE_FILE_UPLOAD は、ファイルをアップロードするためのフィールドを定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_FILE_UPLOAD", type = FormFieldDefinition.FIELD_TYPE_FILE_UPLOAD) private String uploadFileName;
-
FIELD_TYPE_TABULAR_POPUP
FIELD_TYPE_TABULAR_POPUP は、ポップアップ タイプの表形式フィールドを定義します。
属性 -
table:Open Automation モジュールに登録済みの表形式フィールド名(TabularPovider)を指定します。
次のサンプル コードに表形式プロバイダーを Open Automation モジュールに登録する方法を示します。 StorageModule.java(Registering Tabular report) cfr.registerTabularField(SimpleTabularProvider.SIMPLE_TABULAR_PROVIDER, SimpleTabularProvider.class, "0", "0");
サンプル @FormField(label = "FIELD_TYPE_TABULAR_POPUP", type = FormFieldDefinition.FIELD_TYPE_TABULAR_POPUP, table = SimpleTabularProvider.SIMPLE_TABULAR_PROVIDER) private String tabularPopup;
-
-
FIELD_TYPE_EMBEDDED_LOV_RADIO
FIELD_TYPE_EMBEDDED_LOV_RADIO は、LOV オプション ボタンが組み込まれたフィールドを定義します。
属性 -
lov または lovProvider のいずれかを属性として選択できます。
サンプル @FormField(label = "FIELD_TYPE_EMBEDDED_LOV_RADIO", type = FormFieldDefinition.FIELD_TYPE_EMBEDDED_LOV_RADIO, mandatory = true, lov = { "Mode 1", "Mode 2", "Mode 3"}, validate = true, group="FIELD_TYPE_EMBEDDED_LOV_RADIO") private String modeType = "Select Mode";
-
-
FIELD_TYPE_HTML_TEXT
FIELD_TYPE_HTML_TEXT は、HTML テキスト タイプのフィールドを定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_HTML_TEXT", type = FormFieldDefinition.FIELD_TYPE_HTML_TEXT, editable = true, size=FormFieldDefinition.FIELD_SIZE_MEDIUM_SMALL) private String status = "<h1>FIELD_TYPE_HTML_TEXT</h1>";
-
FIELD_TYPE_LABEL_WITH_SPACE
FIELD_TYPE_LABEL_WITH_SPACE は、スペースを含むラベル フィールドを定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_LABEL_WITH_SPACE", help = "Ordering of VNICs", type = FormFieldDefinition.FIELD_TYPE_LABEL_WITH_SPACE) private String vnicLabel;
-
FIELD_TYPE_IMAGE_SELECT_LIST
FIELD_TYPE_IMAGE_SELECT_LIST は、イメージ選択リストからイメージを選択できるフィールドを定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_IMAGE_SELECT_LIST", type = FormFieldDefinition.FIELD_TYPE_IMAGE_SELECT_LIST, mandatory = false, editable = true) private String catalogIcon;
-
FIELD_TYPE_BUTTON_PANEL
FIELD_TYPE_BUTTON_PANEL はフィールドをボタン パネルとして定義します。
属性 -
lov:登録済み LOV プロバイダー名を指定します。また、Lov ={http,https} として値を直接指定することもできます。詳細については、Open Automation モジュールの SimpleLovProvider.java サンプル LOV プロバイダーを参照してください。
サンプル @FormField(label = "FIELD_TYPE_BUTTON_PANEL", type = FormFieldDefinition.FIELD_TYPE_BUTTON_PANEL, lov = {"Discover Servers"}, validate = true, group = "UCSM/CIMC Common", mandatory = false) private String discoverServers = "Discover Servers";
-
-
FIELD_TYPE_TEXT_LINE_NUMS
FIELD_TYPE_TEXT_LINE_NUMS はフィールドを行番号付きテキスト フィールドとして定義します。
属性 -
maxlength:テキスト フィールドに入力できる最大文字数を指定します。
-
multiline:この属性はブール型です。テキスト フィールドに複数の行を追加できるようにするには、true に設定します。
-
size:次のいずれかの値を使用して、テキスト フィールドのサイズを設定します。 -
FIELD_SIZE_SMALL
-
FIELD_SIZE_MEDIUM
-
FIELD_SIZE_LARGE
-
FIELD_SIZE_MEDIUM_SMALL
-
FIELD_SIZE_LARGE_SMALL
-
FIELD_SIZE_SMALL_MEDIUM
-
FIELD_SIZE_LARGE_MEDIUM
-
FIELD_SIZE_SMALL_LARGE
-
FIELD_SIZE_MEDIUM_LARGE
-
サンプル @FormField(label = "FIELD_TYPE_TEXT_LINE_NUMS", help = "Error Text to validate", mandatory = false, multiline = true, maxLength = 8192, type = FormFieldDefinition.FIELD_TYPE_TEXT_LINE_NUMS, size = FormFieldDefinition.FIELD_SIZE_SMALL_LARGE) private String message;
-
-
FIELD_TYPE_LARGE_FILE_UPLOAD
FIELD_TYPE_LARGE_FILE_UPLOAD は、サイズの大きなファイルをアップロードするために使用するフィールドを定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "", help = "Upload a file", mandatory = true, validate = true, type = FormFieldDefinition.FIELD_TYPE_LARGE_FILE_UPLOAD, annotation = "For module uploads only zip format are supported") private String uploadFile;
-
FIELD_TYPE_COLORPICKER
FIELD_TYPE_COLORPICKER は、色の選択フィールドを定義します。
属性
このフィールドに固有の属性はありません。
サンプル @FormField(label = "FIELD_TYPE_COLORPICKER", help = "Color", mandatory = true, validate = true, type = FormFieldDefinition.FIELD_TYPE_COLORPICKER) private String color;
共通の属性
ここでは、フィールド アクティビティを制御するためにフォームのフィールドで使用できる共通の属性の一覧を提供します。たとえば、名前フィールドを必須フィールドにする場合、mandatory 属性の値として true を渡す必要があります。
-
validate:この属性はブール型です。デフォルトでは、この属性の値は false に設定されます。フィールドを検証する場合は、属性の値として true を渡す必要があります。
-
hidden:この属性はブール型です。デフォルトでは、この属性の値は false に設定されます。フォームでフィールドを非表示にする場合は、属性の値として true を渡す必要があります。
-
mandatory:この属性はブール型です。デフォルトでは、この属性の値は false に設定されます。フィールドを必須フィールドにする場合は、属性の値として true を渡す必要があります。
-
editable:この属性はブール型です。デフォルトでは、この属性の値は false に設定されます。この属性が適用されるのは、テキスト フィールドのみです。テキスト フィールドを編集可能にする場合は、属性の値として true を渡す必要があります。
-
group:この属性の型は文字列です。単一のフィールドまたは複数のフィールドをグループとして定義する場合は、属性の値としてグループ名を指定する必要があります。
-
view:この属性の型は文字列です。ウィザードに複数のフォームがある場合、特定のページ番号にフィールドが表示されるようにするには、属性の値としてページ番号を指定する必要があります。ウィザードに複数のページがない場合は、この属性を使用する必要はありません。
-
help:この属性の型は文字列です。この属性を使用して、フィールドについて説明するヘルプ テキストを指定できます。指定したヘルプ テキストは、ユーザがそのフィールドにマウス ポインタを重ねると表示されます。