Request

constructor: function( paramsObj, callerObj, eventObj, commandName, controllerObj, invocation )

Creates an instance of the mojo.controller.Request class.

Parameters

getParams: function()

Returns the object containing the set of parameter properties and values to be used by a Command.

Returns

{object} paramsObj

Example

// use requestObj passed into a Command
var targetParam = requestObj.getParams().target;

getCaller: function()

Returns the caller object that triggered the request.

Returns

{object} callerObj

Example

// use requestObj passed into a Command
// check if object triggering request is a mojo.MessagingTopic
if (requestObj.getCaller() instanceof mojo.MessagingTopic) {
    var msg = requestObj.getCaller().getMessage(); // get message
}

getContextElement: function()

Returns the DOM context of the Controller which fired the request.

Returns

{DOMElement} contextObj

Example

// use requestObj passed into a Command
// only do css queries within the context of the Controller
var selectedList = mojo.query(".selected", requestObj.getContextElement());

getEvent: function()

Returns the DOM event object triggered, if applicable.

Returns

{event} eventObj

Example

// use requestObj passed into a Command
var x = requestObj.getEvent().offsetX;
var y = requestObj.getEvent().offsetY;

getCommandName: function()

Returns the name of the Command that the request is being passed in to.

Returns

{string} Command Name

getController: function()

Returns the Controller which fired the request.

Returns

{mojo.controller.Controller} Controller

getControllerName: function()

Returns the name of the Controller which fired the request.

Returns

{string} Controller Name

getInvocation: function()

Returns the invocation object, which wraps an intercepted Command object.  Used with Controller Intercepts only.

Returns

{object} Invocation

Example

// use requestObj passed into a Command
if (requestObj.getInvocation()) {
    // execute the intercepted Command
    requestObj.getInvocation().proceed();
}