trap.api
Interface FillJs

All Superinterfaces:
JsRef
All Known Implementing Classes:
FillJsImpl

public interface FillJs
extends JsRef

All 'setter' methods returns the FillJs object for chaining.


Field Summary
static java.lang.String _FILL_ARGS_
          Referenced to the arguments passed to fill.
static java.lang.String _THIS_FILL_JS_
          An explicit reference to this fill Js.
static java.lang.String fill
           
static java.lang.String fillMain
           
static java.lang.String getFillBlocker
           
static java.lang.String getHeader
           
static java.lang.String param
           
static java.lang.String runBefore
           
static java.lang.String setFillBlocker
           
static java.lang.String setHeader
           
 
Method Summary
 NoParamFunctionRef fill()
          Submits the fill request.
 NoParamFunctionRef fillMain()
          Main implementation to submit the fill call.
 NoParamFunctionRef getFillBlocker()
           
 OneParamFunctionRef getHeader()
           
 TwoParamFunctionRef param()
          Returns FillJs for chaining.
 OneParamFunctionRef runBefore()
          Returns FillJs for chaining.
 OneParamFunctionRef setFillBlocker()
          Returns FillJs for chaining.
 TwoParamFunctionRef setHeader()
          Returns FillJs for chaining.
 
Methods inherited from interface trap.api.JsRef
toString
 

Field Detail

_THIS_FILL_JS_

static final java.lang.String _THIS_FILL_JS_
An explicit reference to this fill Js. Sample usage: .runBefore(" if(!(_THIS_FILL_JS_.isCallServer()){...}");

See Also:
Constant Field Values

_FILL_ARGS_

static final java.lang.String _FILL_ARGS_
Referenced to the arguments passed to fill. Example: fillJs.fill(_FILL_ARGS_); This is usually empty because users will typicall call 'fillJs.fill()'

See Also:
Constant Field Values

runBefore

static final java.lang.String runBefore
See Also:
Constant Field Values

param

static final java.lang.String param
See Also:
Constant Field Values

setFillBlocker

static final java.lang.String setFillBlocker
See Also:
Constant Field Values

getFillBlocker

static final java.lang.String getFillBlocker
See Also:
Constant Field Values

setHeader

static final java.lang.String setHeader
See Also:
Constant Field Values

getHeader

static final java.lang.String getHeader
See Also:
Constant Field Values

fill

static final java.lang.String fill
See Also:
Constant Field Values

fillMain

static final java.lang.String fillMain
See Also:
Constant Field Values
Method Detail

runBefore

@FunctionDefinition(param="Javascript Function")
OneParamFunctionRef runBefore()
Returns FillJs for chaining.


param

@FunctionDefinition(param="key, value, boolean (true to JSON.stringify value)")
TwoParamFunctionRef param()
Returns FillJs for chaining. Format: FillJs.param(key,value,jsonStringifyValue); jsonStringifyValue is optional, default false.


getHeader

@FunctionDefinition(param="String",
                    returnType="String")
OneParamFunctionRef getHeader()

setHeader

@FunctionDefinition(param="key,value")
TwoParamFunctionRef setHeader()
Returns FillJs for chaining. Format: FillJs.setProperty(key, value);


setFillBlocker

@FunctionDefinition(param="Javascript function: function(fillargs).  This function returns true if it wants to block.")
OneParamFunctionRef setFillBlocker()
Returns FillJs for chaining.


getFillBlocker

NoParamFunctionRef getFillBlocker()

fill

@FunctionDefinition(param="Empty or a parameter object. See \'_FILL_ARGS_\'",
                    returnType="JQuery jqXHR object")
NoParamFunctionRef fill()
Submits the fill request. This calls fillMain.


fillMain

@FunctionDefinition(param="Empty or param object. See \'_FILL_ARGS_\'",
                    returnType="JQuery jqXHR object")
NoParamFunctionRef fillMain()
Main implementation to submit the fill call. Developers should usually use this fill() instead of fillMain(). The only reason to use fillMain is when you want add custom behaviour to fill().