Ext.ux.Spotlight.js
11.9 KB
Ext.data.JsonP.Ext_ux_Spotlight({"mixins":[],"code_type":"ext_define","inheritable":false,"component":false,"meta":{},"mixedInto":[],"uses":[],"aliases":{},"parentMixins":[],"superclasses":[],"members":{"event":[],"property":[{"meta":{"private":true},"owner":"Ext.ux.Spotlight","tagname":"property","name":"active","id":"property-active"},{"meta":{"private":true},"owner":"Ext.ux.Spotlight","tagname":"property","name":"baseCls","id":"property-baseCls"}],"css_var":[],"method":[{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"method","name":"applyBounds","id":"method-applyBounds"},{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"method","name":"createElements","id":"method-createElements"},{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"method","name":"destroy","id":"method-destroy"},{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"method","name":"hide","id":"method-hide"},{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"method","name":"show","id":"method-show"},{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"method","name":"syncSize","id":"method-syncSize"}],"css_mixin":[],"cfg":[{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"cfg","name":"animate","id":"cfg-animate"},{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"cfg","name":"duration","id":"cfg-duration"},{"meta":{},"owner":"Ext.ux.Spotlight","tagname":"cfg","name":"easing","id":"cfg-easing"}]},"tagname":"class","extends":null,"html":"<div><pre class=\"hierarchy\"><h4>Files</h4><div class='dependency'><a href='source/Spotlight.html#Ext-ux-Spotlight' target='_blank'>Spotlight.js</a></div></pre><div class='doc-contents'><p>UX used to provide a spotlight around a specified component/element.</p>\n</div><div class='members'><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-cfg'>Config options</h3><div class='subsection'><div id='cfg-animate' class='member first-child not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-cfg-animate' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-cfg-animate' class='name expandable'>animate</a><span> : <a href=\"#!/api/Boolean\" rel=\"Boolean\" class=\"docClass\">Boolean</a></span></div><div class='description'><div class='short'>{Boolean} True to animate the spotlight change\n(defaults to true) ...</div><div class='long'><p>{Boolean} True to animate the spotlight change\n(defaults to true)</p>\n<p>Defaults to: <code>true</code></p></div></div></div><div id='cfg-duration' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-cfg-duration' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-cfg-duration' class='name expandable'>duration</a><span> : <a href=\"#!/api/Number\" rel=\"Number\" class=\"docClass\">Number</a></span></div><div class='description'><div class='short'>{Integer} The duration of the animation, in milliseconds\n(defaults to 250) ...</div><div class='long'><p>{Integer} The duration of the animation, in milliseconds\n(defaults to 250)</p>\n<p>Defaults to: <code>250</code></p></div></div></div><div id='cfg-easing' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-cfg-easing' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-cfg-easing' class='name expandable'>easing</a><span> : <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a></span></div><div class='description'><div class='short'>{String} The type of easing for the spotlight animatation\n(defaults to null) ...</div><div class='long'><p>{String} The type of easing for the spotlight animatation\n(defaults to null)</p>\n<p>Defaults to: <code>null</code></p></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-property'>Properties</h3><div class='subsection'><div id='property-active' class='member first-child not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-property-active' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-property-active' class='name expandable'>active</a><span> : <a href=\"#!/api/Boolean\" rel=\"Boolean\" class=\"docClass\">Boolean</a></span><strong class='private signature'>private</strong></div><div class='description'><div class='short'>True if the spotlight is active on the element ...</div><div class='long'><p>True if the spotlight is active on the element</p>\n<p>Defaults to: <code>false</code></p></div></div></div><div id='property-baseCls' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-property-baseCls' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-property-baseCls' class='name expandable'>baseCls</a><span> : <a href=\"#!/api/String\" rel=\"String\" class=\"docClass\">String</a></span><strong class='private signature'>private</strong></div><div class='description'><div class='short'>The baseCls for the spotlight elements ...</div><div class='long'><p>The baseCls for the spotlight elements</p>\n<p>Defaults to: <code>"x-spotlight"</code></p></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-method'>Methods</h3><div class='subsection'><div id='method-applyBounds' class='member first-child not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-method-applyBounds' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-method-applyBounds' class='name expandable'>applyBounds</a>( <span class='pre'><a href=\"#!/api/Boolean\" rel=\"Boolean\" class=\"docClass\">Boolean</a> animate, <a href=\"#!/api/Boolean\" rel=\"Boolean\" class=\"docClass\">Boolean</a> reverse</span> )</div><div class='description'><div class='short'>Resizes the spotlight depending on the arguments ...</div><div class='long'><p>Resizes the spotlight depending on the arguments</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>animate</span> : <a href=\"#!/api/Boolean\" rel=\"Boolean\" class=\"docClass\">Boolean</a><div class='sub-desc'><p>True to animate the changing of the bounds</p>\n</div></li><li><span class='pre'>reverse</span> : <a href=\"#!/api/Boolean\" rel=\"Boolean\" class=\"docClass\">Boolean</a><div class='sub-desc'><p>True to reverse the animation</p>\n</div></li></ul></div></div></div><div id='method-createElements' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-method-createElements' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-method-createElements' class='name expandable'>createElements</a>( <span class='pre'></span> )</div><div class='description'><div class='short'>Create all the elements for the spotlight ...</div><div class='long'><p>Create all the elements for the spotlight</p>\n</div></div></div><div id='method-destroy' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-method-destroy' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-method-destroy' class='name expandable'>destroy</a>( <span class='pre'></span> )</div><div class='description'><div class='short'>Removes all the elements for the spotlight ...</div><div class='long'><p>Removes all the elements for the spotlight</p>\n</div></div></div><div id='method-hide' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-method-hide' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-method-hide' class='name expandable'>hide</a>( <span class='pre'><a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a> callback, <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a> scope</span> )</div><div class='description'><div class='short'>Hide the spotlight ...</div><div class='long'><p>Hide the spotlight</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>callback</span> : <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a><div class='sub-desc'>\n</div></li><li><span class='pre'>scope</span> : <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-show' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-method-show' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-method-show' class='name expandable'>show</a>( <span class='pre'><a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a> el, <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a> callback, <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a> scope</span> )</div><div class='description'><div class='short'>Show the spotlight ...</div><div class='long'><p>Show the spotlight</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>el</span> : <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a><div class='sub-desc'>\n</div></li><li><span class='pre'>callback</span> : <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a><div class='sub-desc'>\n</div></li><li><span class='pre'>scope</span> : <a href=\"#!/api/Object\" rel=\"Object\" class=\"docClass\">Object</a><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-syncSize' class='member not-inherited'><a href='#' class='side expandable'><span> </span></a><div class='title'><div class='meta'><span class='defined-in' rel='Ext.ux.Spotlight'>Ext.ux.Spotlight</span><br/><a href='source/Spotlight.html#Ext-ux-Spotlight-method-syncSize' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Ext.ux.Spotlight-method-syncSize' class='name expandable'>syncSize</a>( <span class='pre'></span> )</div><div class='description'><div class='short'>Resizes the spotlight with the window size. ...</div><div class='long'><p>Resizes the spotlight with the window size.</p>\n</div></div></div></div></div></div></div>","subclasses":[],"name":"Ext.ux.Spotlight","alternateClassNames":[],"inheritdoc":null,"files":[{"href":"Spotlight.html#Ext-ux-Spotlight","filename":"Spotlight.js"}],"html_meta":{},"singleton":false,"id":"class-Ext.ux.Spotlight","statics":{"property":[],"event":[],"css_var":[],"method":[],"css_mixin":[],"cfg":[]},"requires":[]});