Class MoreMotionAjaxManager

Object
   |
   +--MoreMotionAjaxManager

class MoreMotionAjaxManager

Manager Class that provides static methods for Ajax functionalities. A static object of this class is available with name AjaxMgr.

var AjaxMgr = new MoreMotionAjaxManager();

Constructor Detail

MoreMotionAjaxManager

MoreMotionAjaxManager()

cancelRequest

void cancelRequest(controlId)

Cancels the previously sent request with the specified controlId

Parameters:
controlId - The control Id of the request to cancel

clearOptions

void clearOptions(elmid, soq)

Clears the options of an HTML SELECT Element.

Parameters:
elmid - The id of the SELECT Element (ComboBox or ListBox)
soq - Static Options Quantity. The number of the options on the top of the list that should be preserved while clearing the others.

customRefresh

void customRefresh(<CustomRefreshProps> props)

This method utilizes the AjaxRequest class to send a XMLHttpRequest to the AjaxActionService on the server.

Parameters:
props - The CustomRefreshProps parameters object. The AjaxActionService class invokes the configured data service and prepares an AjaxResponse out of the ADOM prepared by it. The AjaxResponse received from the service should be handled by a custom handler function.

Example:

  AjaxMgr.customRefresh({  
    actionName       : 'RefreshModelNames'  
    ,requestParams   : {CAT: this.value} 
  }); 
   
  <actionParams name="RefreshModelNames"> 
    <dataSource>model_names</dataSource> 
    <nodesToEncrypt>ID</nodesToEncrypt> 
    <responseHandler>MyResponseHandler</responseHandler> 
  </actionParams> 
  
  

executeAjaxCommand

Object executeAjaxCommand(<ExecuteAjaxCommandProps> props)

Executes the specified Ajax Command on the server. This method utilizes the AjaxRequest class to send a XMLHttpRequest to the MoreMotion Ajax Service on the server.

Parameters:
props - The ExecuteAjaxCommandProps parameter object

Example:

  AjaxMgr.executeAjaxCommand({  
    commandName     : 'CartProds',  
    requestParams   : {CAT: category}, 
    busyImage       : 'bimg1'  
  }); 
  

executeMScript

void executeMScript(<ExecuteMScriptProps> props)

Executes MScript codes on the server. This method is used to execute MScript on the server with XMLHttpRequest. Although MScript can be executed with other AjaxManager (refresh) methods in many ways, this method is probably the fastest and least expensive one.

Parameters:
props - The ExecuteMScriptProps parameter object.

Example:

  AjaxMgr.executeMScript({ 
    actionName     : 'SetGetVars' 
    ,requestParams : {TABNAME: 'T1'} 
    ,callbackFunc  : RetrieveVars 
  }); 
   
  function RetrieveVars(mpar) { 
    var docroot = mpar.getResultField("DOC_ROOT"); 
  } 
   
  Configuration: 
  <actionParams name="SetGetVars"> 
    <mscript> 
      @set(s:TABNAME,i:TABNAME)   
      @setResultField(DOC_ROOT,s:DOC_ROOT) 
    </mscript> 
  </actionParams>  
  

getEncosingAreaName

Object getEncosingAreaName(node)

openFlowin

Object openFlowin(props)

Creates a Floating Window and refreshes the embedded "TargetArea" in it using a "SourceArea".

The source area that provide new content should be a "SourceArea" element located in a Ajax Source Page. This method uses refreshAreas() method call internally.

Parameters:
props - The parameter object

Example:

  AjaxMgr.openFlowin({  
    name           : 'UserInfo'  
    ,title         : 'Update User Information'  
    ,width         : 300  
    ,height        : 200 
    ,refElm        : elm  
    ,requestParams : {USER: userId} 
    ,busyImage     : 'bimg1'  
  });  
   
  Configuration:  
  <actionParams name="RefreshDetails">  
    <sourceAreas>/AjaxSourcePage1.Details</sourceAreas>  
  </actionParams>  
  
  

refreshAreas

void refreshAreas(<RefreshAreasProps> props)

Refreshes only a part or parts of a page without making a new request for the whole page. For the page parts to be refreshed in the page, the "TargetArea" or "RefreshableArea" elements should be used.

The source area(s) that provide new content can either be a "SourceArea" element located in a Ajax Source Page or a "RefreshableArea" located in the same page. The name of the source areas are specified in the configuration with <actionParams><sourceAreas> elements.

This method utilizes the AjaxRequest class to send a XMLHttpRequest to the MoreMotion Ajax Service on the server.

Parameters:
props - The RefreshAreasProps parameter object

Example:

  AjaxMgr.refreshAreas({  
    actionName    : '/RefreshDetails'  
    ,targetAreas   : 'Details'  
    ,requestParams : {CAT: category} 
    ,busyImage     : 'bimg1'  
  });  
   
  Configuration:  
  <actionParams name="RefreshDetails">  
    <sourceAreas>/AjaxSourcePage1.Details</sourceAreas>  
  </actionParams>  
  
  

refreshBlocks

void refreshBlocks(<RefreshBlocksProps> props)

Refreshes the records of the specified ProcessBlock elements in the current page. This method utilizes the AjaxRequest class to send a XMLHttpRequest to the MoreMotion Ajax Service on the server.

Parameters:
props - The RefreshBlocksProps parameters object.

Example:

  AjaxMgr.refreshBlocks({  
    actionName     : 'RefreshFormRecords'   
    ,targetBlocks  : 'PF1.ProductsPB,PF2.Customers'   
    ,requestParams : {ID: this.value} 
  });  
   
  Configuration:  
  <actionParams name="RefreshFormRecords">  
    <dataSources>products,customers</dataSources> 
    <nodesToEncrypt>ID</nodesToEncrypt> 
  </actionParams>  
   

refreshFields

void refreshFields(<RefreshFieldsProps> props)

Refreshes the values of HTML Elements or ProcessField objects. This method utilizes the AjaxRequest class to send a XMLHttpRequest to the MoreMotion Ajax Service on the server.

Parameters:
props - The RefreshFieldsProps parameters object.

Example:

   AjaxMgr.refreshFields({      actionName      : 'RefreshProductFields'       ,dataNodes      : 'NAME/ID,STOCK,PRICE'       ,targetElements : 'PROD_SBOX,STOCK,PRICE'       ,requestParams  : {ID: this.value}   });     Configuration:   <actionParams name="RefreshProductFields">     <dataSource>product_details</dataSource>     <nodesToEncrypt></nodesToEncrypt>   </actionParams>    

refreshOptions

void refreshOptions(<RefreshOptionsProps> props)

Refreshes the options of an HTML SELECT Element with the current data acquired from a MoreMotion Data Source. This method utilizes the AjaxRequest class to send a XMLHttpRequest to the MoreMotion Ajax Service on the server.

Parameters:
props - a RefreshOptionsProps parameters object

Example:

  AjaxMgr.refreshOptions({ 
    actionName     : 'RefreshCities' 
    ,optionNode    : 'NAME' 
    ,valueNode     : 'ID' 
    ,targetElement : 'x123' 
    ,requestParams : {CAT: this.value} 
  }); 
   
  Configuration: 
  <actionParams name="RefreshCities"> 
    <dataSource>cities_of_country</dataSource> 
    <valueNode>ID</valueNode> 
    <encryptTheValue>true</encryptTheValue> 
  </actionParams> 
  
  

submitProcessForm

Boolean submitProcessForm(<SubmitProcessFormProps> props)

Prepares an Ajax request out of the specified process form and submits it as an XMLHtttpRequest.

Parameters:
props - The SubmitProcessFormProps parameters Object

Note: Props requiredBlocks, beforeSubmitFunc, validateInput, confirmMessageand busyImage can also be defined in the mo:props attribute of a ProcessCommand element. If that is the case these props can be omitted here.

Example:

  AjaxMgr.submitProcessForm({  
    formName       : 'PF1'  
    ,commandName   : 'Delete'  
    ,requestParams : {CAT: this.value} 
    ,busyImage     : 'Busy1'  
  }); 
  
  

Returns:
true if form is submitted false if submission is canceled because of a validation error.

viewState

void viewState(<ViewStateProps> props)

This method is used to store/retrieve states of browser user controls to/from MoreMotion Page Variables on the server with XMLHttpRequest

Parameters:
props - The ViewStateProps parameter object

Examples:

  AjaxMgr.viewState({  
    getVars      : 'ScrollPosition,SliderIsOpen',  
    callbackFunc : function(vars) {alert(vars.ScrollPosition + " " + vars.SliderIsOpen)}  
  });  
   
  AjaxMgr.viewState({  
    setVars      : {ScrollPosition:1, SliderIsOpen:document.getElementById('x123').checked} 
  });