com.fitanalytics.webwidget

Class FITAWebWidget

java.lang.Object

com.fitanalytics.webwidget.FITAWebWidget

public class FITAWebWidget
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isLoading
protected FITAWebWidgetHandler	mHandler
protected android.webkit.WebView	mView
static java.lang.String	widgetContainerURL

Constructor Summary

Constructors

Constructor and Description
FITAWebWidget(android.webkit.WebView view, FITAWebWidgetHandler handler)

Method Summary

Modifier and Type	Method and Description
void	close() Close the widget.
void	create(java.lang.String productSerial) Create the widget with a product serial.
void	create(java.lang.String productSerial, org.json.JSONObject options) Create the widget with a product serial and widget options as JSONObject.
void	create(java.lang.String productSerial, WidgetOptions options) Create the widget with a product serial and widget options.
void	createAndSendAction(java.lang.String action, org.json.JSONArray arguments)
boolean	load() Begin loading the HTML widget container page.
void	onContainerLoadError(java.lang.String description)
void	open(java.lang.String productSerial) Open the widget with a new product serial.
void	open(java.lang.String productSerial, org.json.JSONObject options) Open the widget with a new product serial and/or widget object (as JSONObejct).
void	open(java.lang.String productSerial, WidgetOptions options) Show the actual widget.
void	processMessage(java.lang.String encodedMessage)
void	receiveMessage(java.lang.String message)
void	recommend(java.lang.String productSerial) Request a recommendation with productSerial.
void	recommend(java.lang.String productSerial, org.json.JSONObject options) Request a recommendation with productSerial and widget options (as JSONObject).
void	recommend(java.lang.String productSerial, WidgetOptions options) Request a recommendation with productSerial and widget options.
void	reconfigure(java.lang.String productSerial) Reconfigure the widget with a new product serial.
void	reconfigure(java.lang.String productSerial, org.json.JSONObject options) Reconfigure the widget with the new product serial and/or widget options object (as JSONObject).
void	reconfigure(java.lang.String productSerial, WidgetOptions options) Reconfigure the widget with the new product serial and/or widget options object.
protected void	sendMessage(org.json.JSONObject message)

Methods inherited from class java.lang.Object

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

Field Detail

widgetContainerURL

public static java.lang.String widgetContainerURL

mView

protected android.webkit.WebView mView

mHandler

protected FITAWebWidgetHandler mHandler

isLoading

protected boolean isLoading

Constructor Detail

FITAWebWidget

public FITAWebWidget(android.webkit.WebView view,
                     FITAWebWidgetHandler handler)

Method Detail

load

public boolean load()

Begin loading the HTML widget container page.

Returns:

`false` if the container is already being loaded

create

public void create(java.lang.String productSerial,
                   WidgetOptions options)

Create the widget with a product serial and widget options. Must be called after the `FITAWebWidgetHandler.onWebWidgetReady` callback.

Parameters:

productSerial - (nullable) The serial ID of the product to load at beginning. When `null` no product will be loaded.

options - Initial set of options for the widget as WidgetOptions object.

create

public void create(java.lang.String productSerial)

Create the widget with a product serial. For details see above.

Parameters:

productSerial - (nullable) The serial ID of the product to load at beginning. When `null` no product will be loaded.

create

public void create(java.lang.String productSerial,
                   org.json.JSONObject options)

Create the widget with a product serial and widget options as JSONObject. For details see above.

Parameters:

productSerial - (nullable) The serial ID of the product to load at beginning. When `null` no product will be loaded.

options - Initial set of options for the widget as JSONObject object.

open

public void open(java.lang.String productSerial,
                 WidgetOptions options)

Show the actual widget. When the widget finishes opening, it will call the `FITAWebWidgetHandler.onWebWidgetOpen` callback. Allows passing new product serial and/or widget options object.

Parameters:

productSerial - (nullable) The new product serial

options - Additional widget options as WidgetOptions

open

public void open(java.lang.String productSerial)

Open the widget with a new product serial. For details see above.

Parameters:

productSerial - (nullable) the new product serial

open

public void open(java.lang.String productSerial,
                 org.json.JSONObject options)

Open the widget with a new product serial and/or widget object (as JSONObejct). For details see above.

Parameters:

productSerial - (nullable) the new product serial

options - Additional widget options as JSONObject

reconfigure

public void reconfigure(java.lang.String productSerial,
                        WidgetOptions options)

Reconfigure the widget with the new product serial and/or widget options object. The new product serial triggers a loading of new product.

Parameters:

productSerial - (nullable) the new product serial

options - widget options as WidgetOptions

reconfigure

public void reconfigure(java.lang.String productSerial)

Reconfigure the widget with a new product serial.

Parameters:

productSerial - (nullable) the new product serial

reconfigure

public void reconfigure(java.lang.String productSerial,
                        org.json.JSONObject options)

Reconfigure the widget with the new product serial and/or widget options object (as JSONObject).

Parameters:

productSerial - (nullable) the new product serial

options - widget options as JSONObject

close

public void close()

Close the widget. Removes the widget markup and event handlers, potentially freeing up some memory.

recommend

public void recommend(java.lang.String productSerial,
                      WidgetOptions options)

Request a recommendation with productSerial and widget options. The recommended size will be returned as an argument to the `FITAWebWidgetHandler.onWebWidgetRecommend` callback.

Parameters:

productSerial - (nullable) The new product serial

options - Additional widget options

recommend

public void recommend(java.lang.String productSerial)

Request a recommendation with productSerial.

Parameters:

productSerial - (nullable) The new product serial

recommend

public void recommend(java.lang.String productSerial,
                      org.json.JSONObject options)

Request a recommendation with productSerial and widget options (as JSONObject).

Parameters:

productSerial - (nullable) The new product serial

options - Additional widget options as JSONObject

receiveMessage

public void receiveMessage(java.lang.String message)

processMessage

public void processMessage(java.lang.String encodedMessage)

createAndSendAction

public void createAndSendAction(java.lang.String action,
                                org.json.JSONArray arguments)

sendMessage

protected void sendMessage(org.json.JSONObject message)

onContainerLoadError

public void onContainerLoadError(java.lang.String description)