com.smarterapps.automateitplugin.sdk.fields

Class PluginDataFieldList

java.lang.Object

com.smarterapps.automateitplugin.sdk.fields.PluginDataField<java.lang.Integer>

com.smarterapps.automateitplugin.sdk.fields.PluginDataFieldList

public final class PluginDataFieldList
extends PluginDataField<java.lang.Integer>

This class represents a PluginDataField of a list of values. This is used to show a selection of an item in a list. The getSelectedIndex() and PluginDataField.getValue() methods returns the index of the selected item in the list, while getItems() returns the items.

See Also:

PluginDataField

Nested Class Summary

Nested classes/interfaces inherited from class com.smarterapps.automateitplugin.sdk.fields.PluginDataField

PluginDataField.FieldType

Field Summary

Fields inherited from class com.smarterapps.automateitplugin.sdk.fields.PluginDataField

JSON_FIELD_VALUE

Constructor Summary

Constructors

Constructor and Description
PluginDataFieldList(int id, java.lang.String title, java.lang.String description, java.lang.String[] items, java.lang.Integer selectedIndex) Instantiates a new plugin data field of type list.
PluginDataFieldList(org.json.JSONObject fieldJson) Do not use - for internal use only

Method Summary

Modifier and Type	Method and Description
protected java.lang.Integer	getFieldValue(org.json.JSONObject fieldJson, java.lang.String jsonFieldValue) Gets the field value.
java.lang.String[]	getItems() Gets the items.
java.lang.Integer	getSelectedIndex() Gets the selected index.
org.json.JSONObject	serialize() Do not use - for internal use only

Methods inherited from class com.smarterapps.automateitplugin.sdk.fields.PluginDataField

createNewField, getDescription, getId, getTitle, getType, getValue, setValue, setValueGeneric

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginDataFieldList

public PluginDataFieldList(int id,
                           java.lang.String title,
                           java.lang.String description,
                           java.lang.String[] items,
                           java.lang.Integer selectedIndex)

Instantiates a new plugin data field of type list.

Parameters:

id - The field id. To be used with PluginDataFieldCollection.getFieldById(int) to retrieve the field from a data fields collection

title - The field title to show within AutomateIt when editing the related PluginAction or PluginTrigger

description - The field description to show within AutomateIt when editing the related PluginAction or PluginTrigger

items - The list of items that the user can select from

selectedIndex - An initial selection index. must be within bounds of the items parameter

PluginDataFieldList

public PluginDataFieldList(org.json.JSONObject fieldJson)

Do not use - for internal use only

Method Detail

getFieldValue

protected java.lang.Integer getFieldValue(org.json.JSONObject fieldJson,
                                          java.lang.String jsonFieldValue)

Description copied from class: PluginDataField

Gets the field value.

Specified by:

getFieldValue in class PluginDataField<java.lang.Integer>

Parameters:

fieldJson - the field json

jsonFieldValue - the json field value

Returns:

the field value

serialize

public org.json.JSONObject serialize()

Description copied from class: PluginDataField

Do not use - for internal use only

Overrides:

serialize in class PluginDataField<java.lang.Integer>

getSelectedIndex

public java.lang.Integer getSelectedIndex()

Gets the selected index.

Returns:

the selected index

getItems

public java.lang.String[] getItems()

Gets the items.

Returns:

the items