org.moxieapps.gwt.uploader.client

Class Configurable<T>

java.lang.Object

org.moxieapps.gwt.uploader.client.Configurable<T>

public abstract class Configurable<T>
extends Object

A common base class that any of the objects which support configuration options will extend to allow the caller to set the options on them. Provides a convenient setOption(String, Object) method that will allow for a configuration option to be set at any level.

Author:

squinn@moxiegroup.com (Shawn Quinn)

Constructor Summary

Constructors

Constructor and Description
Configurable()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.json.client.JSONObject	getOptions() Retrieve all of the options that have been configured for this instance as a JSONObject.
T	setOption(String path, Object value) Set an option on the object at any level, using "/" characters to designate which level of option you'd like to set.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configurable

public Configurable()

Method Detail

setOption

public T setOption(String path,
          Object value)

Set an option on the object at any level, using "/" characters to designate which level of option you'd like to set. E.g., the following code:

 Uploader uploader = new Uploader();
 uploader.setOption("/upload_url", "http://widgetcorp.com/uploads.php");
 uploader.setOption("/post_params/post_param_name_1", "Photo Upload");
 uploader.setOption("/post_params/post_param_name_2", "User 24");
 

Would result in initializing the SWFUpload component like the following:

 new SWFUpload({
     upload_url: "http://widgetcorp.com/uploads.php",
     post_params: {
         post_param_name_1: "Photo Upload",
         post_param_name_2: "User 24"
     }
 });
 

Note that the beginning "/" is optional, so uploader.setOption("/thing", "piglet") is equivalent to uploader.setOption("thing", "piglet").

For details on available options see the SWFUpload reference.

Important note: this method is only intended to support additional options of the SWFUpload API that may not have explicit wrapper methods available in the GWT Uploader API. For all of the standard configuration options it is important to use the appropriate setter methods instead in order for the Ajax/DOM implementation to function properly as well. E.g. instead of doing this:

 uploader.setOption("upload_url", "http://widgetcorp.com/uploads.php");
 

Do this instead:

 uploader.setUploadURL("http://widgetcorp.com/uploads.php");
 

Parameters:

path - The path to the option to set (e.g. "/title/text");

value - The value to set for the option (can be a String, Number, Boolean, or JSONObject)

Returns:

A reference to this Configurable instance for convenient method chaining.

getOptions

public com.google.gwt.json.client.JSONObject getOptions()

Retrieve all of the options that have been configured for this instance as a JSONObject.

Returns:

A JSONObject representing all of the configuration options that have been set on the instance (will be null if no options have been set)