haml-coffee
Version:
Haml templates where you can write inline CoffeeScript.
204 lines (194 loc) • 5.62 kB
HTML
<html>
<head>
<title>Haml Coffee Documentation</title>
<link rel='stylesheet' href='../assets/codo.css' type='text/css'>
<script src='../assets/codo.js'></script>
</head>
<body>
<div id='header'>
<div id='menu'>
<a href='../class_index.html' title='Index'>Index</a>
»
<span class='title'>Filter</span>
<nav>
<ul>
<li class='frames'>
(<a class='frames' href='../frames.html'>frames</a>)
</li>
<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'>Class List</a>
<a id='method_list_link' href='../method_list.html'>Method List</a>
<a id='file_list_link' href='../file_list.html'>File List</a>
</div>
</div>
<iframe id='search_frame'></iframe>
</div>
<div id='content'>
<h1>
Class:
Filter
</h1>
<table class='box'>
<tr>
<td>Inherits:</td>
<td>
<a href="../classes/Node.html">Node</a>
</td>
</tr>
<tr>
<td>Defined in:</td>
<td>src/nodes/filter.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Filter node for built-in Haml filters:
</p>
<ul>
<li><code>:escaped</code></li>
<li><code>:preserve</code></li>
<li><code>:plain</code></li>
<li><code>:css</code></li>
<li><code>:javascript</code></li>
<li><code>:cdata</code></li>
</ul>
<p>Only the top level filter marker is a filter node, containing
child nodes are text nodes.
</p>
</div>
<div class='tags'>
</div>
<h2>Constant Summary</h2>
<h3 class='inherited'>
Constants inherited from
<a href="../classes/Node.html">Node</a>
</h3>
<p class='inherited'>
<a href="undefinedclasses/Node.html#CLEAR_WHITESPACE_LEFT-constant">CLEAR_WHITESPACE_LEFT</a>,
<a href="../classes/Node.html#CLEAR_WHITESPACE_RIGHT-constant">CLEAR_WHITESPACE_RIGHT</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#evaluate-instance'>
- (void) <strong>evaluate</strong>()
</a>
</span>
<span class='desc'>
Evaluate the Haml filters
</span>
</li>
<li>
<span class='signature'>
<a href='#render-instance'>
- (void) <strong>render</strong>()
</a>
</span>
<span class='desc'>
Render the filter
</span>
</li>
<li>
<span class='signature'>
<a href='#renderFilterContent-instance'>
- (void) <strong>renderFilterContent</strong>(indent, output, type = 'text')
</a>
</span>
<span class='desc'>
Render the child content, but omits empty lines at the end
</span>
</li>
</ul>
<h3 class='inherited'>
Methods inherited from
<a href="../classes/Node.html">Node</a>
</h3>
<p class='inherited'>
<a href="undefinedclasses/Node.html#constructor-instance">#constructor</a>,
<a href="undefinedclasses/Node.html#addChild-instance">#addChild</a>,
<a href="undefinedclasses/Node.html#getOpener-instance">#getOpener</a>,
<a href="undefinedclasses/Node.html#getCloser-instance">#getCloser</a>,
<a href="undefinedclasses/Node.html#isPreserved-instance">#isPreserved</a>,
<a href="undefinedclasses/Node.html#markText-instance">#markText</a>,
<a href="undefinedclasses/Node.html#markRunningCode-instance">#markRunningCode</a>,
<a href="undefinedclasses/Node.html#markInsertingCode-instance">#markInsertingCode</a>,
<a href="undefinedclasses/Node.html#evaluate-instance">#evaluate</a>,
<a href="../classes/Node.html#render-instance">#render</a>
</p>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='evaluate-instance'>
- (void) <strong>evaluate</strong>()
</p>
<div class='docstring'>
<p>Evaluate the Haml filters
</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='render-instance'>
- (void) <strong>render</strong>()
</p>
<div class='docstring'>
<p>Render the filter
</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='renderFilterContent-instance'>
- (void) <strong>renderFilterContent</strong>(indent, output, type = 'text')
</p>
<div class='docstring'>
<p>Render the child content, but omits empty lines at the end
</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>output</span>
<span class='type'>
(<tt>Array</tt>)
</span>
—
<span class='desc'>where to append the content</span>
</li>
<li>
<span class='name'>indent</span>
<span class='type'>
(<tt>Number</tt>)
</span>
—
<span class='desc'>the content indention</span>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id='footer'>
Generated on
Sun Feb 26 2012 12:33:24 GMT+0100 (CET)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>codo</a>
v0.4.1
(Node.js v0.6.11).
✲
<a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
✲
<a href='https://mksoft.ch'>mksoft.ch</a>
</div>
</body>
</html>