Browse files

Add disable/enable/option/widget methods

  • Loading branch information...
1 parent d76939b commit 6b2fe038ae5f9130bc9dbf338458a0eca09f9c19 @jzaefferer jzaefferer committed May 25, 2012
View
13 entries/accordion.xml
@@ -141,8 +141,19 @@
</method>
<method name="option">
<desc>
- Returns the widget
+ Get or set any accordion option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple accordion options at once by providing an options object.
</desc>
+ <argument name="options" type="Object">
+ </argument>
</method>
<method name="resize">
<desc>Recompute heights of the accordion contents when using the fillSpace option and the container height changed. For example, when the container is a resizable, this method should be called by its resize-event.</desc>
View
39 entries/autocomplete.xml
@@ -134,17 +134,46 @@
</events>
<methods>
+ <method name="close">
+ <desc>Close the Autocomplete menu. Useful in combination with the search method, to close the open menu.</desc>
+ </method>
+ <method name="disable">
+ <desc>
+ Disable the autocomplete.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the autocomplete.
+ </desc>
+ </method>
+ <method name="option">
+ <desc>
+ Get or set any autocomplete option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple autocomplete options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
<method name="search">
- <desc>Triggers a search event, which, when data is available, then will display the suggestions; can be used by a selectbox-like button to open the suggestions when clicked. If no value argument is specified, the current input's value is used. Can be called with an empty string and minLength: 0 to display all items.
-</desc>
+ <desc>Triggers a search event, which, when data is available, then will display the suggestions; can be used by a selectbox-like button to open the suggestions when clicked. If no value argument is specified, the current input's value is used. Can be called with an empty string and minLength: 0 to display all items.</desc>
<argument name="value" type="String" optional="true">
<desc></desc>
</argument>
</method>
- <method name="close">
- <desc>Close the Autocomplete menu. Useful in combination with the search method, to close the open menu.</desc>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
</method>
-
</methods>
<example>
View
32 entries/button.xml
@@ -39,10 +39,40 @@
</event>
</events>
<methods>
+ <method name="disable">
+ <desc>
+ Disable the button.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the button.
+ </desc>
+ </method>
<method name="refresh">
<desc>Refreshes the visual state of the button. Useful for updating button state after the native element's checked or disabled state is changed programatically.</desc>
</method>
-
+ <method name="option">
+ <desc>
+ Get or set any button option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple button options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
View
32 entries/dialog.xml
@@ -194,6 +194,16 @@
<method name="close">
<desc>Close the dialog.</desc>
</method>
+ <method name="disable">
+ <desc>
+ Disable the dialog.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the dialog.
+ </desc>
+ </method>
<method name="isOpen">
<desc>Returns true if the dialog is currently open.</desc>
</method>
@@ -203,7 +213,27 @@
<method name="open">
<desc>Open the dialog.</desc>
</method>
-
+ <method name="option">
+ <desc>
+ Get or set any dialog option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple dialog options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
View
33 entries/draggable.xml
@@ -146,8 +146,37 @@ Note: Specifying this option as an array of selectors has been removed.</desc>
</events>
<methods>
-
-
+ <method name="disable">
+ <desc>
+ Disable the draggable.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the draggable.
+ </desc>
+ </method>
+ <method name="option">
+ <desc>
+ Get or set any draggable option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple draggable options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
View
33 entries/droppable.xml
@@ -107,8 +107,37 @@ ui.draggable represents the draggable.</desc>
</events>
<methods>
-
-
+ <method name="disable">
+ <desc>
+ Disable the droppable.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the droppable.
+ </desc>
+ </method>
+ <method name="option">
+ <desc>
+ Get or set any droppable option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple droppable options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
<desc>Makes the div droppable (a drop target for a draggable).</desc>
View
32 entries/progressbar.xml
@@ -50,13 +50,43 @@ This is a determinate progress bar, meaning that it should only be used in situa
</event>
</events>
<methods>
+ <method name="disable">
+ <desc>
+ Disable the progressbar.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the progressbar.
+ </desc>
+ </method>
+ <method name="option">
+ <desc>
+ Get or set any progressbar option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple progressbar options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
<method name="value">
<desc>This method gets or sets the current value of the progressbar.</desc>
<argument name="value" type="Number" optional="true">
<desc></desc>
</argument>
</method>
-
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
View
33 entries/resizable.xml
@@ -117,8 +117,37 @@ If specified as an object, the following keys are supported: { n, e, s, w, ne, s
</events>
<methods>
-
-
+ <method name="disable">
+ <desc>
+ Disable the resizable.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the resizable.
+ </desc>
+ </method>
+ <method name="option">
+ <desc>
+ Get or set any resizable option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple resizable options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
View
35 entries/selectable.xml
@@ -92,8 +92,7 @@
</argument>
</event>
<event name="unselecting" type="selectableunselecting">
- <desc>This event is triggered during the select operation, on each element removed from the selection.
-</desc>
+ <desc>This event is triggered during the select operation, on each element removed from the selection.</desc>
<argument name="event" type="Event">
<desc></desc>
</argument>
@@ -104,10 +103,40 @@
</events>
<methods>
+ <method name="disable">
+ <desc>
+ Disable the selectable.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the selectable.
+ </desc>
+ </method>
<method name="refresh">
<desc> Refresh the position and size of each selectee element. This method can be used to manually recalculate the position and size of each selectee element. Very useful if autoRefresh is set to false.</desc>
</method>
-
+ <method name="option">
+ <desc>
+ Get or set any selectable option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple selectable options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
View
35 entries/slider.xml
@@ -97,9 +97,34 @@ Return false in order to prevent a slide, based on ui.value.</desc>
</events>
<methods>
+ <method name="disable">
+ <desc>
+ Disable the slider.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the slider.
+ </desc>
+ </method>
+ <method name="option">
+ <desc>
+ Get or set any slider option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple slider options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
<method name="value">
- <desc>Gets or sets the value of the slider. For single handle sliders.
-</desc>
+ <desc>Gets or sets the value of the slider. For single handle sliders.</desc>
<argument name="value" type="Number" optional="true">
<desc></desc>
</argument>
@@ -113,7 +138,11 @@ Return false in order to prevent a slide, based on ui.value.</desc>
<desc></desc>
</argument>
</method>
-
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>
View
64 entries/sortable.xml
@@ -223,6 +223,49 @@ Note: the element specified for containment must have a calculated width and hei
</events>
<methods>
+ <method name="cancel">
+ <desc>Cancels a change in the current sortable and reverts it back to how it was before the current sort started. Useful in the stop and receive callback functions.
+
+If the sortable item is not being moved from one connected sortable to another:
+<pre><![CDATA[$(this).sortable('cancel');]]></pre>
+will cancel the change.
+
+If the sortable item is being moved from one connected sortable to another:
+<pre><![CDATA[$(ui.sender).sortable('cancel');]]></pre>
+will cancel the change. Useful in the 'receive' callback.</desc>
+ </method>
+ <method name="disable">
+ <desc>
+ Disable the sortable.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>
+ Enable the sortable.
+ </desc>
+ </method>
+ <method name="option">
+ <desc>
+ Get or set any sortable option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
+ </argument>
+ <argument name="value" type="Object" optional="true">
+ </argument>
+ </method>
+ <method name="option">
+ <desc>
+ Set multiple sortable options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
+ </method>
+ <method name="refresh">
+ <desc>Refresh the sortable items. Custom trigger the reloading of all sortable items, causing new items to be recognized.</desc>
+ </method>
+ <method name="refreshPositions">
+ <desc>Refresh the cached positions of the sortables' items. Calling this method refreshes the cached item positions of all sortables. This is usually done automatically by the script and slows down performance. Use wisely.</desc>
+ </method>
<method name="serialize">
<desc>Serializes the sortable's item id's into a form/ajax submittable string. Calling this method produces a hash that can be appended to any url to easily submit a new item order back to the server.
@@ -254,24 +297,11 @@ then
<pre><![CDATA[result[0] will contain "hello" and result[1] will contain "goodbye".]]></pre></desc>
</method>
- <method name="refresh">
- <desc>Refresh the sortable items. Custom trigger the reloading of all sortable items, causing new items to be recognized.</desc>
- </method>
- <method name="refreshPositions">
- <desc>Refresh the cached positions of the sortables' items. Calling this method refreshes the cached item positions of all sortables. This is usually done automatically by the script and slows down performance. Use wisely.</desc>
- </method>
- <method name="cancel">
- <desc>Cancels a change in the current sortable and reverts it back to how it was before the current sort started. Useful in the stop and receive callback functions.
-
-If the sortable item is not being moved from one connected sortable to another:
-<pre><![CDATA[$(this).sortable('cancel');]]></pre>
-will cancel the change.
-
-If the sortable item is being moved from one connected sortable to another:
-<pre><![CDATA[$(ui.sender).sortable('cancel');]]></pre>
-will cancel the change. Useful in the 'receive' callback.</desc>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
</method>
-
</methods>
<example>
View
78 entries/tabs.xml
@@ -271,6 +271,9 @@ resizeMap() will call Google Maps' checkResize() on the particular map.
</events>
<methods>
+ <method name="abort">
+ <desc>Terminate all running tab ajax requests and animations.</desc>
+ </method>
<method name="add">
<desc>String</desc>
<argument name="url" type="String">
@@ -283,50 +286,58 @@ resizeMap() will call Google Maps' checkResize() on the particular map.
<desc></desc>
</argument>
</method>
- <method name="remove">
- <desc>Remove a tab. The second argument is the zero-based index of the tab to be removed. Instead of an index, the href of the tab may be passed.</desc>
- <argument name="index" type="Number, String">
- <desc></desc>
- </argument>
- </method>
- <method name="enable">
- <desc>Enable a disabled tab. To enable more than one tab at once reset the disabled property like: <code>$('#example').tabs("option","disabled",[]);</code>. The second argument is the zero-based index of the tab to be enabled. Instead of an index, the href of the tab may be passed.</desc>
- <argument name="index" type="Number, String">
- <desc></desc>
- </argument>
+ <method name="disable">
+ <desc>
+ Disable the tabs widget.
+ </desc>
</method>
<method name="disable">
<desc>Disable a tab. The selected tab cannot be disabled. To disable more than one tab at once use: <code>$('#example').tabs("option","disabled", [1, 2, 3]);</code> The second argument is the zero-based index of the tab to be disabled. Instead of an index, the href of the tab may be passed.</desc>
<argument name="index" type="Number, String">
<desc></desc>
</argument>
</method>
- <method name="select">
- <desc>Select a tab, as if it were clicked. The second argument is the zero-based index of the tab to be selected or the id selector of the panel the tab is associated with (the tab's href fragment identifier, e.g. hash, points to the panel's id).</desc>
+ <method name="enable">
+ <desc>
+ Enable the tabs widget.
+ </desc>
+ </method>
+ <method name="enable">
+ <desc>Enable a disabled tab. To enable more than one tab at once reset the disabled property like: <code>$('#example').tabs("option","disabled",[]);</code>. The second argument is the zero-based index of the tab to be enabled. Instead of an index, the href of the tab may be passed.</desc>
<argument name="index" type="Number, String">
<desc></desc>
</argument>
</method>
+ <method name="length">
+ <desc>Retrieve the number of tabs of the first matched tab pane.</desc>
+ </method>
<method name="load">
<desc>Reload the content of an Ajax tab programmatically. This method always loads the tab content from the remote location, even if cache is set to true. The second argument is the zero-based index of the tab to be reloaded. </desc>
<argument name="index" type="Number">
<desc></desc>
</argument>
</method>
- <method name="url">
- <desc>String</desc>
- <argument name="index" type="Number">
- <desc></desc>
+ <method name="option">
+ <desc>
+ Get or set any tabs widget option. If no value is specified, will act as a getter.
+ </desc>
+ <argument name="optionName" type="String">
</argument>
- <argument name="url" type="String">
- <desc></desc>
+ <argument name="value" type="Object" optional="true">
</argument>
</method>
- <method name="length">
- <desc>Retrieve the number of tabs of the first matched tab pane.</desc>
+ <method name="option">
+ <desc>
+ Set multiple tabs widget options at once by providing an options object.
+ </desc>
+ <argument name="options" type="Object">
+ </argument>
</method>
- <method name="abort">
- <desc>Terminate all running tab ajax requests and animations.</desc>
+ <method name="remove">
+ <desc>Remove a tab. The second argument is the zero-based index of the tab to be removed. Instead of an index, the href of the tab may be passed.</desc>
+ <argument name="index" type="Number, String">
+ <desc></desc>
+ </argument>
</method>
<method name="rotate">
<desc>Boolean</desc>
@@ -337,7 +348,26 @@ resizeMap() will call Google Maps' checkResize() on the particular map.
<desc></desc>
</argument>
</method>
-
+ <method name="select">
+ <desc>Select a tab, as if it were clicked. The second argument is the zero-based index of the tab to be selected or the id selector of the panel the tab is associated with (the tab's href fragment identifier, e.g. hash, points to the panel's id).</desc>
+ <argument name="index" type="Number, String">
+ <desc></desc>
+ </argument>
+ </method>
+ <method name="url">
+ <desc>String</desc>
+ <argument name="index" type="Number">
+ <desc></desc>
+ </argument>
+ <argument name="url" type="String">
+ <desc></desc>
+ </argument>
+ </method>
+ <method name="widget">
+ <desc>
+ Returns the widget
+ </desc>
+ </method>
</methods>
<example>

0 comments on commit 6b2fe03

Please sign in to comment.