git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.data.Record.json

   1 {
   2   "name" : "Roo.data.Record",
   3   "augments" : [
   4   ],
   5   "desc" : "Instances of this class encapsulate both record <em>definition</em> information, and record\n<em>value</em> information for use in {@link Roo.data.Store} objects, or any code which needs\nto access Records cached in an {@link Roo.data.Store} object.<br>\n<p>\nConstructors for this class are generated by passing an Array of field definition objects to {@link #create}.\nInstances are usually only created by {@link Roo.data.Reader} implementations when processing unformatted data\nobjects.<br>\n<p>\nRecord objects generated by this constructor inherit all the methods of Roo.data.Record listed below.",
   6   "isSingleton" : false,
   7   "isStatic" : true,
   8   "isBuiltin" : false,
   9   "config" : [
  10   ],
  11   "methods" : [
  12     {
  13       "name" : "copy",
  14       "desc" : "Creates a copy of this record.",
  15       "isStatic" : false,
  16       "isConstructor" : false,
  17       "isPrivate" : false,
  18       "memberOf" : "Roo.data.Record",
  19       "example" : "",
  20       "deprecated" : "",
  21       "since" : "",
  22       "see" : "",
  23       "params" : [
  24         {
  25           "name" : "id",
  26           "type" : "String",
  27           "desc" : "(optional) A new record id if you don't want to use this record's id",
  28           "isOptional" : false
  29         }
  30       ],
  31       "returns" : [
  32         {
  33           "name" : "",
  34           "type" : "Record",
  35           "desc" : ""
  36         }
  37       ]
  38     },
  39     {
  40       "name" : "commit",
  41       "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
  42       "isStatic" : false,
  43       "isConstructor" : false,
  44       "isPrivate" : false,
  45       "memberOf" : "Roo.data.Record",
  46       "example" : "",
  47       "deprecated" : "",
  48       "since" : "",
  49       "see" : "",
  50       "params" : [
  51       ],
  52       "returns" : [
  53       ]
  54     },
  55     {
  56       "name" : "get",
  57       "desc" : "Get the value of the named field.",
  58       "isStatic" : false,
  59       "isConstructor" : false,
  60       "isPrivate" : false,
  61       "memberOf" : "Roo.data.Record",
  62       "example" : "",
  63       "deprecated" : "",
  64       "since" : "",
  65       "see" : "",
  66       "params" : [
  67         {
  68           "name" : "name",
  69           "type" : "String",
  70           "desc" : "The name of the field to get the value of.",
  71           "isOptional" : false
  72         }
  73       ],
  74       "returns" : [
  75         {
  76           "name" : "",
  77           "type" : "Object",
  78           "desc" : "The value of the field."
  79         }
  80       ]
  81     },
  82     {
  83       "name" : "set",
  84       "desc" : "Set the named field to the specified value.",
  85       "isStatic" : false,
  86       "isConstructor" : false,
  87       "isPrivate" : false,
  88       "memberOf" : "Roo.data.Record",
  89       "example" : "",
  90       "deprecated" : "",
  91       "since" : "",
  92       "see" : "",
  93       "params" : [
  94         {
  95           "name" : "name",
  96           "type" : "String",
  97           "desc" : "The name of the field to set.",
  98           "isOptional" : false
  99         },
 100         {
 101           "name" : "value",
 102           "type" : "Object",
 103           "desc" : "The value to set the field to.",
 104           "isOptional" : false
 105         }
 106       ],
 107       "returns" : [
 108       ]
 109     },
 110     {
 111       "name" : "reject",
 112       "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.",
 113       "isStatic" : false,
 114       "isConstructor" : false,
 115       "isPrivate" : false,
 116       "memberOf" : "Roo.data.Record",
 117       "example" : "",
 118       "deprecated" : "",
 119       "since" : "",
 120       "see" : "",
 121       "params" : [
 122       ],
 123       "returns" : [
 124       ]
 125     },
 126     {
 127       "name" : "create",
 128       "desc" : "Generate a constructor for a specific record layout.",
 129       "isStatic" : true,
 130       "isConstructor" : false,
 131       "isPrivate" : false,
 132       "memberOf" : "Roo.data.Record",
 133       "example" : "",
 134       "deprecated" : "",
 135       "since" : "",
 136       "see" : "",
 137       "params" : [
 138         {
 139           "name" : "o",
 140           "type" : "Array",
 141           "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\">(Optional) A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\">(Optional) The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\">(Optional) A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\">(Optional) Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\">(Optional) A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\">(Optional) A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n    {name: 'title', mapping: 'topic_title'},\n    {name: 'author', mapping: 'username'},\n    {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n    {name: 'lastPost', mapping: 'post_time', type: 'date'},\n    {name: 'lastPoster', mapping: 'user2'},\n    {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n    title: 'Do my job please',\n    author: 'noobie',\n    totalPosts: 1,\n    lastPost: new Date(),\n    lastPoster: 'Animal',\n    excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
 142           "isOptional" : false
 143         }
 144       ],
 145       "returns" : [
 146       ]
 147     }
 148   ],
 149   "events" : [
 150   ]
 151 }