ListView

new ListView(args)

Source:

ListView.js, line 209

Constructor for the list view object.

Parameters:

Name Type Description

args

Object

options argument

Properties

Name	Type	Attributes	Default	Description
`itemView`	external:Backbone-View \| function			the class definition of the item view. This view will be instantiated for every model returned by modelsToRender(). If a function is passed in, then for each model, this function will be invoked to find the appropriate view class. It takes the model as the only parameter.
`collection`	external:Backbone-Collection			The collection that will back this list view. A subclass of list view might provide a default collection. Can be private or public collection
`itemContext`	Object \| function	<optional>		object or function that's passed to the item view's during initialization under the name "context". Can be used by the item view during their prepare method.
`template`	external:Handlebars-Template	<optional>		allows a list view to hold it's own HTML like filter buttons, etc.
`itemContainer`	string	<optional>		(Required if 'template' is provided, ignored otherwise) name of injection site for list of item views
`emptyTemplate`	external:Handlebars-Template	<optional>		if provided, this template will be shown if the modelsToRender() method returns an empty list. If a itemContainer is provided, the empty template will be rendered there.
`modelsToRender`	function	<optional>		If provided, this function will override the modelsToRender() method with custom functionality.
`renderWait`	number	<optional>	`0`	If provided, will collect any internally invoked renders (typically through collection events like reset) for a duration specified by renderWait in milliseconds and then calls a single render instead. Helps to remove unnecessary render calls when modifying the collection often.
`modelId`	string	<optional>	`'cid'`	one of ('cid' or 'id'): model property used as identifier for a given model. This property is saved and used to find the corresponding view.
`modelName`	string	<optional>	`'model'`	name of the model argument passed to the item view during initialization

Members

collection :Collection

Source:

ListView.js, line 153

Properties:

Name	Type	Description
`collection`

The collection that holds the models that this list view will track

Type:

Collection

emptyTemplate :external:Handlebars-Template

Source:

ListView.js, line 174

Properties:

Name	Type	Description
`emptyTemplate`

If provided, this template that will be shown if the modelsToRender() method returns
an empty list. If an itemContainer is provided, the empty template will be rendered there.

Type:

external:Handlebars-Template

itemContainer :String

Source:

ListView.js, line 180

Properties:

Name	Type	Description
`itemContainer`

(Required if 'template' is provided, ignored otherwise) name of injection site for list of item views

Type:

String

itemView :View|function

Source:

ListView.js, line 161

Properties:

Name	Type	Description
`itemView`

The item view class definition that will be instantiated for each model in the list.
itemView can also be a function that takes a model and returns a view class. This allows
for different view classes depending on the model.

Type:

View | function

template :external:Handlebars-Template

Source:

ListView.js, line 167

Properties:

Name	Type	Description
`template`

The template that allows a list view to hold it's own HTML like filter buttons, etc.

Type:

external:Handlebars-Template

viewState :ViewStateCell

Source:

View.js, line 67

Inherited From:

View#viewState

Cell that can be used to save state for rendering the view.

Type:

ViewStateCell

Methods

_activate()

Source:

View.js, line 504

Inherited From:

View#_activate

Method to be invoked when activate is called. Use this method to turn on any
custom timers, listenTo's or on's that should be activatable. The default implementation is a no-op.

_attached()

Source:

View.js, line 421

Inherited From:

View#_attached

Method to be invoked when the view is fully attached to the DOM (NOT just the parent). Use this method to manipulate the view
after the DOM has been attached to the document. The default implementation is a no-op.

_deactivate()

Source:

View.js, line 532

Inherited From:

View#_deactivate

Method to be invoked when deactivate is called. Use this method to turn off any
custom timers, listenTo's or on's that should be deactivatable. The default implementation is a no-op.

_detached()

Source:

View.js, line 484

Inherited From:

View#_detached

Method to be invoked when the view is detached from the DOM (NOT just the parent). Use this method to clean up state
after the view has been removed from the document. The default implementation is a no-op.

_dispose()

Source:

View.js, line 582

Inherited From:

View#_dispose

Method to be invoked when dispose is called. By default calling dispose will remove the
view's element, its on's, listenTo's, and any registered children.
Override this method to destruct any extra

_prepare(context) → {Object}

Source:

View.js, line 196

Inherited From:

View#_prepare

Extension point to augment the template context with custom content.

Parameters:

Name	Type	Description
`context`		the context you can modify

Returns:

[Optional] If you return an object, it will be merged with the context

Type: Object

activate()

Source:

View.js, line 491

Inherited From:

View#activate

Resets listeners and events in order for the view to be reattached to the visible DOM

attachTo($elopt, optionsopt) → {Promise}

Source:

View.js, line 337

Inherited From:

View#attachTo

If detached, will replace the element passed in with this view's element and activate the view.

Parameters:

Name Type Attributes Description

$el

external:jQuery

the element to attach to. This element will be replaced with this view.
If options.replaceMethod is provided, then this parameter is ignored.

options

Object

optional options

Properties

Name	Type	Attributes	Default	Description
`replaceMethod`	Fucntion	<optional>		if given, this view will invoke replaceMethod function in order to attach the view's DOM to the parent instead of calling $el.replaceWith
`discardInjectionSite`	Booleon	<optional>	`false`	if set to true, the injection site is not saved.

Returns:

promise that when resolved, the attach process is complete. Normally this method is synchronous. Transition effects can
make it asynchronous.

Type: Promise

attachTrackedViews() → {Promise|Array.<Promise>}

Source:

View.js, line 413

Inherited From:

View#attachTrackedViews

Hook to attach all your tracked views. This hook will be called after all DOM rendering is done so injection sites should be available.
This method can be overwritten as usual OR extended using .prototype.attachTrackedViews.apply(this, arguments);

Returns:

you can optionally return one or more promises that when all are resolved, all tracked views are attached. Useful when using this.attachView with useTransition=true.

Type: Promise | Array.<Promise>

attachView($el, view, optionsopt) → {Promise}

Source:

View.js, line 383

Inherited From:

View#attachView

Registers the view as a tracked view (defaulting as a child view), then calls view.attachTo with the element argument
The element argument can be a String that references an element with the corresponding "inject" attribute.
When using attachView with options.useTransition:
Will inject a new view into an injection site by using the new view's transitionIn method. If the parent view
previously had another view at this injections site, this previous view will be removed with that view's transitionOut.
If this method is used within a render, the current views' injection sites will be cached so they can be transitioned out even
though they are detached in the process of re-rendering. If no previous view is given and none can be found, the new view is transitioned in regardless.
If the previous view is the same as the new view, it is injected normally without transitioning in.
The previous view must has used an injection site with the standard "inject=" attribute to be found.
When the transitionIn and transitionOut methods are invoked on the new and previous views, the options parameter will be passed on to them. Other fields
will be added to the options parameter to allow better handling of the transitions. These include:
{
newView: the new view
previousView: the previous view (can be undefined)
parentView: the parent view transitioning in or out the tracked view
}

Parameters:

Name Type Attributes Description

$el

external:jQuery | string

the element to attach to OR the name of the injection site. The element with the attribute "inject=" will be used.

view

View

The instantiated view object to be attached

options

Object

optionals options object. If using transitions, this options object will be passed on to the transitionIn and transitionOut methods as well.

Properties

Name	Type	Attributes	Default	Description
`noActivate`	boolean	<optional>	`false`	if set to true, the view will not be activated upon attaching.
`shared`	boolean	<optional>	`false`	if set to true, the view will be treated as a shared view and not disposed during parent view disposing.
`useTransition`	boolean	<optional>	`false`	if set to true, this method will delegate attach logic to this.__transitionNewViewIntoSite
`addBefore`	boolean	<optional>	`false`	if true, and options.useTransition is true, the new view's element will be added before the previous view's element. Defaults to after.
`previousView`	View	<optional>		if using options.useTransition, then you can explicitly define the view that should be transitioned out. If using transitions and no previousView is provided, it will look to see if a view already is at this injection site and uses that by default.

Returns:

resolved when all transitions are complete. No payload is provided upon resolution. If no transitions, then returns a resolved promise.

Type: Promise

deactivate()

Source:

View.js, line 519

Inherited From:

View#deactivate

Maintains view state and DOM but prevents view from becoming a zombie by removing listeners
and events that may affect user experience. Recursively invokes deactivate on child views

delegateEvents()

Source:

View.js, line 303

Inherited From:

View#delegateEvents

Overrides the base delegateEvents
Binds DOM events with the view using events hash while also adding feedback event bindings

detach()

Source:

View.js, line 445

Inherited From:

View#detach

If attached, will detach the view from the DOM.
This method will only separate this view from the DOM it was attached to, but it WILL invoke the _detach
callback on each tracked view recursively.

detachTrackedViews(optionsopt)

Source:

View.js, line 473

Inherited From:

View#detachTrackedViews

Detach all tracked views or a subset of them based on the options parameter.
NOTE: this is not recursive - it will not separate the entire view tree.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, detach only the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, detach only child views. These are views that are owned by the parent and dispose of them if the parent is disposed.

dispose()

Source:

View.js, line 541

Inherited From:

View#dispose

Removes all listeners, disposes children views, stops listening to events, removes DOM.
After dispose is called, the view can be safely garbage collected. Called while
recursively removing views from the hierarchy.

get()

Source:

View.js, line 137

Inherited From:

View#get

Alias to this.viewState.get()

getBehavior(alias) → {Torso.Behavior}

Source:

View.js, line 173

Inherited From:

View#getBehavior

Parameters:

Name	Type	Description
`alias`	string	the name/alias of the behavior

Returns:

the behavior instance if one exists with that alias

Type: Torso.Behavior

getItemViewFromModel(model)

Source:

ListView.js, line 418

Returns the view that corresponds to the model if one exists

Parameters:

Name	Type	Description
`model`	Model	the model

Returns:

the item view corresponding to the model

getItemViews() → {Array.<View>}

Source:

ListView.js, line 432

Returns:

Returns unordered list of views generated by this list view

Type: Array.<View>

getTrackedView(viewCID)

Source:

View.js, line 620

Inherited From:

View#getTrackedView

Parameters:

Name	Type	Description
`viewCID`	string	the cid of the view

Returns:

the view with the given cid. Will look in both shared and child views.

getTrackedViews(optionsopt) → {List.<View>}

Source:

View.js, line 612

Inherited From:

View#getTrackedViews

Returns all tracked views, both child views and shared views.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, get only the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, get only child views. These are views that are owned by the parent and dispose of them if the parent is disposed.

Returns:

all tracked views (filtered by options parameter)

Type: List.<View>

has()

Source:

View.js, line 151

Inherited From:

View#has

Alias to this.viewState.has()

hasItemViews() → {boolean}

Source:

ListView.js, line 425

Returns:

returns true if there exists any generated item views

Type: boolean

hasTrackedViews(optionsopt) → {boolean}

Source:

View.js, line 600

Inherited From:

View#hasTrackedViews

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, only check the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, only check the child views. These are views that are owned by the parent and dispose of them if the parent is disposed.

Returns:

true if this view has tracked views (limited by the options parameter)

Type: boolean

invokeFeedback(to, evtopt, indexMapopt)

Source:

View.js, line 710

Inherited From:

View#invokeFeedback

Invokes a feedback entry's "then" method

Parameters:

Name	Type	Attributes	Description
`to`	string		the "to" field corresponding to the feedback entry to be invoked.
`evt`	Event	<optional>	the event to be passed to the "then" method
`indexMap`	Object	<optional>	a map from index variable name to index value. Needed for "to" fields with array notation.

isActive() → {boolean}

Source:

View.js, line 511

Inherited From:

View#isActive

Returns:

true if the view is active

Type: boolean

isAttached() → {boolean}

Source:

View.js, line 436

Inherited From:

View#isAttached

NOTE: depends on a global variable "document"

Returns:

true if the view is attached to the DOM

Type: boolean

isAttachedToParent() → {boolean}

Source:

View.js, line 428

Inherited From:

View#isAttachedToParent

Returns:

true if the view is attached to a parent

Type: boolean

isDisposed() → {boolean}

Source:

View.js, line 589

Inherited From:

View#isDisposed

Returns:

true if the view was disposed

Type: boolean

modelsToRender()

Source:

ListView.js, line 379

Returns an array of which models should be rendered.
By default, all models in the input collection will be
shown. Extensions of this class may override this
method to apply collection filters.

postrender() → {Promise|Array.<Promise>}

Source:

View.js, line 283

Inherited From:

View#postrender

Hook during render that is invoked after all DOM rendering is done and tracked views attached.
This method can be overwritten as usual OR extended using .prototype.postrender.apply(this, arguments);
NOTE: if you require the view to be attached to the DOM, consider using _attach callback

Returns:

you can optionally return one or more promises that when all are resolved, postrender is finished. Note: render logic will not wait until promises are resolved.

Type: Promise | Array.<Promise>

prepare() → {Object}

Source:

View.js, line 186

Inherited From:

View#prepare

prepareFields can be used to augment the default render method contents.
See __getPrepareFieldsContext() for more details on how to configure them.

Returns:

context for a render method. Defaults to:
{view: this.viewState.toJSON(), model: this.model.toJSON()}

Type: Object

prepareEmpty()

Source:

ListView.js, line 369

Override if you want a different context for your empty template. Defaults to this.prepare()

Returns:

a context that can be used by the empty list template

prerender() → {Promise|Array.<Promise>}

Source:

View.js, line 247

Inherited From:

View#prerender

Hook during render that is invoked before any DOM rendering is performed.
This method can be overwritten as usual OR extended using .prototype.prerender.apply(this, arguments);
NOTE: if you require the view to be detached from the DOM, consider using _detach callback

Returns:

you can optionally return one or more promises that when all are resolved, prerender is finished. Note: render logic will not wait until promises are resolved.

Type: Promise | Array.<Promise>

registerTrackedView(view, optionsopt) → {View}

Source:

View.js, line 636

Inherited From:

View#registerTrackedView

Binds the view as a tracked view - any recursive calls like activate, deactivate, or dispose will
be done to the tracked view as well. Except dispose for shared views. This method defaults to register the
view as a child view unless specified by options.shared.

Parameters:

Name Type Attributes Default Description

view

View

the tracked view

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, registers view as a shared view. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed. If false, registers view as a child view which are disposed when the parent is disposed.

Returns:

the tracked view

Type: View

render() → {Promise}

Source:

View.js, line 209

Inherited From:

View#render

Rebuilds the html for this view's element. Should be able to be called at any time.
Defaults to using this.templateRender. Assumes that this.template is a javascript
function that accepted a single JSON context.
The render method returns a promise that resolves when rendering is complete. Typically render
is synchronous and the rendering is complete upon completion of the method. However, when utilizing
transitions/animations, the render process can be asynchronous and the promise is useful to know when it has finished.

Returns:

a promise that when resolved signifies that the rendering process is complete.

Type: Promise

renderChildViews()

Source:

ListView.js, line 310

Loops through children views and renders them

reorder()

Source:

ListView.js, line 321

Takes existing item views and moves them into correct order defined by
this.modelsToRender(). NOTE: As this method doesn't generate or remove views,
this method takes advantage of jquery's ability to move elements already attached to the DOM.

set()

Source:

View.js, line 144

Inherited From:

View#set

Alias to this.viewState.set()

setCollection(collection, preventUpdate)

Source:

ListView.js, line 247

Sets the collection from which this view generates item views.
This method will attach all necessary event listeners to the new collection to auto-generate item views
and has the option of removing listeners on a previous collection. It will immediately update child
views and re-render if it is necessary - this behavior can be prevented with preventUpdate argument

Parameters:

Name	Type	Description
`collection`	external:Backbone-Collection	the new collection that this list view should use.
`preventUpdate`	boolean	if true, the list view will not update the child views nor rerender.

templateRender()

Source:

View.js, line 291

Inherited From:

View#templateRender

Hotswap rendering system reroute method.
See Torso.templateRenderer#render for params

toJSON()

Source:

View.js, line 165

Inherited From:

View#toJSON

Alias to this.viewState.toJSON()

transitionIn(attach, done, options)

Source:

View.js, line 699

Inherited From:

View#transitionIn

Override to provide your own transition in logic. Default logic is to just attach to the page.
The method is passed a callback that should be invoked when the transition in has fully completed.

Parameters:

Name Type Description

attach

function

callback to be invoked when you want this view to be attached to the dom.
If you are trying to transition in a tracked view, consider using this.transitionInView()

done

function

callback that MUST be invoked when the transition is complete.

options

optionals options object

Properties

Name	Type	Description
`currentView`	View	the view that is being transitioned in.
`previousView`	View	the view that is being transitioned out. Typically this view.
`parentView`	View	the view that is invoking the transition.

transitionOut(done, options)

Source:

View.js, line 683

Inherited From:

View#transitionOut

Override to provide your own transition out logic. Default logic is to just detach from the page.
The method is passed a callback that should be invoked when the transition out has fully completed.

Parameters:

Name Type Description

done

function

callback that MUST be invoked when the transition is complete.

options

optionals options object

Properties

Name	Type	Description
`currentView`	View	the view that is being transitioned in.
`previousView`	View	the view that is being transitioned out. Typically this view.
`parentView`	View	the view that is invoking the transition.

undelegateEvents()

Source:

View.js, line 319

Inherited From:

View#undelegateEvents

Overrides undelegateEvents
Unbinds DOM events from the view.

unregisterTrackedView(view) → {View}

Source:

View.js, line 652

Inherited From:

View#unregisterTrackedView

Unbinds the tracked view - no recursive calls will be made to this shared view

Parameters:

Name	Type	Description
`view`	View	the shared view

Returns:

the tracked view

Type: View

unregisterTrackedViews(optionsopt) → {View}

Source:

View.js, line 667

Inherited From:

View#unregisterTrackedViews

Unbinds all tracked view - no recursive calls will be made to this shared view
You can limit the types of views that will be unregistered by using the options parameter.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, unregister only the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, unregister only child views. These are views that are owned by the parent and dispose of them if the parent is disposed.

Returns:

the tracked view

Type: View

unset()

Source:

View.js, line 158

Inherited From:

View#unset

Alias to this.viewState.unset()

update()

Source:

ListView.js, line 386

Builds any new views, removes stale ones, and re-renders

updateClassName(newClassName)

Source:

View.js, line 269

Inherited From:

View#updateClassName

Updates this view element's class attribute with the value provided.
If no value provided, removes the class attribute of this view element.

Parameters:

Name	Type	Description
`newClassName`	string	the new value of the class attribute

updateDOM()

Source:

ListView.js, line 268

Overrides:

View#updateDOM

Builds a single DOM fragment from the item views and attaches it at once.

ListView

new ListView()

Source:

ListView.js, line 137

Author:

ariel.wexler@vecna.com, kent.willis@vecna.com

See:

ListView Annotated Source

A view that is backed by a collection that managers views per model in the collection.

Extends

View

Members

collection :Collection

Source:

ListView.js, line 153

Properties:

Name	Type	Description
`collection`

The collection that holds the models that this list view will track

Type:

Collection

emptyTemplate :external:Handlebars-Template

Source:

ListView.js, line 174

Properties:

Name	Type	Description
`emptyTemplate`

If provided, this template that will be shown if the modelsToRender() method returns
an empty list. If an itemContainer is provided, the empty template will be rendered there.

Type:

external:Handlebars-Template

itemContainer :String

Source:

ListView.js, line 180

Properties:

Name	Type	Description
`itemContainer`

(Required if 'template' is provided, ignored otherwise) name of injection site for list of item views

Type:

String

itemView :View|function

Source:

ListView.js, line 161

Properties:

Name	Type	Description
`itemView`

Type:

View | function

template :external:Handlebars-Template

Source:

ListView.js, line 167

Properties:

Name	Type	Description
`template`

The template that allows a list view to hold it's own HTML like filter buttons, etc.

Type:

external:Handlebars-Template

viewState :ViewStateCell

Source:

View.js, line 67

Inherited From:

View#viewState

Cell that can be used to save state for rendering the view.

Type:

ViewStateCell

Methods

_activate()

Source:

View.js, line 504

Inherited From:

View#_activate

Method to be invoked when activate is called. Use this method to turn on any
custom timers, listenTo's or on's that should be activatable. The default implementation is a no-op.

_attached()

Source:

View.js, line 421

Inherited From:

View#_attached

_deactivate()

Source:

View.js, line 532

Inherited From:

View#_deactivate

Method to be invoked when deactivate is called. Use this method to turn off any
custom timers, listenTo's or on's that should be deactivatable. The default implementation is a no-op.

_detached()

Source:

View.js, line 484

Inherited From:

View#_detached

_dispose()

Source:

View.js, line 582

Inherited From:

View#_dispose

Method to be invoked when dispose is called. By default calling dispose will remove the
view's element, its on's, listenTo's, and any registered children.
Override this method to destruct any extra

_prepare(context) → {Object}

Source:

View.js, line 196

Inherited From:

View#_prepare

Extension point to augment the template context with custom content.

Parameters:

Name	Type	Description
`context`		the context you can modify

Returns:

[Optional] If you return an object, it will be merged with the context

Type: Object

activate()

Source:

View.js, line 491

Inherited From:

View#activate

Resets listeners and events in order for the view to be reattached to the visible DOM

attachTo($elopt, optionsopt) → {Promise}

Source:

View.js, line 337

Inherited From:

View#attachTo

If detached, will replace the element passed in with this view's element and activate the view.

Parameters:

Name Type Attributes Description

$el

external:jQuery

the element to attach to. This element will be replaced with this view.
If options.replaceMethod is provided, then this parameter is ignored.

options

Object

optional options

Properties

Name	Type	Attributes	Default	Description
`replaceMethod`	Fucntion	<optional>		if given, this view will invoke replaceMethod function in order to attach the view's DOM to the parent instead of calling $el.replaceWith
`discardInjectionSite`	Booleon	<optional>	`false`	if set to true, the injection site is not saved.

Returns:

promise that when resolved, the attach process is complete. Normally this method is synchronous. Transition effects can
make it asynchronous.

Type: Promise

attachTrackedViews() → {Promise|Array.<Promise>}

Source:

View.js, line 413

Inherited From:

View#attachTrackedViews

Returns:

you can optionally return one or more promises that when all are resolved, all tracked views are attached. Useful when using this.attachView with useTransition=true.

Type: Promise | Array.<Promise>

attachView($el, view, optionsopt) → {Promise}

Source:

View.js, line 383

Inherited From:

View#attachView

Parameters:

Name Type Attributes Description

$el

external:jQuery | string

the element to attach to OR the name of the injection site. The element with the attribute "inject=" will be used.

view

View

The instantiated view object to be attached

options

Object

optionals options object. If using transitions, this options object will be passed on to the transitionIn and transitionOut methods as well.

Properties

Name	Type	Attributes	Default	Description
`noActivate`	boolean	<optional>	`false`	if set to true, the view will not be activated upon attaching.
`shared`	boolean	<optional>	`false`	if set to true, the view will be treated as a shared view and not disposed during parent view disposing.
`useTransition`	boolean	<optional>	`false`	if set to true, this method will delegate attach logic to this.__transitionNewViewIntoSite
`addBefore`	boolean	<optional>	`false`	if true, and options.useTransition is true, the new view's element will be added before the previous view's element. Defaults to after.
`previousView`	View	<optional>		if using options.useTransition, then you can explicitly define the view that should be transitioned out. If using transitions and no previousView is provided, it will look to see if a view already is at this injection site and uses that by default.

Returns:

resolved when all transitions are complete. No payload is provided upon resolution. If no transitions, then returns a resolved promise.

Type: Promise

deactivate()

Source:

View.js, line 519

Inherited From:

View#deactivate

Maintains view state and DOM but prevents view from becoming a zombie by removing listeners
and events that may affect user experience. Recursively invokes deactivate on child views

delegateEvents()

Source:

View.js, line 303

Inherited From:

View#delegateEvents

Overrides the base delegateEvents
Binds DOM events with the view using events hash while also adding feedback event bindings

detach()

Source:

View.js, line 445

Inherited From:

View#detach

If attached, will detach the view from the DOM.
This method will only separate this view from the DOM it was attached to, but it WILL invoke the _detach
callback on each tracked view recursively.

detachTrackedViews(optionsopt)

Source:

View.js, line 473

Inherited From:

View#detachTrackedViews

Detach all tracked views or a subset of them based on the options parameter.
NOTE: this is not recursive - it will not separate the entire view tree.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, detach only the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, detach only child views. These are views that are owned by the parent and dispose of them if the parent is disposed.

dispose()

Source:

View.js, line 541

Inherited From:

View#dispose

get()

Source:

View.js, line 137

Inherited From:

View#get

Alias to this.viewState.get()

getBehavior(alias) → {Torso.Behavior}

Source:

View.js, line 173

Inherited From:

View#getBehavior

Parameters:

Name	Type	Description
`alias`	string	the name/alias of the behavior

Returns:

the behavior instance if one exists with that alias

Type: Torso.Behavior

getItemViewFromModel(model)

Source:

ListView.js, line 418

Returns the view that corresponds to the model if one exists

Parameters:

Name	Type	Description
`model`	Model	the model

Returns:

the item view corresponding to the model

getItemViews() → {Array.<View>}

Source:

ListView.js, line 432

Returns:

Returns unordered list of views generated by this list view

Type: Array.<View>

getTrackedView(viewCID)

Source:

View.js, line 620

Inherited From:

View#getTrackedView

Parameters:

Name	Type	Description
`viewCID`	string	the cid of the view

Returns:

the view with the given cid. Will look in both shared and child views.

getTrackedViews(optionsopt) → {List.<View>}

Source:

View.js, line 612

Inherited From:

View#getTrackedViews

Returns all tracked views, both child views and shared views.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, get only the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, get only child views. These are views that are owned by the parent and dispose of them if the parent is disposed.

Returns:

all tracked views (filtered by options parameter)

Type: List.<View>

has()

Source:

View.js, line 151

Inherited From:

View#has

Alias to this.viewState.has()

hasItemViews() → {boolean}

Source:

ListView.js, line 425

Returns:

returns true if there exists any generated item views

Type: boolean

hasTrackedViews(optionsopt) → {boolean}

Source:

View.js, line 600

Inherited From:

View#hasTrackedViews

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, only check the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, only check the child views. These are views that are owned by the parent and dispose of them if the parent is disposed.

Returns:

true if this view has tracked views (limited by the options parameter)

Type: boolean

invokeFeedback(to, evtopt, indexMapopt)

Source:

View.js, line 710

Inherited From:

View#invokeFeedback

Invokes a feedback entry's "then" method

Parameters:

Name	Type	Attributes	Description
`to`	string		the "to" field corresponding to the feedback entry to be invoked.
`evt`	Event	<optional>	the event to be passed to the "then" method
`indexMap`	Object	<optional>	a map from index variable name to index value. Needed for "to" fields with array notation.

isActive() → {boolean}

Source:

View.js, line 511

Inherited From:

View#isActive

Returns:

true if the view is active

Type: boolean

isAttached() → {boolean}

Source:

View.js, line 436

Inherited From:

View#isAttached

NOTE: depends on a global variable "document"

Returns:

true if the view is attached to the DOM

Type: boolean

isAttachedToParent() → {boolean}

Source:

View.js, line 428

Inherited From:

View#isAttachedToParent

Returns:

true if the view is attached to a parent

Type: boolean

isDisposed() → {boolean}

Source:

View.js, line 589

Inherited From:

View#isDisposed

Returns:

true if the view was disposed

Type: boolean

modelsToRender()

Source:

ListView.js, line 379

Returns an array of which models should be rendered.
By default, all models in the input collection will be
shown. Extensions of this class may override this
method to apply collection filters.

postrender() → {Promise|Array.<Promise>}

Source:

View.js, line 283

Inherited From:

View#postrender

Returns:

you can optionally return one or more promises that when all are resolved, postrender is finished. Note: render logic will not wait until promises are resolved.

Type: Promise | Array.<Promise>

prepare() → {Object}

Source:

View.js, line 186

Inherited From:

View#prepare

prepareFields can be used to augment the default render method contents.
See __getPrepareFieldsContext() for more details on how to configure them.

Returns:

context for a render method. Defaults to:
{view: this.viewState.toJSON(), model: this.model.toJSON()}

Type: Object

prepareEmpty()

Source:

ListView.js, line 369

Override if you want a different context for your empty template. Defaults to this.prepare()

Returns:

a context that can be used by the empty list template

prerender() → {Promise|Array.<Promise>}

Source:

View.js, line 247

Inherited From:

View#prerender

Returns:

you can optionally return one or more promises that when all are resolved, prerender is finished. Note: render logic will not wait until promises are resolved.

Type: Promise | Array.<Promise>

registerTrackedView(view, optionsopt) → {View}

Source:

View.js, line 636

Inherited From:

View#registerTrackedView

Parameters:

Name Type Attributes Default Description

view

View

the tracked view

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, registers view as a shared view. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed. If false, registers view as a child view which are disposed when the parent is disposed.

Returns:

the tracked view

Type: View

render() → {Promise}

Source:

View.js, line 209

Inherited From:

View#render

Returns:

a promise that when resolved signifies that the rendering process is complete.

Type: Promise

renderChildViews()

Source:

ListView.js, line 310

Loops through children views and renders them

reorder()

Source:

ListView.js, line 321

set()

Source:

View.js, line 144

Inherited From:

View#set

Alias to this.viewState.set()

setCollection(collection, preventUpdate)

Source:

ListView.js, line 247

Parameters:

Name	Type	Description
`collection`	external:Backbone-Collection	the new collection that this list view should use.
`preventUpdate`	boolean	if true, the list view will not update the child views nor rerender.

templateRender()

Source:

View.js, line 291

Inherited From:

View#templateRender

Hotswap rendering system reroute method.
See Torso.templateRenderer#render for params

toJSON()

Source:

View.js, line 165

Inherited From:

View#toJSON

Alias to this.viewState.toJSON()

transitionIn(attach, done, options)

Source:

View.js, line 699

Inherited From:

View#transitionIn

Override to provide your own transition in logic. Default logic is to just attach to the page.
The method is passed a callback that should be invoked when the transition in has fully completed.

Parameters:

Name Type Description

attach

function

callback to be invoked when you want this view to be attached to the dom.
If you are trying to transition in a tracked view, consider using this.transitionInView()

done

function

callback that MUST be invoked when the transition is complete.

options

optionals options object

Properties

Name	Type	Description
`currentView`	View	the view that is being transitioned in.
`previousView`	View	the view that is being transitioned out. Typically this view.
`parentView`	View	the view that is invoking the transition.

transitionOut(done, options)

Source:

View.js, line 683

Inherited From:

View#transitionOut

Override to provide your own transition out logic. Default logic is to just detach from the page.
The method is passed a callback that should be invoked when the transition out has fully completed.

Parameters:

Name Type Description

done

function

callback that MUST be invoked when the transition is complete.

options

optionals options object

Properties

Name	Type	Description
`currentView`	View	the view that is being transitioned in.
`previousView`	View	the view that is being transitioned out. Typically this view.
`parentView`	View	the view that is invoking the transition.

undelegateEvents()

Source:

View.js, line 319

Inherited From:

View#undelegateEvents

Overrides undelegateEvents
Unbinds DOM events from the view.

unregisterTrackedView(view) → {View}

Source:

View.js, line 652

Inherited From:

View#unregisterTrackedView

Unbinds the tracked view - no recursive calls will be made to this shared view

Parameters:

Name	Type	Description
`view`	View	the shared view

Returns:

the tracked view

Type: View

unregisterTrackedViews(optionsopt) → {View}

Source:

View.js, line 667

Inherited From:

View#unregisterTrackedViews

Unbinds all tracked view - no recursive calls will be made to this shared view
You can limit the types of views that will be unregistered by using the options parameter.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Optional options.

Properties

Name	Type	Attributes	Default	Description
`shared`	boolean	<optional>	`false`	If true, unregister only the shared views. These are views not owned by this parent. As compared to a child view which are disposed when the parent is disposed.
`child`	boolean	<optional>	`false`	If true, unregister only child views. These are views that are owned by the parent and dispose of them if the parent is disposed.