dojox/wire/ml/Data.js

  • Provides:

    • dojox.wire.ml.Data

  • Requires:

    • dijit._Widget in common in project dijit
    • dijit._Container in common in project dijit
    • dojox.wire.ml.util in common

  • dojox.wire.ml.Data

    • type
      Function
    • chains:
      • dijit._Widget: (prototype)
      • dijit._Widget: (call)
      • dijit._Container: (call)
    • mixins:
      • dijit._Container.prototype: (prototype)
    • summary
      A widget for a data object
    • description
      This widget represents an object with '_properties' property.
If child 'DataProperty' widgets exist, they are used to initialize
propertiy values of '_properties' object.

  • dojox.wire.ml.Data.startup

    • type
      Function
    • source: [view]
        this._initializeProperties();
    • summary
      Call _initializeProperties()
    • description
      See _initializeProperties().

  • dojox.wire.ml.Data._initializeProperties

    • type
      Function
    • parameters:
      • reset: (typeof Boolean)
        A boolean to reset current properties
    • source: [view]
        if(!this._properties || reset){
         this._properties = {};
        }
        var children = this.getChildren();
        for(var i in children){
         var child = children[i];
         if((child instanceof dojox.wire.ml.DataProperty) && child.name){
          this.setPropertyValue(child.name, child.getValue());
         }
        }
    • summary
      Initialize a data object
    • description
      If this widget has child DataProperty widgets, their getValue()
methods are called and set the return value to a property
specified by 'name' attribute of the child widgets.

  • dojox.wire.ml.Data.getPropertyValue

    • type
      Function
    • parameters:
      • property: (typeof String)
        A property name
    • source: [view]
        return this._properties[property]; //anything
    • summary
      Return a property value
    • description
      This method returns the value of a property, specified with
'property' argument, in '_properties' object.
    • return_summary
      A property value
    • returns
      anything

  • dojox.wire.ml.Data.setPropertyValue

    • type
      Function
    • parameters:
      • property: (typeof String)
        A property name
      • value: (typeof anything)
        A property value
    • source: [view]
        this._properties[property] = value;
    • summary
      Store a property value
    • description
      This method stores 'value' as a property, specified with
'property' argument, in '_properties' object.

  • dojox.wire.ml.Data._properties

    • summary
  • dojox.wire.ml.DataProperty
       
    • type
      Function
    • chains: 
      • dijit._Widget: (prototype)
      • dijit._Widget: (call)
      • dijit._Container: (call)
    • mixins: 
      • dijit._Container.prototype: (prototype)
    • summary
      A widget to define a data property
    • description
      Attributes of this widget are used to add a property to the parent
Data widget.
'type' attribute specifies one of "string", "number", "boolean",
"array", "object" and "element" (DOM Element)
(default to "string").
If 'type' is "array" or "object", child DataProperty widgets are
used to initialize the array elements or the object properties.
  • dojox.wire.ml.DataProperty.name
       
    • type
      A
    • summary
      property name
  • dojox.wire.ml.DataProperty.type
       
    • type
      A
    • summary
      property type name
  • dojox.wire.ml.DataProperty.value
       
    • type
      A
    • summary
      property value
  • dojox.wire.ml.DataProperty._getValueAttr
       
    • type
      Function
    • source: [view] 
                    
      

                      return this.getValue();
                    
      
                    
    • summary
  • dojox.wire.ml.DataProperty.getValue
       
    • type
      Function
    • source: [view] 
                    
      

                      var value = this.value;
        if(this.type){
         if(this.type == "number"){
          value = parseInt(value);
         }else if(this.type == "boolean"){
          value = (value == "true");
         }else if(this.type == "array"){
          value = [];
          var children = this.getChildren();
          for(var i in children){
           var child = children[i];
           if(child instanceof dojox.wire.ml.DataProperty){
            value.push(child.getValue());
           }
          }
         }else if(this.type == "object"){
          value = {};
          var children = this.getChildren();
          for(var i in children){
           var child = children[i];
           if((child instanceof dojox.wire.ml.DataProperty) && child.name){
            value[child.name] = child.getValue();
           }
          }
         }else if(this.type == "element"){
          value = new dojox.wire.ml.XmlElement(value);
          var children = this.getChildren();
          for(var i in children){
           var child = children[i];
           if((child instanceof dojox.wire.ml.DataProperty) && child.name){
            value.setPropertyValue(child.name, child.getValue());
           }
          }
         }
        }
        return value; //anything
                    
      
                    
    • summary
      Returns a property value
    • description
      If 'type' is specified, 'value' attribute is converted to
the specified type and returned.
Otherwise, 'value' attribute is returned as is.
    • return_summary
      A property value
    • returns
      anything
  • dojox.wire.ml
       
    • type
      Object
    • summary
  • dojox.wire
       
    • type
      Object
    • summary
  • dojox
       
    • type
      Object
    • summary