Parameters:
Name |
Type |
Description |
options |
Object
|
Properties
Name |
Type |
Description |
postUrl |
string
|
Form will POST to this endpoint |
fields |
Array.<FormField>
|
An array of hidden form fields |
buttonLabel |
string
|
Label for submit button
submitted |
|
- Source:
Extends
Members
defaults
A set of default options that are merged with options passed into the initialize
function.
Properties:
Name |
Type |
Description |
defaults |
Object
|
Default options hash.
Properties
Name |
Type |
Attributes |
Description |
el |
jQuery.Object
|
string
|
<optional>
|
jQuery selector to use for rendering. |
skipTemplateRender |
boolean
|
<optional>
|
Whether to enhance views already in
DOM. When enabled, the template is disabled so that it is not rendered in the DOM.
Use in conjunction with View::defaults.$el to associate the View with an existing
already rendered element in the DOM. |
|
- Inherited From:
- Source:
isTemplateMode
Tells the View to ignore tagName and className when constructing the element
and to rely solely on the template
Properties:
Name |
Type |
Description |
isTemplateMode |
boolean
|
|
- Overrides:
- Source:
tagName
Name of tag that contains the rendered template
Properties:
Name |
Type |
Description |
tagName |
string
|
|
- Inherited From:
- Source:
template
Properties:
Name |
Type |
Description |
Specifies |
Mixed
|
the template used in render(). Object|string |
- Overrides:
- Source:
templatePartials
Specifies partials (sub-templates) for the main template. Example:
Properties:
- Inherited From:
- Source:
Example
// example content for the "some" template (sub-template will be
// inserted where {{>content}} is):
// <h1>Heading</h1>
// {{>content}}
oo.mfExtend( SomeView, View, {
template: util.template( '<source-code>' ),
templatePartials: { content: util.template( '<source-code>' ) }
}
Methods
after(…contents) → {this}
Parameters:
Name |
Type |
Attributes |
Description |
contents |
string
|
Node
|
Array.<Node>
|
jQuery
|
<repeatable>
|
|
- Overrides:
- Source:
Returns:
-
Type
-
this
append(…contents) → {this}
Parameters:
Name |
Type |
Attributes |
Description |
contents |
string
|
Node
|
Array.<Node>
|
jQuery
|
<repeatable>
|
|
- Overrides:
- Source:
Returns:
-
Type
-
this
appendTo(target) → {this}
Parameters:
Name |
Type |
Description |
target |
string
|
Node
|
Array.<Node>
|
jQuery
|
|
- Inherited From:
- Source:
Returns:
-
Type
-
this
before(…contents) → {this}
Parameters:
Name |
Type |
Attributes |
Description |
contents |
string
|
Node
|
Array.<Node>
|
jQuery
|
<repeatable>
|
|
- Overrides:
- Source:
Returns:
-
Type
-
this
delegate(eventName, selector, listener)
Add a single event listener to the view's element (or a child element
using selector
). This only works for delegate-able events: not focus
or blur
.
Parameters:
Name |
Type |
Description |
eventName |
string
|
|
selector |
string
|
|
listener |
function
|
|
- Inherited From:
- Source:
delegateEvents(events)
Set callbacks, where this.options.events
is a hash of
{ 'event selector': 'callback' }
{
'mousedown .title': 'edit',
'click .button': 'save',
'click .open': function(e) { ... }
}
pairs. Callbacks will be bound to the view, with this
set properly.
Uses event delegation for efficiency.
Omitting the selector binds the event to this.el
.
Parameters:
Name |
Type |
Description |
events |
Object
|
Optionally set this events instead of the ones on this. |
- Inherited From:
- Source:
detach(selectoropt) → {this}
Parameters:
Name |
Type |
Attributes |
Description |
selector |
string
|
<optional>
|
|
- Inherited From:
- Source:
Returns:
-
Type
-
this
hide()
- Inherited From:
- Source:
initialize(options)
Run once during construction to set up the View
Parameters:
Name |
Type |
Description |
options |
Object
|
Object passed to the constructor.
Properties
Name |
Type |
Attributes |
Description |
events |
Object.<string, string>
|
<optional>
|
|
|
- Inherited From:
- Source:
insertAfter(target) → {this}
Parameters:
Name |
Type |
Description |
target |
string
|
Node
|
Array.<Node>
|
jQuery
|
|
- Inherited From:
- Source:
Returns:
-
Type
-
this
insertBefore(target) → {this}
Parameters:
Name |
Type |
Description |
target |
string
|
Node
|
Array.<Node>
|
jQuery
|
|
- Inherited From:
- Source:
Returns:
-
Type
-
this
parseHTML(html) → {jQuery.Object}
See parseHTML method of util singleton
Parameters:
Name |
Type |
Description |
html |
string
|
to turn into a jQuery object. |
- Inherited From:
- Source:
Returns:
-
Type
-
jQuery.Object
postRender()
Function called after the view is rendered. Can be redefined in
objects that extend View.
- Overrides:
- Source:
prepend(…contents) → {this}
Parameters:
Name |
Type |
Attributes |
Description |
contents |
string
|
Node
|
Array.<Node>
|
jQuery
|
<repeatable>
|
|
- Overrides:
- Source:
Returns:
-
Type
-
this
prependTo(target) → {this}
Parameters:
Name |
Type |
Description |
target |
string
|
Node
|
Array.<Node>
|
jQuery
|
|
- Inherited From:
- Source:
Returns:
-
Type
-
this
preRender()
Function called before the view is rendered. Can be redefined in
objects that extend View.
- Inherited From:
- Source:
remove(selectoropt) → {this}
Parameters:
Name |
Type |
Attributes |
Description |
selector |
string
|
<optional>
|
|
- Inherited From:
- Source:
Returns:
-
Type
-
this
render(data)
Fill this.$el with template rendered using data if template is set.
Parameters:
Name |
Type |
Description |
data |
Object
|
Template data. Will be merged into the view's
options |
- Inherited From:
- Source:
show() → {jQuery.Promise}
Shows panel after a slight delay
- Inherited From:
- Source:
Returns:
-
Type
-
jQuery.Promise
undelegate(eventName, selector, listener)
A finer-grained undelegateEvents
for removing a single delegated event.
selector
and listener
are both optional.
Parameters:
Name |
Type |
Description |
eventName |
string
|
|
selector |
string
|
|
listener |
function
|
|
- Inherited From:
- Source:
undelegateEvents()
Clears all callbacks previously bound to the view by delegateEvents
.
You usually don't need to use this, but may wish to if you have multiple
views attached to the same DOM element.
- Inherited From:
- Source: