Extends
Members
defaults
Properties:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
defaults |
Object | Default options hash. Properties
|
- Overrides:
- Mixes In:
- 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 |
- Inherited From:
- 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 |
- Inherited From:
- Source:
templatePartials
- Overrides:
- Source:
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()
Hides panel
- 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
|
- 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:
renderPageImages()
Render page images for the existing page list. Assumes no page images have been loaded.
- 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: