Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

merged with 0.51-y

  • Loading branch information...
commit bab17f226250484739105c57950a67000676ee24 2 parents 106b40d + 483aaeb
michael authored
View
278 GPL-LICENSE.txt
@@ -0,0 +1,278 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
View
2  README.textile
@@ -4,7 +4,7 @@ This is supposed become the final version (1.0) of jQuery UI Multiselect one day
Please visit Yanick's demo page to see the most recent version in action!
-"http://yanickrochon.uuuq.com/multiselect/com":http://yanickrochon.uuuq.com/multiselect/
+"http://yanickrochon.uuuq.com/multiselect/":http://yanickrochon.uuuq.com/multiselect/
If you have suggestions or did some nice modifications just let us know.
We'd be happy to review them, and perhaps include them.
View
7 css/common.css
@@ -46,6 +46,7 @@ div#header h1 {margin:0; padding:0;}
ul#nav {position:absolute; top:0px; right:10px; list-style:none; margin:0; padding:0;}
ul#nav li {display:inline; padding:0 0 0 5px;}
ul#nav li a {}
+div#version {position:absolute; top:20px; right:10px; margin:0; padding:0;}
div#content {}
div#footer {margin:40px 0 0; border-top:1px dotted; padding:10px 0 0;}
.left {float:left;}
@@ -95,7 +96,7 @@ ul.methods-list a:hover {
ul.options-list,
ul.options-list li.option { margin: 20px 0 0 0; padding: 0; list-style-type: none; list-style-image: none; }
-ul.options-list { margin-left: 6px; }
+ul.options-list { margin: 0 0 20px 6px; }
ul.options-list li.option { padding-bottom: 10px !important; }
ul.options-list li.option dl,
ul.options-list li.option dt,
@@ -115,8 +116,8 @@ ul.options-list li.option .option-examples-list dd { margin-left: 10px; }
ul.options-list li.option .option-examples-list dd pre code { background: none; }
ul.events-list,
-ul.events-list li.events { margin: 20px 0 0 0; padding: 0; list-style-type: none; list-style-image: none; }
-ul.events-list { margin-left: 6px; }
+ul.events-list li.event { margin: 20px 0 0 0; padding: 0; list-style-type: none; list-style-image: none; }
+ul.events-list { margin: 0px 0px 20px 6px; }
ul.events-list li.event { padding-bottom: 10px !important; }
ul.events-list li.event dl,
ul.events-list li.event dt,
View
119 index.html
@@ -63,11 +63,13 @@
</p>
<p>
- The widget is available under the MIT license.
- <a id="license" href="#license">View license information</a>
- <div id="license-info" style="display: none;">
+ The widget is available under the dual <a id="license-MIT" href="#license">MIT</a> and <a id="license-GPL" href="#license">GPL</a> licenses.
+ <div id="license-info-MIT" style="display: none;">
<iframe id="frameLicense" name="frameLicense" src="MIT-LICENSE.txt" style="width:100%; height:100%;"></iframe>
</div>
+ <div id="license-info-GPL" style="display: none;">
+ <iframe id="frameLicense" name="frameLicense" src="GPL-LICENSE.txt" style="width:100%; height:100%;"></iframe>
+ </div>
</p>
<ul>
@@ -300,9 +302,25 @@
<li><del>Drag'n'drop may not select items properly. The problem is more apparaent when the containers are sortable.</del</li>
<li><del>Talking about sortables, they are not sorted correctly 90% of the time....</del></li>
<li>The widget may trigger an error inside JQuery itself <em>...but Seems to be fixed, please report if the problem occurs.</em></li>
- <li><a href="http://github.com/yanickrochon/multiselect/issues">...more?</a></li>
+ <li><a href="http://github.com/michael/multiselect/issues">...more?</a></li>
+ </ul>
+
+ <h2>Limitations</h2>
+ <ul>
+ <li>When switching a <code>select</code> list into a JQuery UI Multiselect instance, you should not set the <code>selected</code> attribute directly to the original <code>option</code> elements, but instead use the public <code>select</code> method provided with the widget.</li>
+ <li>When selecting all items (or select none) needs to transfer hundreds of elements from one list to the other, there may be script execution timeout errors. Stopping script execution should not have significant impact on stability, but is in itself annoying to the user. Improvement on the item cache system is on the <a href="#todo">todo list</a></li>
</ul>
+ <h2 id="todo">Todos...</h2>
+ <p>Here's a list of features that may or may not be implemented in future releases (no specific versions).
+ <ul>
+ <li>Support for option groups and disabled options (currently ignored)</li>
+ <li>Restore selected options on page reload for options found via remote search calls</li>
+ <li>Add a <code>sort public method to apply the <code>nodeComparator</code> to all items</li>
+ <li>Speed improvements...</li>
+ <li><a href="http://github.com/michael/multiselect/issues">...more?</a></li>
+ </ul>
+
<h2>Contributors</h2>
<ul>
<li><a href="http://github.com/michael/multiselect/">Michael Aufreiter</a></li>
@@ -466,7 +484,7 @@ <h3 class="option-name"><a href="#option-droppable">droppable</a></h3>
</div>
<div class="option-description">
<p>Enable or disable basic drag and drop functionality between the selected list (left) and the available list (right). The possible values are 'both', 'left', 'right', 'none'. And set drop support in both lists, the selected list, the available list, or no drag and drop respectively.</p>
- <p>This setting is readonly at run-time. Trying to set this property after initialization will display an alert message.</p>
+ <p>This setting is readonly at run-time. Trying to set this property after initialization will trigger a <code>messages<code> event.</p>
</div>
<div class="option-examples">
<h4>Code examples</h4>
@@ -537,7 +555,7 @@ <h3 class="option-name"><a href="#option-nodeComparator">nodeComparator</a></h3>
</div>
<div class="option-description">
<p>Comparator function used in ordering the list's elements during transfer. The function takes two arguments, a and b, and should return a numeric value less than 0 if a &lt; b, 0 if a == b, or greater than 0 if a &gt; b respectively.</p>
- <p>The function is only called when using '+', '-', 'add all' and 'remove all' action controls, and is never called when using drag and drop item transfer. By default, items are sorted by content value ascending. To completely disable automatic list ordering, set <i>nodeComparator</i> to null.</p>
+ <p>The function is only called when the list is not <a href="#option-sortable">sortable</a>. By default, items are sorted by content value ascending. To completely disable automatic list ordering, set <i>nodeComparator</i> to null.</p>
</div>
<div class="option-examples">
<h4>Code examples</h4>
@@ -548,7 +566,7 @@ <h3 class="option-name"><a href="#option-nodeComparator">nodeComparator</a></h3>
<dd>
<pre><code>$('.selector').multiselect({ nodeComparator: function(a, b) {
var ka = node1.data('multiselect.optionLink').val(),
- kb = node2.data('multiselect.optionLink').val();
+ kb = node2.data('multiselect.optionLink').val();
return ka == kb ? 0 : (ka < kb ? -1 : 1);
} } });</code></pre>
</dd>
@@ -578,6 +596,7 @@ <h3 class="option-name"><a href="#option-nodeInserted">nodeInserted</a></h3>
</div>
<div class="option-description">
<p>Callback function fired for each newly inserted items. The function takes the inserted item as a JQuery object and does not expect any return value.</p>
+ <p>Internally, items are cached as a best effort basis, therefore some items may be inserted, removed and re-inserted during manipulations.</p>
</div>
<div class="option-examples">
<h4>Code examples</h4>
@@ -796,7 +815,9 @@ <h3 class="option-name"><a href="#option-remoteUrl">remoteUrl</a></h3>
</dl>
</div>
<div class="option-description">
- <p></p>
+ <p>If the multiselect is <code>searchable</code>, then setting this option will allow fetching new data from a remote script. The returned data may vary if a custom <a href="#option-dataParser">dataParser</a> is set.</p>
+ <p>The default parser expects to receive the data as plain text, one option per line, in the format of :
+ <pre><code>value=text</code></pre>
</div>
<div class="option-examples">
<h4>Code examples</h4>
@@ -832,12 +853,12 @@ <h3 class="option-name"><a href="#option-remoteUrl">remoteUrl</a></h3>
<h3 class="method-name"><a href="#method-enabled">enabled</a></h3>
<dl>
<dt class="method-signature-label">Signature:</dt>
- <dd class="method-signature">.multiselect( 'enabled', <span class="optional">[</span>state<span class="optional">]</span> )</dd>
+ <dd class="method-signature">.multiselect( 'enabled', <span class="optional">[</span>state<span class="optional">]</span>, <span class="optional">[</span>msg<span class="optional">]</span> )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Get or set the state of the enabled multiselect. If no state is specified, will act as a getter.</p>
- </div>
+ <div class="method-description">
+ <p>Get or set the state of the enabled multiselect. If no state is specified, will act as a getter. If state is set to <code>false</code>, the <code>msg</code> argument will display the specified string as custom disabled message inside the multiseelct.</p>
+ </div>
</li>
<li class="method" id="method-deselect">
@@ -848,9 +869,11 @@ <h3 class="method-name"><a href="#method-deselect">deselect</a></h3>
<dd class="method-signature">.multiselect( 'deselect', item )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Deselect the specified item. The value should be key of the option to deselect. If value is numeric and is &gt;= 0 and is &lt; selected item count, the item at position value will be deselected.</p>
- </div>
+ <div class="method-description">
+ <p>Deselect the specified item. The value should be the text of the option to verify (not case sensitive).</p>
+ <p>If only the option key is known, the option may be specified using the following command:</p>
+ <pre><code>$('.mulstiselect').multiselect('deselect', $('.multiselect').find('option[value=key]').text() );</code></pre>
+ </div>
</li>
<li class="method" id="method-destroy">
@@ -861,9 +884,9 @@ <h3 class="method-name"><a href="#method-destroy">destroy</a></h3>
<dd class="method-signature">.multiselect( 'destroy' )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Remove the multiselect functionality completely. This will return the element back to it's default look.</p>
- </div>
+ <div class="method-description">
+ <p>Remove the multiselect functionality completely. This will return the element back to it's default look.</p>
+ </div>
</li>
<li class="method" id="method-isBusy">
@@ -874,9 +897,9 @@ <h3 class="method-name"><a href="#method-isBusy">isBusy</a></h3>
<dd class="method-signature">.multiselect( 'isBusy' )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Return the busy state of the multiselect. The method will return true if the multiselect is processing item selection, search, etc.</p>
- </div>
+ <div class="method-description">
+ <p>Return the busy state of the multiselect. The method will return true if the multiselect is processing item selection, search, etc.</p>
+ </div>
</li>
<li class="method" id="method-isSelected">
@@ -887,9 +910,11 @@ <h3 class="method-name"><a href="#method-isSelected">isSelected</a></h3>
<dd class="method-signature">.multiselect( 'isSelected', item )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Return true if and only if item is selected. The value should be key of the option to verify. If value is numeric and is &gt;= 0 and is &lt; selected item count, the method will return true.</p>
- </div>
+ <div class="method-description">
+ <p>Return true if and only if item is selected. The value should be the text of the option to verify (not case sensitive).</p>
+ <p>If only the option key is known, the option may be specified using the following command:</p>
+ <pre><code>$('.mulstiselect').multiselect('isSelected', $('.multiselect').find('option[value=key]').text() );</code></pre>
+ </div>
</li>
<li class="method" id="method-option">
@@ -900,9 +925,9 @@ <h3 class="method-name"><a href="#method-option">option</a></h3>
<dd class="method-signature">.multiselect( 'option', optionName, <span class="optional">[</span>value<span class="optional">]</span> )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Get or set any dialog option. If no value is specified, will act as a getter.</p>
- </div>
+ <div class="method-description">
+ <p>Get or set any dialog option. If no value is specified, will act as a getter.</p>
+ </div>
</li>
<li class="method" id="method-search">
@@ -913,9 +938,9 @@ <h3 class="method-name"><a href="#method-search">search</a></h3>
<dd class="method-signature">.multiselect( 'search', query )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Perform a search of all the available elements, and filter out (hide) any unmatched item. This method controls the search input fields, if the multiselect is not searchable, is busy, or not enabled, the method does nothing.</p>
- </div>
+ <div class="method-description">
+ <p>Perform a search of all the available elements, and filter out (hide) any unmatched item. This method controls the search input fields, if the multiselect is not searchable, or is busy, or not enabled, the method does nothing.</p>
+ </div>
</li>
<li class="method" id="method-select">
@@ -926,9 +951,11 @@ <h3 class="method-name"><a href="#method-select">select</a></h3>
<dd class="method-signature">.multiselect( 'select', item )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Select the specified item. The value should be key of the option to select. If value is numeric and is &gt;= 0 and is &lt; available item count, the item at position value will be selected.</p>
- </div>
+ <div class="method-description">
+ <p>Select the specified item. The value should the text of the option to select (not case sensitive).</p>
+ <p>If only the option key is known, the option may be specified using the following command:</p>
+ <pre><code>$('.mulstiselect').multiselect('select', $('.multiselect').find('option[value=key]').text() );</code></pre>
+ </div>
</li>
<li class="method" id="method-selectAll">
@@ -939,9 +966,9 @@ <h3 class="method-name"><a href="#method-selectAll">selectAll</a></h3>
<dd class="method-signature">.multiselect( 'selectAll' )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Select all of the available items.</p>
- </div>
+ <div class="method-description">
+ <p>Select all of the available items.</p>
+ </div>
</li>
<li class="method" id="method-selectedValues">
@@ -952,9 +979,11 @@ <h3 class="method-name"><a href="#method-selectedValues">selectedValues</a></h3>
<dd class="method-signature">.multiselect( 'selectedValues' )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Return an array of the keys of all the currently selected values (equivalent to "Add all").</p>
- </div>
+ <div class="method-description">
+ <p>Return an array of the keys of all the currently selected values.</p>
+ <p>This method is an utility method equivalent to :</p>
+ <pre><code>$.map( $('.multiselect').find('option[selected]'), function(item,i) { return $(item).val(); });</code></pre>
+ </div>
</li>
<li class="method" id="method-selectNone">
@@ -965,9 +994,9 @@ <h3 class="method-name"><a href="#method-selectNone">selectNone</a></h3>
<dd class="method-signature">.multiselect( 'selectNone' )</dd>
</dl>
</div>
- <div class="method-description">
- <p>Deselect all the selected items (equivalent to "Remove all").</p>
- </div>
+ <div class="method-description">
+ <p>Deselect all the selected items (equivalent to "Remove all").</p>
+ </div>
</li>
</ul>
@@ -999,7 +1028,7 @@ <h3 class="event-name"><a href="#event-deselected">deselected</a></h3>
<div class="event-description">
<p>This event is triggered whenever the an option has been deselected. The event <code>deselected</code> is triggered for every option deselected.</p>
</div>
- <div class="option-examples">
+ <div class="event-examples">
<h4>Code examples</h4>
<dl class="option-examples-list">
<dt>
@@ -1034,7 +1063,7 @@ <h3 class="event-name"><a href="#event-messages">messages</a></h3>
<div class="event-description">
<p>This event is triggered whenever the widget needs to send some feedback to the user.</p>
</div>
- <div class="option-examples">
+ <div class="event-examples">
<h4>Code examples</h4>
<dl class="option-examples-list">
<dt>
@@ -1075,7 +1104,7 @@ <h3 class="event-name"><a href="#event-selected">selected</a></h3>
<div class="event-description">
<p>This event is triggered whenever the an option has been selected. The event <code>selected</code> is triggered for every option selected.</p>
</div>
- <div class="option-examples">
+ <div class="event-examples">
<h4>Code examples</h4>
<dl class="option-examples-list">
<dt>
View
41 js/page.js
@@ -36,21 +36,27 @@ $(function() {
;
};
- $.get('version.txt', function(data) { $('#header > h1:first').after('<span style="font-size:12px; font-family: arial;">version ' + data + '</span>'); });
+ $.ajaxSetup({ cache: false }); // prevent server caching the requests throughout the demo page
+ $.get('version.txt', function(data) { $('#header #version').text('version ' + data); });
- $('#license-info').dialog({
+ $('#license-info-MIT').dialog({
autoOpen:false,
- title:"License information",
+ title:"License information - MIT",
width:580,
height:380,
resizable:false,
modal:true
});
- $('#license').click(function() {
- $('#license-info').dialog('open');
- return false;
+ $('#license-MIT').click(function() { $('#license-info-MIT').dialog('open'); return false; });
+ $('#license-info-GPL').dialog({
+ autoOpen:false,
+ title:"License information - GPL",
+ width:620,
+ height:380,
+ resizable:false,
+ modal:true
});
-
+ $('#license-GPL').click(function() { $('#license-info-GPL').dialog('open'); return false; });
$('#tabs, #optionTabs').tabs();
@@ -126,5 +132,26 @@ $(function() {
getVisibleMultiselect().multiselect('deselect', $('#ec_inputItem').val() );
});
+ $('.options-list').find('.option-description, .option-examples').hide().end()
+ .find('.option-name a').click(function() {
+ var a = $(this);
+ var p = a.parents(a.attr('href'));
+ p.find('.option-examples, .option-description')['slide' + (p.find('.option-description').is(':visible') ? 'Up' : 'Down')]('fast');
+ return false;
+ });
+ $('.methods-list').find('.method-header > dl, .method-description').hide().end()
+ .find('.method-name a').click(function() {
+ var a = $(this);
+ var p = a.parents(a.attr('href'));
+ p.find('.method-header > dl, .method-description')['slide' + (p.find('.method-description').is(':visible') ? 'Up' : 'Down')]('fast');
+ return false;
+ });
+ $('.events-list').find('.event-description, .event-examples').hide().end()
+ .find('.event-name a').click(function() {
+ var a = $(this);
+ var p = a.parents(a.attr('href'));
+ p.find('.event-examples, .event-description')['slide' + (p.find('.event-description').is(':visible') ? 'Up' : 'Down')]('fast');
+ return false;
+ });
});
View
49 js/ui.multiselect.js
@@ -29,6 +29,8 @@
* Todo:
* restore selected items on remote searchable multiselect upon page reload (same behavior as local mode)
* (is it worth it??) add a public function to apply the nodeComparator to all items (when using nodeComparator setter)
+ * support for option groups, disabled options, etc.
+ * speed improvements
* tests and optimizations
* - test getters/setters (including options from the defaults)
*/
@@ -106,7 +108,7 @@ $.widget("ui.multiselect", {
$.widget.prototype.destroy.apply(this, arguments);
},
isBusy: function() {
- return this.busy;
+ return !!this.busy;
},
isSelected: function(item) {
if (this.enabled()) {
@@ -117,10 +119,7 @@ $.widget("ui.multiselect", {
},
// get all selected values in an array
selectedValues: function() {
- var values = this.selectedList.children('li.ui-element:visible').map(function(i,item) {
- return $(item).data('multiselect.optionLink').val();
- });
- return Array.prototype.slice.apply(values);
+ return $.map( this.element.find('option[selected]'), function(item,i) { return $(item).val(); });
},
// get/set enable state
enabled: function(state, msg) {
@@ -172,7 +171,6 @@ $.widget("ui.multiselect", {
// @return int the number of options added
addOptions: function(data) {
if (this.enabled()) {
- var wasBusy = this.busy;
this._setBusy(true);
// format data
@@ -192,7 +190,7 @@ $.widget("ui.multiselect", {
this._filter(this.availableList.children('li.ui-element'));
- this._setBusy(wasBusy);
+ this._setBusy(false);
return elements.length;
} else {
return false;
@@ -275,7 +273,7 @@ $.widget("ui.multiselect", {
revert: !(opts[otherSide].sortable || opts[otherSide].droppable),
receive: function(event, ui) {
// DEBUG
- that._messages(0, "Receive : " + ui.item.data('multiselect.optionLink') + ":" + ui.item.parent()[0].className + " = " + itemSelected);
+ //that._messages(0, "Receive : " + ui.item.data('multiselect.optionLink') + ":" + ui.item.parent()[0].className + " = " + itemSelected);
// we received an element from a sortable to another sortable...
if (opts[otherSide].sortable) {
@@ -299,7 +297,7 @@ $.widget("ui.multiselect", {
},
stop: function(event, ui) {
// DEBUG
- that._messages(0, "Stop : " + (ui.item.parent()[0] == otherList[0]));
+ //that._messages(0, "Stop : " + (ui.item.parent()[0] == otherList[0]));
that._moveOptionNode(ui.item);
}
});
@@ -316,7 +314,7 @@ $.widget("ui.multiselect", {
greedy: true,
drop: function(event, ui) {
// DEBUG
- that._messages(0, "drop " + side + " = " + ui.draggable.data('multiselect.optionLink') + ":" + ui.draggable.parent()[0].className);
+ //that._messages(0, "drop " + side + " = " + ui.draggable.data('multiselect.optionLink') + ":" + ui.draggable.parent()[0].className);
//alert( "drop " + itemSelected );
// if no optionLink is defined, it was dragged in
@@ -369,7 +367,6 @@ $.widget("ui.multiselect", {
},
_insertToList: function(node, list) {
var that = this;
- var wasBusy = this.busy;
this._setBusy(true);
// the browsers don't like batch node insertion...
var _addNodeRetry = 0;
@@ -385,7 +382,7 @@ $.widget("ui.multiselect", {
// callback after node insertion
if ('function' == typeof that.options.nodeInserted) that.options.nodeInserted(node);
- that._setBusy(wasBusy);
+ that._setBusy(false);
} catch (e) {
// if this problem did not occur too many times already
if ( _addNodeRetry++ < 10 ) {
@@ -397,7 +394,7 @@ $.widget("ui.multiselect", {
$.ui.multiselect.locale.errorInsertNode,
{key:node.data('multiselect.optionLink').val(), value:node.text()}
);
- that._setBusy(wasBusy);
+ that._setBusy(false);
}
}
};
@@ -482,7 +479,6 @@ $.widget("ui.multiselect", {
return clone;
},
_batchSelect: function(elements, state) {
- var wasBusy = this.busy;
this._setBusy(true);
var that = this;
@@ -509,7 +505,7 @@ $.widget("ui.multiselect", {
$.extend(that.options, _backup);
that._updateCount();
- that._setBusy(wasBusy);
+ that._setBusy(false);
}, 10);
},
// find the best successor the given item in the specified list
@@ -604,22 +600,27 @@ $.widget("ui.multiselect", {
var input = this.availableActions.children('input.search');
var busy = this.availableActions.children('.busy');
- this.container.find("a.remove-all, a.add-all")[state ? 'hide' : 'show']();
- if (state && !this.busy) {
- // backup input state
- input.data('multiselect.hadFocus', input.data('multiselect.hasFocus'));
- // webkit needs to blur before hiding or it won't fire focus again in the else block
- input.blur().hide();
+ this.busy = Math.max(state ? ++this.busy : --this.busy, 0);
+
+ this.container.find("a.remove-all, a.add-all")[this.busy ? 'hide' : 'show']();
+ if (state && (1 == this.busy)) {
+ if (this.options.searchable) {
+ // backup input state
+ input.data('multiselect.hadFocus', input.data('multiselect.hasFocus'));
+ // webkit needs to blur before hiding or it won't fire focus again in the else block
+ input.blur().hide();
+ }
busy.show();
- } else if(!state && this.busy) {
+ } else if(!this.busy) {
if (this.options.searchable) {
input.show();
+ if (input.data('multiselect.hadFocus')) input.focus();
}
busy.hide();
- if (input.data('multiselect.hadFocus')) input.focus();
}
- this.busy = state;
+ // DEBUG
+ //this._messages(0, "Busy state changed to : " + this.busy);
},
_applyItemState: function(item, selected) {
if (selected) {
View
2  version.txt
@@ -1 +1 @@
-0.5-y
+0.51-y
Please sign in to comment.
Something went wrong with that request. Please try again.