com.smarterapps.automateitplugin.sdk.fields

Class PluginDataFieldCustom

java.lang.Object

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

com.smarterapps.automateitplugin.sdk.fields.PluginDataFieldCustom

public final class PluginDataFieldCustom
extends PluginDataField<java.lang.String>

This class is used to create custom views that will be displayed within AutomateIt when editing the related PluginAction or PluginTrigger. Custom views allows you to create a more complex visualization for your plugin configuration.

See Also:

IPluginDataFieldCustomView

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
PluginDataFieldCustom(int id, java.lang.String title, java.lang.String description, java.lang.Class<? extends IPluginDataFieldCustomView> customViewClass) Instantiates a new plugin data field of type custom.
PluginDataFieldCustom(org.json.JSONObject fieldJson) Do not use - for internal use only

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustomViewHandlerClass() Gets the custom view handler class name.
protected java.lang.String	getFieldValue(org.json.JSONObject fieldJson, java.lang.String jsonFieldValue) Gets the field value.
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

PluginDataFieldCustom

public PluginDataFieldCustom(org.json.JSONObject fieldJson)

Do not use - for internal use only

PluginDataFieldCustom

public PluginDataFieldCustom(int id,
                             java.lang.String title,
                             java.lang.String description,
                             java.lang.Class<? extends IPluginDataFieldCustomView> customViewClass)

Instantiates a new plugin data field of type custom.

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

customViewClass - The component class that is to be used for the custom view. This class must extend View (or any of its subclasses), and implement the IPluginDataFieldCustomView interface

Method Detail

getCustomViewHandlerClass

public java.lang.String getCustomViewHandlerClass()

Gets the custom view handler class name.

Returns:

The name of the component class that is used for the custom view

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.String>

getFieldValue

protected java.lang.String 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.String>

Parameters:

fieldJson - the field json

jsonFieldValue - the json field value

Returns:

the field value