← Back to branch summary

~caneypuggies/reformedchurcheslocator/couchapp-backbone

« back to all changes in this revision

Viewing changes to _attachments/js/vendor/backgrid/api/output/Backgrid.SelectCell.js

  • Committer: Tim Black
  • Date: 2013-09-16 22:50:16 UTC
  • Revision ID: tim@alwaysreformed.com-20130916225016-zk8jiba25z33ew7h
Versioned Bower vendor directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
_attachments/js/vendor/backgrid/api/output/Backgrid.SelectCell.js
 
1
Ext.data.JsonP.Backgrid_SelectCell({
 
2
  "tagname": "class",
 
3
  "name": "Backgrid.SelectCell",
 
4
  "extends": "Backgrid.Cell",
 
5
  "mixins": [
 
6
 
 
7
  ],
 
8
  "alternateClassNames": [
 
9
 
 
10
  ],
 
11
  "aliases": {
 
12
  },
 
13
  "singleton": false,
 
14
  "requires": [
 
15
 
 
16
  ],
 
17
  "uses": [
 
18
 
 
19
  ],
 
20
  "enum": null,
 
21
  "override": null,
 
22
  "inheritable": null,
 
23
  "inheritdoc": null,
 
24
  "meta": {
 
25
  },
 
26
  "private": null,
 
27
  "id": "class-Backgrid.SelectCell",
 
28
  "members": {
 
29
    "cfg": [
 
30
 
 
31
    ],
 
32
    "property": [
 
33
      {
 
34
        "name": "className",
 
35
        "tagname": "property",
 
36
        "owner": "Backgrid.SelectCell",
 
37
        "meta": {
 
38
        },
 
39
        "id": "property-className"
 
40
      },
 
41
      {
 
42
        "name": "delimiter",
 
43
        "tagname": "property",
 
44
        "owner": "Backgrid.SelectCell",
 
45
        "meta": {
 
46
        },
 
47
        "id": "property-delimiter"
 
48
      },
 
49
      {
 
50
        "name": "editor",
 
51
        "tagname": "property",
 
52
        "owner": "Backgrid.SelectCell",
 
53
        "meta": {
 
54
        },
 
55
        "id": "property-editor"
 
56
      },
 
57
      {
 
58
        "name": "events",
 
59
        "tagname": "property",
 
60
        "owner": "Backgrid.Cell",
 
61
        "meta": {
 
62
        },
 
63
        "id": "property-events"
 
64
      },
 
65
      {
 
66
        "name": "formatter",
 
67
        "tagname": "property",
 
68
        "owner": "Backgrid.SelectCell",
 
69
        "meta": {
 
70
        },
 
71
        "id": "property-formatter"
 
72
      },
 
73
      {
 
74
        "name": "multiple",
 
75
        "tagname": "property",
 
76
        "owner": "Backgrid.SelectCell",
 
77
        "meta": {
 
78
        },
 
79
        "id": "property-multiple"
 
80
      },
 
81
      {
 
82
        "name": "optionValues",
 
83
        "tagname": "property",
 
84
        "owner": "Backgrid.SelectCell",
 
85
        "meta": {
 
86
        },
 
87
        "id": "property-optionValues"
 
88
      },
 
89
      {
 
90
        "name": "tagName",
 
91
        "tagname": "property",
 
92
        "owner": "Backgrid.Cell",
 
93
        "meta": {
 
94
        },
 
95
        "id": "property-tagName"
 
96
      }
 
97
    ],
 
98
    "method": [
 
99
      {
 
100
        "name": "enterEditMode",
 
101
        "tagname": "method",
 
102
        "owner": "Backgrid.Cell",
 
103
        "meta": {
 
104
        },
 
105
        "id": "method-enterEditMode"
 
106
      },
 
107
      {
 
108
        "name": "exitEditMode",
 
109
        "tagname": "method",
 
110
        "owner": "Backgrid.Cell",
 
111
        "meta": {
 
112
        },
 
113
        "id": "method-exitEditMode"
 
114
      },
 
115
      {
 
116
        "name": "initialize",
 
117
        "tagname": "method",
 
118
        "owner": "Backgrid.SelectCell",
 
119
        "meta": {
 
120
        },
 
121
        "id": "method-initialize"
 
122
      },
 
123
      {
 
124
        "name": "remove",
 
125
        "tagname": "method",
 
126
        "owner": "Backgrid.Cell",
 
127
        "meta": {
 
128
          "chainable": true
 
129
        },
 
130
        "id": "method-remove"
 
131
      },
 
132
      {
 
133
        "name": "render",
 
134
        "tagname": "method",
 
135
        "owner": "Backgrid.SelectCell",
 
136
        "meta": {
 
137
          "chainable": true
 
138
        },
 
139
        "id": "method-render"
 
140
      },
 
141
      {
 
142
        "name": "renderError",
 
143
        "tagname": "method",
 
144
        "owner": "Backgrid.Cell",
 
145
        "meta": {
 
146
        },
 
147
        "id": "method-renderError"
 
148
      }
 
149
    ],
 
150
    "event": [
 
151
 
 
152
    ],
 
153
    "css_var": [
 
154
 
 
155
    ],
 
156
    "css_mixin": [
 
157
 
 
158
    ]
 
159
  },
 
160
  "linenr": 808,
 
161
  "files": [
 
162
    {
 
163
      "filename": "cell.js",
 
164
      "href": null
 
165
    }
 
166
  ],
 
167
  "html_meta": {
 
168
  },
 
169
  "statics": {
 
170
    "cfg": [
 
171
 
 
172
    ],
 
173
    "property": [
 
174
 
 
175
    ],
 
176
    "method": [
 
177
 
 
178
    ],
 
179
    "event": [
 
180
 
 
181
    ],
 
182
    "css_var": [
 
183
 
 
184
    ],
 
185
    "css_mixin": [
 
186
 
 
187
    ]
 
188
  },
 
189
  "component": false,
 
190
  "superclasses": [
 
191
    "Backbone.View",
 
192
    "Backgrid.Cell"
 
193
  ],
 
194
  "subclasses": [
 
195
    "Backgrid.Extension.Select2Cell"
 
196
  ],
 
197
  "mixedInto": [
 
198
 
 
199
  ],
 
200
  "parentMixins": [
 
201
 
 
202
  ],
 
203
  "html": "<div><pre class=\"hierarchy\"><h4>Hierarchy</h4><div class='subclass first-child'>Backbone.View<div class='subclass '><a href='#!/api/Backgrid.Cell' rel='Backgrid.Cell' class='docClass'>Backgrid.Cell</a><div class='subclass '><strong>Backgrid.SelectCell</strong></div></div></div><h4>Subclasses</h4><div class='dependency'><a href='#!/api/Backgrid.Extension.Select2Cell' rel='Backgrid.Extension.Select2Cell' class='docClass'>Backgrid.Extension.Select2Cell</a></div></pre><div class='doc-contents'><p>SelectCell is also a different kind of cell in that upon going into edit mode\nthe cell renders a list of options to pick from, as opposed to an input box.</p>\n\n<p>SelectCell cannot be referenced by its string name when used in a column\ndefinition because it requires an <code>optionValues</code> class attribute to be\ndefined. <code>optionValues</code> can either be a list of name-value pairs, to be\nrendered as options, or a list of object hashes which consist of a key <em>name</em>\nwhich is the option group name, and a key <em>values</em> which is a list of\nname-value pairs to be rendered as options under that option group.</p>\n\n<p>In addition, <code>optionValues</code> can also be a parameter-less function that\nreturns one of the above. If the options are static, it is recommended the\nreturned values to be memoized. <code>_.memoize()</code> is a good function to help with\nthat.</p>\n\n<p>During display mode, the default formatter will normalize the raw model value\nto an array of values whether the raw model value is a scalar or an\narray. Each value is compared with the <code>optionValues</code> values using\nEcmascript's implicit type conversion rules. When exiting edit mode, no type\nconversion is performed when saving into the model. This behavior is not\nalways desirable when the value type is anything other than string. To\ncontrol type conversion on the client-side, you should subclass SelectCell to\nprovide a custom formatter or provide the formatter to your column\ndefinition.</p>\n\n<p>See:\n  <a href=\"http://api.jquery.com/val/\">$.fn.val()</a></p>\n</div><div class='members'><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-property'>Properties</h3><div class='subsection'><div id='property-className' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-property-className' class='name expandable'>className</a><span> : String</span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>&quot;select-cell&quot;</code></p></div></div></div><div id='property-delimiter' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-property-delimiter' class='name expandable'>delimiter</a><span> : String</span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>', '</code></p></div></div></div><div id='property-editor' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-property-editor' class='name not-expandable'>editor</a><span> : Object</span></div><div class='description'><div class='short'>\n</div><div class='long'>\n<p>Overrides: <a href='#!/api/Backgrid.Cell-property-editor' rel='Backgrid.Cell-property-editor' class='docClass'>Backgrid.Cell.editor</a></p></div></div></div><div id='property-events' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Backgrid.Cell' rel='Backgrid.Cell' class='defined-in docClass'>Backgrid.Cell</a><br/></div><a href='#!/api/Backgrid.Cell-property-events' class='name expandable'>events</a><span> : Object</span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>{&quot;click&quot;: &quot;enterEditMode&quot;}</code></p></div></div></div><div id='property-formatter' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-property-formatter' class='name not-expandable'>formatter</a><span> : Object</span></div><div class='description'><div class='short'>\n</div><div class='long'>\n<p>Overrides: <a href='#!/api/Backgrid.Cell-property-formatter' rel='Backgrid.Cell-property-formatter' class='docClass'>Backgrid.Cell.formatter</a></p></div></div></div><div id='property-multiple' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-property-multiple' class='name expandable'>multiple</a><span> : Boolean</span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>false</code></p></div></div></div><div id='property-optionValues' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-property-optionValues' class='name not-expandable'>optionValues</a><span> : Array.&lt;Array&gt;|Array.&lt;{name: string, values: Array.&lt;Array&gt;}&gt;</span></div><div class='description'><div class='short'>\n</div><div class='long'>\n</div></div></div><div id='property-tagName' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Backgrid.Cell' rel='Backgrid.Cell' class='defined-in docClass'>Backgrid.Cell</a><br/></div><a href='#!/api/Backgrid.Cell-property-tagName' class='name expandable'>tagName</a><span> : String</span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>&quot;td&quot;</code></p></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-method'>Methods</h3><div class='subsection'><div id='method-enterEditMode' class='member first-child inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Backgrid.Cell' rel='Backgrid.Cell' class='defined-in docClass'>Backgrid.Cell</a><br/></div><a href='#!/api/Backgrid.Cell-method-enterEditMode' class='name expandable'>enterEditMode</a>( <span class='pre'></span> )</div><div class='description'><div class='short'>If this column is editable, a new CellEditor instance is instantiated with\nits required parameters. ...</div><div class='long'><p>If this column is editable, a new CellEditor instance is instantiated with\nits required parameters. An <code>editor</code> CSS class is added to the cell upon\nentering edit mode.</p>\n\n<p>This method triggers a Backbone <code>backgrid:edit</code> event from the model when\nthe cell is entering edit mode and an editor instance has been constructed,\nbut before it is rendered and inserted into the DOM. The cell and the\nconstructed cell editor instance are sent as event parameters when this\nevent is triggered.</p>\n\n<p>When this cell has finished switching to edit mode, a Backbone\n<code>backgrid:editing</code> event is triggered from the model. The cell and the\nconstructed cell instance are also sent as parameters in the event.</p>\n\n<p>When the model triggers a <code>backgrid:error</code> event, it means the editor is\nunable to convert the current user input to an apprpriate value for the\nmodel's column, and an <code>error</code> CSS class is added to the cell accordingly.</p>\n</div></div></div><div id='method-exitEditMode' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Backgrid.Cell' rel='Backgrid.Cell' class='defined-in docClass'>Backgrid.Cell</a><br/></div><a href='#!/api/Backgrid.Cell-method-exitEditMode' class='name expandable'>exitEditMode</a>( <span class='pre'></span> )</div><div class='description'><div class='short'>Removes the editor and re-render in display mode. ...</div><div class='long'><p>Removes the editor and re-render in display mode.</p>\n</div></div></div><div id='method-initialize' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-method-initialize' class='name expandable'>initialize</a>( <span class='pre'>options</span> )</div><div class='description'><div class='short'>Initializer. ...</div><div class='long'><p>Initializer.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>options</span> : Object<div class='sub-desc'>\n<ul><li><span class='pre'>model</span> : Backbone.Model<div class='sub-desc'></div></li><li><span class='pre'>column</span> : <a href=\"#!/api/Backgrid.Column\" rel=\"Backgrid.Column\" class=\"docClass\">Backgrid.Column</a><div class='sub-desc'></div></li></ul></div></li></ul><h3 class='pa'>Throws</h3><ul><li><span class='pre'>TypeError</span><div class='sub-desc'><p>If <code>optionsValues</code> is undefined.</p>\n</div></li></ul><p>Overrides: <a href='#!/api/Backgrid.Cell-method-initialize' rel='Backgrid.Cell-method-initialize' class='docClass'>Backgrid.Cell.initialize</a></p></div></div></div><div id='method-remove' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Backgrid.Cell' rel='Backgrid.Cell' class='defined-in docClass'>Backgrid.Cell</a><br/></div><a href='#!/api/Backgrid.Cell-method-remove' class='name expandable'>remove</a>( <span class='pre'></span> ) : <a href=\"#!/api/Backgrid.Cell\" rel=\"Backgrid.Cell\" class=\"docClass\">Backgrid.Cell</a><strong class='chainable signature' >chainable</strong></div><div class='description'><div class='short'>Clean up this cell. ...</div><div class='long'><p>Clean up this cell.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Backgrid.Cell\" rel=\"Backgrid.Cell\" class=\"docClass\">Backgrid.Cell</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-render' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Backgrid.SelectCell'>Backgrid.SelectCell</span><br/></div><a href='#!/api/Backgrid.SelectCell-method-render' class='name expandable'>render</a>( <span class='pre'></span> ) : <a href=\"#!/api/Backgrid.SelectCell\" rel=\"Backgrid.SelectCell\" class=\"docClass\">Backgrid.SelectCell</a><strong class='chainable signature' >chainable</strong></div><div class='description'><div class='short'>Renders the label using the raw value as key to look up from optionValues. ...</div><div class='long'><p>Renders the label using the raw value as key to look up from <code>optionValues</code>.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Backgrid.SelectCell\" rel=\"Backgrid.SelectCell\" class=\"docClass\">Backgrid.SelectCell</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul><h3 class='pa'>Throws</h3><ul><li><span class='pre'>TypeError</span><div class='sub-desc'><p>If <code>optionValues</code> is malformed.</p>\n</div></li></ul><p>Overrides: <a href='#!/api/Backgrid.Cell-method-render' rel='Backgrid.Cell-method-render' class='docClass'>Backgrid.Cell.render</a></p></div></div></div><div id='method-renderError' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Backgrid.Cell' rel='Backgrid.Cell' class='defined-in docClass'>Backgrid.Cell</a><br/></div><a href='#!/api/Backgrid.Cell-method-renderError' class='name expandable'>renderError</a>( <span class='pre'>model, column</span> )</div><div class='description'><div class='short'>Put an error CSS class on the table cell. ...</div><div class='long'><p>Put an <code>error</code> CSS class on the table cell.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>model</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>column</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div></div></div></div></div>"
 
204
});
 
 
b'\\ No newline at end of file'