<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Framework Extras API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link><script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../js/jquery.tools.min.js"></script><script type="text/javascript" src="../js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../js/template.js"></script></head><body><div id="content"><h1 class="file">JQuery/Form/Element/ColorPicker.php</h1><div id="file-nav-box"><div id="file-nav-options"> Show: <img src="../images/icons/visibility_public.png" alt="Public" id="show-public"></img><img src="../images/icons/visibility_protected.png" alt="Protected" id="show-protected"></img><img src="../images/icons/visibility_private.png" alt="Private" id="show-private"></img><span class="attribute" id="show-inherited">inherited</span></div><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img> Classes </a><ul><li><a href="#\ZendX_JQuery_Form_Element_ColorPicker">\ZendX_JQuery_Form_Element_ColorPicker</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab"> Table of Contents </div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">Zend Framework</div><div class="long-description"><p>LICENSE</p> <p>This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.</p></div></div><dl class="file-info"><dt>Category</dt><dd>ZendX </dd><dt>Copyright</dt><dd>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) </dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a> </dd><dt>Package</dt><dd>ZendX_JQuery </dd><dt>Subpackage</dt><dd>View </dd><dt>Version</dt><dd>$Id: ColorPicker.php 20165 2010-01-09 18:57:56Z bkarwin $ </dd></dl><a name="classes" class="anchor"></a><a id="\ZendX_JQuery_Form_Element_ColorPicker" class="anchor"></a><h2 class="class">\ZendX_JQuery_Form_Element_ColorPicker<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>ZendX\JQuery\Form</small><div class="short-description">Form Element for jQuery ColorPicker View Helper</div><div class="long-description"></div><dl class="class-info"><dt>Parent(s)</dt><dd><a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget">\ZendX_JQuery_Form_Element_UiWidget</a> < \Zend_Form_Element</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) </dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a> </dd></dl><h3>Properties</h3><div><a id="\ZendX_JQuery_Form_Element_ColorPicker::$helper" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">$helper</span> = "colorPicker"</code><div class="description"></div><div class="code-tabs"><strong>Default value</strong><code>"colorPicker"</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::$jQueryParams" class="anchor"></a><div class="property public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>array <span class="highlight">$jQueryParams</span> = array()</code><div class="description"><span class="attribute">inherited</span><div class="short-description">jQuery related parameters of this form element.</div><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::$$jQueryParams">\ZendX_JQuery_Form_Element_UiWidget::$$jQueryParams</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>array()</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd><dt>Inherited_from</dt><dd><a href="../files/ JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::$$jQueryParams">\ZendX_JQuery_Form_Element_UiWidget::$$jQueryParams</a> </dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::$options" class="anchor"></a><div class="property public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>array <span class="highlight">$options</span> = array()</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Just here to prevent errors.</div><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::$$options">\ZendX_JQuery_Form_Element_UiWidget::$$options</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>array()</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd><dt>Inherited_from</dt><dd><a href="../files/ JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::$$options">\ZendX_JQuery_Form_Element_UiWidget::$$options</a> </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\ZendX_JQuery_Form_Element_ColorPicker::__construct()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">(mixed $spec, mixed $options = null)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Constructor</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::__construct()">\ZendX_JQuery_Form_Element_UiWidget::__construct()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$spec</th><td>mixed</td><td><em></em></td></tr><tr><th>$options</th><td>mixed</td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::getDecorators()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getDecorators</span><span class="nb-faded-text">()</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve all decorators</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::getDecorators()">\ZendX_JQuery_Form_Element_UiWidget::getDecorators()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/JQuery.Form.Exception.html#\ZendX_JQuery_Form_Exception">\ZendX_JQuery_Form_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::getJQueryParam()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getJQueryParam</span><span class="nb-faded-text">(string $key)</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get jQuery related parameter of this form element</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::getJQueryParam()">\ZendX_JQuery_Form_Element_UiWidget::getJQueryParam()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$key</th><td>string</td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::getJQueryParams()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getJQueryParams</span><span class="nb-faded-text">()</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get all currently known jQuery related parameters of this element</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::getJQueryParams()">\ZendX_JQuery_Form_Element_UiWidget::getJQueryParams()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::loadDefaultDecorators()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">loadDefaultDecorators</span><span class="nb-faded-text">()</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Load default decorators</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::loadDefaultDecorators()">\ZendX_JQuery_Form_Element_UiWidget::loadDefaultDecorators()</a></small></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::setJQueryParam()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setJQueryParam</span><span class="nb-faded-text">(string $key, string $value)</span> : <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget">\ZendX_JQuery_Form_Element_UiWidget</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set a jQuery related parameter of this form element.</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::setJQueryParam()">\ZendX_JQuery_Form_Element_UiWidget::setJQueryParam()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$key</th><td>string</td><td><em></em></td></tr><tr><th>$value</th><td>string</td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget">\ZendX_JQuery_Form_Element_UiWidget</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::setJQueryParams()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setJQueryParams</span><span class="nb-faded-text">(Array $params)</span> : <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget">\ZendX_JQuery_Form_Element_UiWidget</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set an array of jQuery related options for this element (merging with old options).</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::setJQueryParams()">\ZendX_JQuery_Form_Element_UiWidget::setJQueryParams()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$params</th><td>Array</td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget">\ZendX_JQuery_Form_Element_UiWidget</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery_Form_Element_ColorPicker::setView()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setView</span><span class="nb-faded-text">(\Zend_View_Interface $view = null)</span> : <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget">\ZendX_JQuery_Form_Element_UiWidget</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set the view object</p><small class="inherited_from">Inherited from: <a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget::setView()">\ZendX_JQuery_Form_Element_UiWidget::setView()</a></small></div><div class="code-tabs"><div class="long-description"><p>Ensures that the view object has the jQuery view helper path set.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$view</th><td>\Zend_View_Interface</td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/JQuery.Form.Element.UiWidget.html#\ZendX_JQuery_Form_Element_UiWidget">\ZendX_JQuery_Form_Element_UiWidget</a></td><td></td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer"> Documentation was generated by <a href="http://phpdoc.org">phpDocumentor 2.0.0a12</a>. </small></body></html>