trap.api
Interface FillJs

All Superinterfaces:
JsRef
All Known Implementing Classes:
FillJsImpl

public interface FillJs
extends JsRef


Field Summary
static java.lang.String _fillArgs_
          Referenced to the aguments passed to fill.
static java.lang.String _thisFillJs_
          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 getProperty
           
static java.lang.String mainParam
           
static java.lang.String param
           
static java.lang.String runBefore
           
static java.lang.String setFillBlocker
           
static java.lang.String setHeader
           
static java.lang.String setProperty
           
 
Method Summary
 NoParamFunctionRef fill()
          Submits the fill request.
 NoParamFunctionRef fillMain()
          Main implementation to submit the fill call.
 NoParamFunctionRef getFillBlocker()
           
 OneParamFunctionRef getHeader()
           
 OneParamFunctionRef getProperty()
           
 TwoParamFunctionRef mainParam()
           
 TwoParamFunctionRef param()
          Returns FillJs for chaining.
 OneParamFunctionRef runBefore()
          Returns FillJs for chaining.
 OneParamFunctionRef setFillBlocker()
          Returns FillJs for chaining.
 TwoParamFunctionRef setHeader()
          Returns FillJs for chaining.
 TwoParamFunctionRef setProperty()
          Property is a part of the fillJs object.
 
Methods inherited from interface trap.api.JsRef
toString
 

Field Detail

_thisFillJs_

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

See Also:
Constant Field Values

_fillArgs_

static final java.lang.String _fillArgs_
Referenced to the aguments passed to fill. Example: fjs.fill(_fillArgs_)

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

mainParam

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

getProperty

static final java.lang.String getProperty
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

setProperty

static final java.lang.String setProperty
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.


mainParam

@FunctionDefinition(param="value, boolean (true to JSON.stringify value)")
TwoParamFunctionRef mainParam()

getProperty

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

setProperty

@FunctionDefinition(param="key,value")
TwoParamFunctionRef setProperty()
Property is a part of the fillJs object. It is not sent to the server in the fill call (as in parameter). Returns FillJs for chaining. Format: FillJs.setProperty(key, value);


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 \'_fillArgs_\'",
                    returnType="JQuery jqXHR object")
NoParamFunctionRef fill()
Submits the fill request. This calls fillMain.


fillMain

@FunctionDefinition(param="Empty or param object. See \'_fillArgs_\'",
                    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().