Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

252 lines (252 sloc) 6.591 kb
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript API Documentation</title>
<link rel='stylesheet' href='../../assets/codo.css' type='text/css'>
<script src='../../assets/codo.js'></script>
<script src='../../assets/search_data.js'></script>
</head>
<body>
<div id='base' data-path='../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../class_index.html' title='Index'>Index</a>
&raquo;
<a href='../../classes/kb.html' title='kb'>kb</a>
&raquo;
<span class='title'>DefaultObservable</span>
<nav>
<ul>
<li class='noframes'>
(<a class='noframes' href='#'>no frames</a>)
</li>
</ul>
</nav>
<div id='search'>
<a id='class_list_link' href='../../class_list.html'>Classes</a>
<a id='method_list_link' href='../../method_list.html'>Methods</a>
<a id='extra_list_link' href='../../extra_list.html'>Extras</a>
</div>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>Ctrl-T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
In frame mode you can toggle the list naviation frame on the left side:
</p>
<ul>
<li>
<span>Ctrl-L</span>
Toggle list view
</li>
</ul>
<p>
You can focus a list in frame mode or toggle a tab in frameless mode:
</p>
<ul>
<li>
<span>Ctrl-C</span>
Class list
</li>
<li>
<span>Ctrl-I</span>
Mixin list
</li>
<li>
<span>Ctrl-F</span>
File list
</li>
<li>
<span>Ctrl-M</span>
Method list
</li>
<li>
<span>Ctrl-E</span>
Extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>Ctrl-S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
<p>
In frameless mode you can close the list tab:
</p>
<ul>
<li>
<span>Esc</span>
Close list tab
</li>
</ul>
</div>
</div>
<div id='content'>
<h1>
Class:
kb.DefaultObservable
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/knockback-defaults/knockback-default-observable.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Used to provide a default value when an observable is null, undefined, or the empty string. </p>
<div class='examples'>
<h3>Examples:</h3>
<h4>
Provide a observable with observable and/or non observable default argument in the form of:
</h4>
<pre><code class='coffee'>var wrapped_name = kb.defaultObservable(kb.observable(model, &#39;name&#39;), &#39;(no name)&#39;);</code></pre>
</div>
</div>
<div class='tags'>
</div>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#constructor-instance'>
- (ko.observable) <strong>constructor</strong>(target_observable, dv)
</a>
</span>
<span class='constructor note title'>Constructor</span>
<span class='desc'>
Used to create a new kb.CollectionObservable.
</span>
</li>
<li>
<span class='signature'>
<a href='#destroy-instance'>
- (void) <strong>destroy</strong>()
</a>
</span>
<span class='desc'>
Required clean up function to break cycles, release view models, etc.
</span>
</li>
<li>
<span class='signature'>
<a href='#setToDefault-instance'>
- (void) <strong>setToDefault</strong>()
</a>
</span>
<span class='desc'>
Forces the observable to take the default value.
</span>
</li>
</ul>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-instance'>
- (ko.observable) <strong>constructor</strong>(target_observable, dv)
</p>
<div class='docstring'>
<div class='note'>
<strong>Note:</strong>
the constructor does not return 'this' but a ko.observable
</div>
<p>Used to create a new kb.CollectionObservable. </p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>target_observable</span>
<span class='type'>
(<tt>ko.observable</tt>)
</span>
&mdash;
<span class='desc'>the observable to check for null, undefined, or the empty string</span>
</li>
<li>
<span class='name'>default_value</span>
<span class='type'>
(<tt>Any</tt>)
</span>
&mdash;
<span class='desc'>the default value. Can be a value, string or ko.observable</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'>
(<tt>ko.observable</tt>)
</span>
&mdash;
<span class='desc'>the constructor does not return 'this' but a ko.observable</span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='destroy-instance'>
- (void) <strong>destroy</strong>()
</p>
<div class='docstring'>
<p>Required clean up function to break cycles, release view models, etc. Can be called directly, via kb.release(object) or as a consequence of ko.releaseNode(element). </p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='setToDefault-instance'>
- (void) <strong>setToDefault</strong>()
</p>
<div class='docstring'>
<div class='note'>
<strong>Note:</strong>
Can be used with kb.utils.setToDefault, kb.Observable.setToDefault, kb.ViewModel.setToDefault
</div>
<p>Forces the observable to take the default value. </p>
</div>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
Generated on
Thu Sep 06 2012 17:22:43 GMT+0900 (JST)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
v1.3.0
(Node.js v0.8.7).
&#10034;
Press Ctrl-h to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
&#10034;
<a href='https://mksoft.ch'>mksoft.ch</a>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.