5 categories.xml
View file
@@ -27,5 +27,10 @@
<p>jQuery UI overrides several built-in jQuery methods in order to provide additional functionality. When using these overrides, it's important to make sure that jQuery UI is loaded. If jQuery UI is not loaded, the methods will still exist, but the expected functionality will not be available, resulting in bugs that may be hard to track down.</p>
]]></desc>
</category>
<category name="Core" slug="core">
<desc><![CDATA[
<p>Functionality provided by jquery.ui.core.js.</p>
]]></desc>
</category>
<category name="All" slug="all"/>
</categories>
1 entries/data-selector.xml
View file
@@ -38,4 +38,5 @@ $( ":data(color)" ).each(function() {
]]></code>
</example>
<category slug="selectors"/>
<category slug="core"/>
</entry>
1 entries/disableSelection.xml
View file
@@ -7,4 +7,5 @@
<p>Disabling text selection is bad. Don't use this.</p>
</longdesc>
<category slug="methods"/>
<category slug="core"/>
</entry>
1 entries/enableSelection.xml
View file
@@ -7,4 +7,5 @@
<p>The <code>.enableSelection()</code> method can be used to re-enable selection of text that was disabled via <a href="/disableSelection/"><code>.disableSelection()</code></a>.</p>
</longdesc>
<category slug="methods"/>
<category slug="core"/>
</entry>
1 entries/focus.xml
View file
@@ -15,4 +15,5 @@
</longdesc>
<category slug="methods"/>
<category slug="overrides"/>
<category slug="core"/>
</entry>
1 entries/focusable-selector.xml
View file
@@ -33,4 +33,5 @@ $( ":focusable" ).css( "border-color", "red" );
]]></code>
</example>
<category slug="selectors"/>
<category slug="core"/>
</entry>
4 entries/jQuery.widget.xml
View file
@@ -113,12 +113,12 @@
The public <a href="#method-destroy"><code>destroy()</code></a> method cleans up all common data, events, etc. and then delegates out to <code>_destroy()</code> for custom, widget-specific, cleanup.
</desc>
</method>
<method name="_getCreateEventData" returns="Object">
<method name="_getCreateEventData" return="Object">
<desc>
All widgets trigger the <a href="#event-create"><code>create</code></a> event. By default, no data is provided in the event, but this method can return an object which will be passed as the <code>create</code> event's data.
</desc>
</method>
<method name="_getCreateOptions" returns="Object">
<method name="_getCreateOptions" return="Object">
<desc>
This method allows the widget to define a custom method for defining options during instantiation. This user-provided options override the options returned by this method which override the default options.
</desc>
78 entries/mouse.xml
View file
@@ -0,0 +1,78 @@
<?xml version="1.0"?>
<entry type="widget" name="jQuery.ui.mouse">
<title>Mouse Interaction</title>
<desc>The base interaction layer.</desc>
<longdesc>
<p>Similar to <a href="/jQuery.Widget#jQuery-Widget2"><code>jQuery.Widget</code></a>, the mouse interaction is not intended to be used directly. It is purely a base layer for other widgets to inherit from. This page only documents what is added to <code>jQuery.Widget</code>, but it does include internal methods that are not intended to be overwritten. The intended public API is <a href="#method-_mouseStart"><code>_mouseStart()</code></a>, <a href="#method-_mouseDrag"><code>_mouseDrag()</code></a>, <a href="#method-_mouseStop"><code>_mouseStop()</code></a>, and <a href="#method-_mouseCapture"><code>_mouseCapture()</code></a>.</p>
</longdesc>
<options>
<option name="cancel" type="Selector" default='"input,textarea,button,select,option"'>
<desc>Prevents interactions from starting on specified elements.</desc>
</option>
<option name="delay" type="Number" default="0">
<desc>Time in milliseconds after mousedown until the interaction should start. This option can be used to prevent unwanted interactions when clicking on an element.</desc>
</option>
<option name="distance" type="Number" default="1">
<desc>Distance in pixels after mousedown the mouse must move before the interaction should start. This option can be used to prevent unwanted interactions when clicking on an element.</desc>
</option>
</options>
<methods>
<method name="_mouseInit">
<desc>
Initializes the interaction event handlers. This must be called from the extending widget's <code>_create()</code> method.
</desc>
</method>
<method name="_mouseDestroy">
<desc>
Destroys the interaction event handlers. This must be called from the extending widget's <code>_destroy()</code> method.
</desc>
</method>
<method name="_mouseDown">
<desc>
Handles the beginning of an interaction. Verifies that the event is associated with the primary mouse button and ensures that the <a href="#option-delay"><code>delay</code></a> and <a href="#option-distance"><code>distance</code></a> options are met prior to starting the interaction. When the interaction is ready to start, invokes the <a href="#method-_mouseStart"><code>_mouseStart()</code></a> method for the extending widget to handle.
</desc>
</method>
<method name="_mouseMove">
<desc>
Handles each movement of the interaction. Invokes the <a href="#method-_mouseDrag"><code>mouseDrag()</code></a> method for the extending widget to handle.
</desc>
</method>
<method name="_mouseUp">
<desc>
Handles the end of the interaction. Invokes the <a href="#method-_mouseStop"><code>mouseStop()</code></a> method for the extending widget to handle.
</desc>
</method>
<method name="_mouseDistanceMet" return="Boolean">
<desc>
Determines whether the <a href="#option-distance"><code>distance</code></a> option has been met for the current interaction.
</desc>
</method>
<method name="_mouseDelayMet" return="Boolean">
<desc>
Determines whether the <a href="#option-delay"><code>delay</code></a> option has been met for the current interaction.
</desc>
</method>
<method name="_mouseStart">
<desc>
The extending widget should implement a <code>_mouseStart()</code> method to handle the beginning of an interaction. This method will receive the mouse event associated with the start of the interaction.
</desc>
</method>
<method name="_mouseDrag">
<desc>
The extending widget should implement a <code>_mouseDrag()</code> method to handle each movement of an interaction. This method will receive the mouse event associated with the movement.
</desc>
</method>
<method name="_mouseStop">
<desc>
The extending widget should implement a <code>_mouseStop()</code> method to handle the end of an interaction. This method will receive the mouse event associated with the end of the interaction.
</desc>
</method>
<method name="_mouseCapture" return="Boolean">
<desc>
Determines whether an interaction should start based on event target of the interaction. The default implementation always returns <code>true</code>.
</desc>
</method>
</methods>
<category slug="utilities"/>
<category slug="interactions"/>
</entry>
1 entries/removeUniqueId.xml
View file
@@ -9,4 +9,5 @@
<p>The <code>.removeUniqueId()</code> will remove ids that were set by <a href="/uniqueId"><code>.uniqueId()</code></a>. Calling <code>.removeUniqueId()</code> on an element that did not have its id set by <code>.uniqueId()</code> will have no affect, even if the element has an id.</p>
</longdesc>
<category slug="methods"/>
<category slug="core"/>
</entry>
1 entries/scrollParent.xml
View file
@@ -8,4 +8,5 @@
</longdesc>
<signature/>
<category slug="methods"/>
<category slug="core"/>
</entry>
1 entries/tabbable-selector.xml
View file
@@ -32,4 +32,5 @@ $( ":tabbable" ).css( "border-color", "red" );
]]></code>
</example>
<category slug="selectors"/>
<category slug="core"/>
</entry>
1 entries/uniqueId.xml
View file
@@ -9,4 +9,5 @@
<p>Many widgets need to generate unique ids for elements. <code>.uniqueId()</code> will check if the element has an id, and if not, it will generate one and set it on the element. It is safe to call <code>.uniqueId()</code> on an element without checking if it already has an id. If/when the widget needs to clean up after itself, the <a href="/removeUniqueId"><code>.removeUniqueId()</code></a> method will remove the id from the element if it was added by <code>.uniqueId()</code> and leave the id alone if it was not. <code>.removeUniqueId()</code> is able to be smart about this because the generated ids have a prefix of <code>"ui-id-"</code>.</p>
</longdesc>
<category slug="methods"/>
<category slug="core"/>
</entry>
2 entries/zIndex.xml
View file
@@ -14,6 +14,7 @@
</code></pre>
</longdesc>
<category slug="methods"/>
<category slug="core"/>
</entry>
<entry type="method" name="zIndex" return="Integer">
<title>.zIndex()</title>
@@ -27,5 +28,6 @@
<p>This is equivalent to <code>.css( "zIndex", zIndex )</code>.</p>
</longdesc>
<category slug="methods"/>
<category slug="core"/>
</entry>
</entries>