NestedCell

NestedCell

new NestedCell(attributes, optionsopt)

Source:
Mixes In:
Author:
  • kent.willis@vecna.com
See:

Generic Nested Cell

Parameters:
Name Type Attributes Default Description
attributes Object

the initial attributes to use for this cell.
options Object <optional>
 {}

the options for setting up this cell.

Properties
Name Type Attributes Default Description
register boolean <optional>
 false

whether to register this cell in the app-level registry.
By default this will NOT add it to the registry unless set to true because
we have not mechanism that will make sure the models get removed from the registry
at the appropriate times.

Extends

Members

isModelCompatible

Source:
Mixes In:
Default Value:
  • false
Properties:
Name Type Description
isModelCompatible boolean

Whether a cell can pass as a model or not.
If true, the cell will not fail is persisted functions are invoked
If false, the cell will throw exceptions if persisted function are invoked

pollTimeoutId

Source:
Inherited From:
Mixes In:
Properties:
Name Type Description
pollTimeoutId number

The id from when setTimeout was called to start polling.

Methods

_dispose()

Source:
Inherited From:
Mixes In:

Dispose hook meant to be used by prototypes that extend this one that need to provide their own dispose logic.

dispose()

Source:
Inherited From:
Mixes In:

Default dispose for model-like objects (Models, Cells, and ServiceCells).
Removes listeners and calls out to _dispose() for child specific dispose logic.
Triggers 2 events - "before-dispose" and "after-dispose".

fetch()

Source:
Mixes In:

Override and disable the fetch function

isPolling()

Source:
Inherited From:
Mixes In:

Returns true if the poll is active

polledFetch()

Source:
Inherited From:
Mixes In:

By default, the polled fetching operation is routed directly
to backbone's fetch all.

save()

Source:
Mixes In:

Override and disable the save function

startPolling(pollInterval)

Source:
Inherited From:
Mixes In:

Starts polling Model/Collection by calling fetch every pollInterval.
Note: Each Model/Collection will only allow a singleton of polling to occur so
as not to have duplicate threads updating Model/Collection.

Parameters:
Name Type Description
pollInterval Integer

interval between each poll in ms.

stopPolling()

Source:
Inherited From:
Mixes In:

Stops polling Model and clears all Timeouts.

sync()

Source:
Mixes In:

Override and disable the sync function

url()

Source:
Mixes In:

Override and disable the url