Move mediawiki.special.js to the correct directory. Followup r90941, r90960
[lhc/web/wiklou.git] / resources / jquery / jquery.makeCollapsible.js
index 887e468..a84f405 100644 (file)
  * @license CC-BY 3.0 <http://creativecommons.org/licenses/by/3.0>
  * @license GPL2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
  */
+( function( $, mw ) {
 
 $.fn.makeCollapsible = function() {
 
        return this.each(function() {
-               mw.config.set( 'mw.log.prefix', 'jquery.makeCollapsible' );
+               var _fn = 'jquery.makeCollapsible> ';
 
                // Define reused variables and functions
                var     $that = $(this).addClass( 'mw-collapsible' ), // case: $( '#myAJAXelement' ).makeCollapsible()
                        that = this,
                        collapsetext = $(this).attr( 'data-collapsetext' ),
                        expandtext = $(this).attr( 'data-expandtext' ),
-                       toggleElement = function( $collapsible, action, $defaultToggle ) {
+                       toggleElement = function( $collapsible, action, $defaultToggle, instantHide ) {
                                // Validate parameters
                                if ( !$collapsible.jquery ) { // $collapsible must be an instance of jQuery
                                        return;
@@ -34,10 +35,17 @@ $.fn.makeCollapsible = function() {
                                        // action must be string with 'expand' or 'collapse'
                                        return;
                                }
-                               if ( typeof $defaultToggle !== 'undefined' && !$defaultToggle.jquery ) {
-                                       // is optional, but if passed must be an instance of jQuery
+                               if ( typeof $defaultToggle == 'undefined' ) {
+                                       $defaultToggle = null;
+                               }
+                               if ( $defaultToggle !== null && !($defaultToggle instanceof jQuery) ) {
+                                       // is optional (may be undefined), but if defined it must be an instance of jQuery.
+                                       // If it's not, abort right away.
+                                       // After this $defaultToggle is either null or a valid jQuery instance.
                                        return;
                                }
+                               
+                               var $containers = null;
 
                                if ( action == 'collapse' ) {
 
@@ -46,47 +54,90 @@ $.fn.makeCollapsible = function() {
                                                // Hide all table rows of this table
                                                // Slide doens't work with tables, but fade does as of jQuery 1.1.3
                                                // http://stackoverflow.com/questions/467336#920480
-
-                                               if ( $defaultToggle.jquery ) {
+                                               $containers = $collapsible.find( '>tbody>tr' );
+                                               if ( $defaultToggle ) { 
                                                        // Exclude tablerow containing togglelink
-                                                       $collapsible.find( '>tbody>tr' ).not( $defaultToggle.parent().parent() ).stop(true, true).fadeOut();
+                                                       $containers.not( $defaultToggle.closest( 'tr' ) ).stop(true, true).fadeOut();
                                                } else {
-                                                       $collapsible.find( '>tbody>tr' ).stop( true, true ).fadeOut();
+                                                       if ( instantHide ) {    
+                                                               $containers.hide();
+                                                       } else {
+                                                               $containers.stop( true, true ).fadeOut();
+                                                       }
                                                }
        
                                        } else if ( $collapsible.is( 'ul' ) || $collapsible.is( 'ol' ) ) {
-                                               if ( $defaultToggle.jquery ) {
+                                               $containers = $collapsible.find( '> li' );
+                                               if ( $defaultToggle ) {
                                                        // Exclude list-item containing togglelink
-                                                       $collapsible.find( '> li' ).not( $defaultToggle.parent() ).stop( true, true ).slideUp();
+                                                       $containers.not( $defaultToggle.parent() ).stop( true, true ).slideUp();
                                                } else {
-                                                       $collapsible.find( '> li' ).stop( true, true ).slideUp();
+                                                       if ( instantHide ) {
+                                                               $containers.hide();
+                                                       } else {
+                                                               $containers.stop( true, true ).slideUp();
+                                                       }
                                                }
        
                                        } else { // <div>, <p> etc.
-                                               $collapsible.find( '> .mw-collapsible-content' ).slideUp();
+                                               var $collapsibleContent = $collapsible.find( '> .mw-collapsible-content' );
+                                               
+                                               // If a collapsible-content is defined, collapse it
+                                               if ( $collapsibleContent.length ) {
+                                                       if ( instantHide ) {
+                                                               $collapsibleContent.hide();
+                                                       } else {
+                                                               $collapsibleContent.slideUp();
+                                                       }
+
+                                               // Otherwise assume this is a customcollapse with a remote toggle
+                                               // .. and there is no collapsible-content because the entire element should be toggled
+                                               } else {
+                                                       if ( $collapsible.is( 'tr' ) || $collapsible.is( 'td' ) || $collapsible.is( 'th' ) ) {
+                                                               $collapsible.fadeOut();
+                                                       } else {
+                                                               $collapsible.slideUp();
+                                                       }
+                                               }
                                        }
 
                                } else {
                                
                                        // Expand the element
                                        if ( $collapsible.is( 'table' ) ) {
-                                               if ( $defaultToggle.jquery ) {
+                                               $containers = $collapsible.find( '>tbody>tr' );
+                                               if ( $defaultToggle ) {
                                                        // Exclude tablerow containing togglelink
-                                                       $collapsible.find( '>tbody>tr' ).not( $defaultToggle.parent().parent() ).stop(true, true).fadeIn();
+                                                       $containers.not( $defaultToggle.parent().parent() ).stop(true, true).fadeIn();
                                                } else {
-                                                       $collapsible.find( '>tbody>tr' ).stop(true, true).fadeIn();
+                                                       $containers.stop(true, true).fadeIn();
                                                }
        
                                        } else if ( $collapsible.is( 'ul' ) || $collapsible.is( 'ol' ) ) {
-                                               if ( $defaultToggle.jquery ) {
+                                               $containers = $collapsible.find( '> li' );
+                                               if ( $defaultToggle ) {
                                                        // Exclude list-item containing togglelink
-                                                       $collapsible.find( '> li' ).not( $defaultToggle.parent() ).stop( true, true ).slideDown();
+                                                       $containers.not( $defaultToggle.parent() ).stop( true, true ).slideDown();
                                                } else {
-                                                       $collapsible.find( '> li' ).stop( true, true ).slideDown();
+                                                       $containers.stop( true, true ).slideDown();
                                                }
        
                                        } else { // <div>, <p> etc.
-                                               $collapsible.find( '> .mw-collapsible-content' ).slideDown();
+                                               var $collapsibleContent = $collapsible.find( '> .mw-collapsible-content' );
+                                               
+                                               // If a collapsible-content is defined, collapse it
+                                               if ( $collapsibleContent.length ) {
+                                                       $collapsibleContent.slideDown();
+
+                                               // Otherwise assume this is a customcollapse with a remote toggle
+                                               // .. and there is no collapsible-content because the entire element should be toggled
+                                               } else {
+                                                       if ( $collapsible.is( 'tr' ) || $collapsible.is( 'td' ) || $collapsible.is( 'th' ) ) {
+                                                               $collapsible.fadeIn();
+                                                       } else {
+                                                               $collapsible.slideDown();
+                                                       }
+                                               }
                                        }
                                }
                        },
@@ -95,12 +146,13 @@ $.fn.makeCollapsible = function() {
                                var     $that = $(that),
                                        $collapsible = $that.closest( '.mw-collapsible.mw-made-collapsible' ).toggleClass( 'mw-collapsed' );
                                e.preventDefault();
+                               e.stopPropagation();
                                
                                // It's expanded right now
                                if ( !$that.hasClass( 'mw-collapsible-toggle-collapsed' ) ) {
                                        // Change link to "Show"
                                        $that.removeClass( 'mw-collapsible-toggle-expanded' ).addClass( 'mw-collapsible-toggle-collapsed' );
-                                       if ( $that.find( '> a' ).size() ) {
+                                       if ( $that.find( '> a' ).length ) {
                                                $that.find( '> a' ).text( expandtext );
                                        } else {
                                                $that.text( expandtext );
@@ -112,7 +164,7 @@ $.fn.makeCollapsible = function() {
                                } else {
                                        // Change link to "Hide"
                                        $that.removeClass( 'mw-collapsible-toggle-collapsed' ).addClass( 'mw-collapsible-toggle-expanded' );
-                                       if ( $that.find( '> a' ).size() ) {
+                                       if ( $that.find( '> a' ).length ) {
                                                $that.find( '> a' ).text( collapsetext );
                                        } else {
                                                $that.text( collapsetext );
@@ -123,10 +175,13 @@ $.fn.makeCollapsible = function() {
                                return;
                        },
                        // Toggles collapsible and togglelink class
-                       toggleLinkPremade = function( that, e ) {
-                               var     $that = $(that),
-                                       $collapsible = $that.closest( '.mw-collapsible.mw-made-collapsible' ).toggleClass( 'mw-collapsed' );
+                       toggleLinkPremade = function( $that, e ) {
+                               var     $collapsible = $that.eq(0).closest( '.mw-collapsible.mw-made-collapsible' ).toggleClass( 'mw-collapsed' );
+                               if ( $(e.target).is('a') ) {
+                                       return true;
+                               }
                                e.preventDefault();
+                               e.stopPropagation();
                                
                                // It's expanded right now
                                if ( !$that.hasClass( 'mw-collapsible-toggle-collapsed' ) ) {
@@ -145,35 +200,38 @@ $.fn.makeCollapsible = function() {
                                return;
                        },
                        // Toggles customcollapsible
-                       toggleLinkCustom = function( that, e ) {
-                               var     $that = $(that),
-                                       classes = that.className.split(' ');
-                               e.preventDefault();
-                               // Check each class to see if it belongs to a customcollapse
-                               for ( i = 0; i < classes.length; i++ ) {
-                                       if ( classes[i].indexOf( 'mw-customtoggle-' ) === 0 ) {
-                                               var id = '#' + classes[i].replace( 'mw-customtoggle-', 'mw-customcollapsible-' ),
-                                                       $collapsible = $( id ),
-                                                       action = $collapsible.hasClass( 'mw-collapsed' ) ? 'expand' : 'collapse';
-
-                                               $collapsible.toggleClass( 'mw-collapsed' );
-                                               toggleElement( $collapsible, action, $that );
-                                       }
+                       toggleLinkCustom = function( $that, e, $collapsible ) {
+                               // For the initial state call of customtogglers there is no event passed
+                               if (e) {
+                                       e.preventDefault();
+                               e.stopPropagation();
                                }
+                               // Get current state and toggle to the opposite
+                               var action = $collapsible.hasClass( 'mw-collapsed' ) ? 'expand' : 'collapse';
+                               $collapsible.toggleClass( 'mw-collapsed' );
+                               toggleElement( $collapsible, action, $that );
+                               
                        };
 
                // Use custom text or default ?
-               if( !collapsetext || collapsetext === '' ){
-                       collapsetext = mw.msg( 'collapsible-collapse', 'Collapse' );
+               if( !collapsetext {
+                       collapsetext = mw.msg( 'collapsible-collapse' );
                }
-               if ( !expandtext || expandtext === '' ){
-                       expandtext = mw.msg( 'collapsible-expand', 'Expand' );
+               if ( !expandtext {
+                       expandtext = mw.msg( 'collapsible-expand' );
                }
 
                // Create toggle link with a space around the brackets (&nbsp;[text]&nbsp;)
-               var $toggleLink = $( '<a href="#">' ).text( collapsetext ).wrap( '<span class="mw-collapsible-toggle">' ).parent().prepend( '&nbsp;[' ).append( ']&nbsp;' ).bind( 'click.mw-collapse', function(e){
-                       toggleLinkDefault( this, e );
-               } );
+               var $toggleLink =
+                       $( '<a href="#"></a>' )
+                               .text( collapsetext )
+                               .wrap( '<span class="mw-collapsible-toggle"></span>' )
+                               .parent()
+                               .prepend( '&nbsp;[' )
+                               .append( ']&nbsp;' )
+                               .bind( 'click.mw-collapse', function(e) {
+                                       toggleLinkDefault( this, e );
+                               } );
 
                // Return if it has been enabled already.
                if ( $that.hasClass( 'mw-made-collapsible' ) ) {
@@ -185,24 +243,26 @@ $.fn.makeCollapsible = function() {
                // Check if this element has a custom position for the toggle link
                // (ie. outside the container or deeper inside the tree)
                // Then: Locate the custom toggle link(s) and bind them
-               if ( $that.attr( 'id' ).indexOf( 'mw-customcollapsible-' ) === 0 ) {
+               if ( ( $that.attr( 'id' ) || '' ).indexOf( 'mw-customcollapsible-' ) === 0 ) {
 
                        var thatId = $that.attr( 'id' ),
                                $customTogglers = $( '.' + thatId.replace( 'mw-customcollapsible', 'mw-customtoggle' ) );
-                       mw.log( 'Found custom collapsible: #' + thatId );
+                       mw.log( _fn + 'Found custom collapsible: #' + thatId );
                                                
                        // Double check that there is actually a customtoggle link
-                       if ( $customTogglers.size() ) {
+                       if ( $customTogglers.length ) {
                                $customTogglers.bind( 'click.mw-collapse', function( e ) {
-                                       toggleLinkCustom( this, e );
+                                       toggleLinkCustom( $(this), e, $that );
                                } );
                        } else {
-                               mw.log( '#' + thatId + ': Missing toggler!' );
+                               mw.log( _fn + '#' + thatId + ': Missing toggler!' );
                        }
                        
-                       // To change initial state at the bottom of the script
-                       // Set this variable to one of the togglers
-                       var $toggleLink = $customTogglers.eq(0);
+                       // Initial state
+                       if ( $that.hasClass( 'mw-collapsed' ) ) {
+                               $that.removeClass( 'mw-collapsed' );
+                               toggleLinkCustom( $customTogglers, null, $that );
+                       }
 
                // If this is not a custom case, do the default:
                // Wrap the contents add the toggle link 
@@ -215,11 +275,11 @@ $.fn.makeCollapsible = function() {
                                        $toggle = $firstRowCells.find( '> .mw-collapsible-toggle' );
        
                                // If theres no toggle link, add it to the last cell
-                               if ( !$toggle.size() ) {
+                               if ( !$toggle.length ) {
                                        $firstRowCells.eq(-1).prepend( $toggleLink );
                                } else {
-                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ){
-                                               toggleLinkPremade( this, e );
+                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ) {
+                                               toggleLinkPremade( $toggle, e );
                                        } );
                                }
                                
@@ -229,43 +289,51 @@ $.fn.makeCollapsible = function() {
                                        $toggle = $firstItem.find( '> .mw-collapsible-toggle' );
        
                                // If theres no toggle link, add it
-                               if ( !$toggle.size() ) {
-                                       // Make sure the numeral order doesn't get messed up, reset to 1 unless value-attribute is already used
-                                       // WebKit return '' if no value, Mozilla returns '-1' is no value
-                                       if ( $firstItem.attr( 'value' ) == '' || $firstItem.attr( 'value' ) == '-1' ) { // Will fail with ===
+                               if ( !$toggle.length ) {
+                                       // Make sure the numeral order doesn't get messed up, force the first (soon to be second) item
+                                       // to be "1". Except if the value-attribute is already used.
+                                       // If no value was set WebKit returns "", Mozilla returns '-1', others return null or undefined.
+                                       var firstval = $firstItem.attr( 'value' );
+                                       if ( firstval === undefined || !firstval || firstval == '-1' ) { 
                                                $firstItem.attr( 'value', '1' );
                                        }
-                                       $that.prepend( $toggleLink.wrap( '<li class="mw-collapsible-toggle-li">' ).parent() );
+                                       $that.prepend( $toggleLink.wrap( '<li class="mw-collapsible-toggle-li"></li>' ).parent() );
                                } else {
-                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ){
-                                               toggleLinkPremade( this, e );
+                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ) {
+                                               toggleLinkPremade( $toggle, e );
                                        } );
                                }
        
                        } else { // <div>, <p> etc.
-                               // If a direct child .content-wrapper does not exists, create it
-                               if ( !$that.find( '> .mw-collapsible-content' ).size() ) {
-                                       $that.wrapInner( '<div class="mw-collapsible-content">' );
-                               }
        
                                // The toggle-link will be the first child of the element
                                var $toggle = $that.find( '> .mw-collapsible-toggle' );
+
+                               // If a direct child .content-wrapper does not exists, create it
+                               if ( !$that.find( '> .mw-collapsible-content' ).length ) {
+                                       $that.wrapInner( '<div class="mw-collapsible-content"></div>' );
+                               }
        
                                // If theres no toggle link, add it
-                               if ( !$toggle.size() ) {
+                               if ( !$toggle.length ) {
                                        $that.prepend( $toggleLink );
                                } else {
-                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ){
-                                               toggleLinkPremade( this, e );
+                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ) {
+                                               toggleLinkPremade( $toggle, e );
                                        } );
                                }
                        }
                }
 
-               // Initial state
-               if ( $that.hasClass( 'mw-collapsed' ) ) {
+               // Initial state (only for those that are not custom)
+               if ( $that.hasClass( 'mw-collapsed' ) && ( $that.attr( 'id' ) || '').indexOf( 'mw-customcollapsible-' ) !== 0 ) {
                        $that.removeClass( 'mw-collapsed' );
-                       $toggleLink.click();
+                       // The collapsible element could have multiple togglers
+                       // To toggle the initial state only click one of them (ie. the first one, eq(0) )
+                       // Else it would go like: hide,show,hide,show for each toggle link.
+                       toggleElement( $that, 'collapse', $toggleLink.eq(0), /* instantHide = */ true );
+                       $toggleLink.eq(0).click();
                }
        } );
-};
\ No newline at end of file
+};
+} )( jQuery, mediaWiki );
\ No newline at end of file