Dialog: Coding standards.

This commit is contained in:
Scott González 2010-12-17 19:53:22 -05:00
parent c4701388e4
commit c614889b30

279
ui/jquery.ui.dialog.js vendored
View File

@ -18,11 +18,7 @@
*/
(function( $, undefined ) {
var uiDialogClasses =
'ui-dialog ' +
'ui-widget ' +
'ui-widget-content ' +
'ui-corner-all ',
var uiDialogClasses = "ui-dialog ui-widget ui-widget-content ui-corner-all ",
sizeRelatedOptions = {
buttons: true,
height: true,
@ -44,39 +40,39 @@ $.widget("ui.dialog", {
autoOpen: true,
buttons: {},
closeOnEscape: true,
closeText: 'close',
dialogClass: '',
closeText: "close",
dialogClass: "",
draggable: true,
hide: null,
height: 'auto',
height: "auto",
maxHeight: false,
maxWidth: false,
minHeight: 150,
minWidth: 150,
modal: false,
position: {
my: 'center',
at: 'center',
my: "center",
at: "center",
of: window,
collision: 'fit',
collision: "fit",
// ensure that the titlebar is never outside the document
using: function( pos ) {
var topOffset = $( this ).css( pos ).offset().top;
if ( topOffset < 0 ) {
$(this).css('top', pos.top - topOffset);
$( this ).css( "top", pos.top - topOffset );
}
}
},
resizable: true,
show: null,
stack: true,
title: '',
title: "",
width: 300,
zIndex: 1000
},
_create: function() {
this.originalTitle = this.element.attr('title');
this.originalTitle = this.element.attr( "title" );
// #5742 - .attr() might return a DOMElement
if ( typeof this.originalTitle !== "string" ) {
this.originalTitle = "";
@ -86,10 +82,10 @@ $.widget("ui.dialog", {
var self = this,
options = self.options,
title = options.title || '&#160;',
title = options.title || "&#160;",
titleId = $.ui.dialog.getTitleId( self.element ),
uiDialog = (self.uiDialog = $('<div></div>'))
uiDialog = ( self.uiDialog = $( "<div>" ) )
.appendTo( document.body )
.hide()
.addClass( uiDialogClasses + options.dialogClass )
@ -97,18 +93,19 @@ $.widget("ui.dialog", {
zIndex: options.zIndex
})
// setting tabIndex makes the div focusable
// setting outline to 0 prevents a border on focus in Mozilla
.attr('tabIndex', -1).css('outline', 0).keydown(function(event) {
.attr( "tabIndex", -1)
// TODO: move to stylesheet
.css( "outline", 0 )
.keydown(function( event ) {
if ( options.closeOnEscape && event.keyCode &&
event.keyCode === $.ui.keyCode.ESCAPE ) {
self.close( event );
event.preventDefault();
}
})
.attr({
role: 'dialog',
'aria-labelledby': titleId
role: "dialog",
"aria-labelledby": titleId
})
.mousedown(function( event ) {
self.moveToTop( false, event );
@ -116,40 +113,31 @@ $.widget("ui.dialog", {
uiDialogContent = self.element
.show()
.removeAttr('title')
.addClass(
'ui-dialog-content ' +
'ui-widget-content')
.removeAttr( "title" )
.addClass( "ui-dialog-content ui-widget-content" )
.appendTo( uiDialog ),
uiDialogTitlebar = (self.uiDialogTitlebar = $('<div></div>'))
.addClass(
'ui-dialog-titlebar ' +
'ui-widget-header ' +
'ui-corner-all ' +
'ui-helper-clearfix'
)
uiDialogTitlebar = ( self.uiDialogTitlebar = $( "<div>" ) )
.addClass( "ui-dialog-titlebar ui-widget-header " +
"ui-corner-all ui-helper-clearfix" )
.prependTo( uiDialog ),
uiDialogTitlebarClose = $('<a href="#"></a>')
.addClass(
'ui-dialog-titlebar-close ' +
'ui-corner-all'
)
.attr('role', 'button')
uiDialogTitlebarClose = $( "<a href='#'>" )
.addClass( "ui-dialog-titlebar-close ui-corner-all" )
.attr( "role", "button" )
.hover(
function() {
uiDialogTitlebarClose.addClass('ui-state-hover');
uiDialogTitlebarClose.addClass( "ui-state-hover" );
},
function() {
uiDialogTitlebarClose.removeClass('ui-state-hover');
uiDialogTitlebarClose.removeClass( "ui-state-hover" );
}
)
.focus(function() {
uiDialogTitlebarClose.addClass('ui-state-focus');
uiDialogTitlebarClose.addClass( "ui-state-focus" );
})
.blur(function() {
uiDialogTitlebarClose.removeClass('ui-state-focus');
uiDialogTitlebarClose.removeClass( "ui-state-focus" );
})
.click(function( event ) {
self.close( event );
@ -157,17 +145,14 @@ $.widget("ui.dialog", {
})
.appendTo( uiDialogTitlebar ),
uiDialogTitlebarCloseText = (self.uiDialogTitlebarCloseText = $('<span></span>'))
.addClass(
'ui-icon ' +
'ui-icon-closethick'
)
uiDialogTitlebarCloseText = ( self.uiDialogTitlebarCloseText = $( "<span>" ) )
.addClass( "ui-icon ui-icon-closethick" )
.text( options.closeText )
.appendTo( uiDialogTitlebarClose ),
uiDialogTitle = $('<span></span>')
.addClass('ui-dialog-title')
.attr('id', titleId)
uiDialogTitle = $( "<span>" )
.addClass( "ui-dialog-title" )
.attr( "id", titleId )
.html( title )
.prependTo( uiDialogTitlebar );
@ -202,16 +187,16 @@ $.widget("ui.dialog", {
}
self.uiDialog.hide();
self.element
.unbind('.dialog')
.removeData('dialog')
.removeClass('ui-dialog-content ui-widget-content')
.hide().appendTo('body');
.removeClass( "ui-dialog-content ui-widget-content" )
.hide()
.appendTo( "body" );
self.uiDialog.remove();
if ( self.originalTitle ) {
self.element.attr('title', self.originalTitle);
self.element.attr( "title", self.originalTitle );
}
$.Widget.prototype.destroy.call( this );
return self;
},
@ -223,24 +208,24 @@ $.widget("ui.dialog", {
var self = this,
maxZ, thisZ;
if (false === self._trigger('beforeClose', event)) {
if ( false === self._trigger( "beforeClose", event ) ) {
return;
}
if ( self.overlay ) {
self.overlay.destroy();
}
self.uiDialog.unbind('keypress.ui-dialog');
self.uiDialog.unbind( "keypress.ui-dialog" );
self._isOpen = false;
if ( self.options.hide ) {
self.uiDialog.hide( self.options.hide, function() {
self._trigger('close', event);
self._trigger( "close", event );
});
} else {
self.uiDialog.hide();
self._trigger('close', event);
self._trigger( "close", event );
}
$.ui.dialog.overlay.resize();
@ -248,9 +233,9 @@ $.widget("ui.dialog", {
// adjust the maxZ to allow other modal dialogs to continue to work (see #4309)
if ( self.options.modal ) {
maxZ = 0;
$('.ui-dialog').each(function() {
$( ".ui-dialog" ).each(function() {
if ( this !== self.uiDialog[0] ) {
thisZ = $(this).css('z-index');
thisZ = $( this ).css( "z-index" );
if ( !isNaN( thisZ ) ) {
maxZ = Math.max( maxZ, thisZ );
}
@ -275,7 +260,7 @@ $.widget("ui.dialog", {
if ( ( options.modal && !force ) ||
( !options.stack && !options.modal ) ) {
return self._trigger('focus', event);
return self._trigger( "focus", event );
}
if ( options.zIndex > $.ui.dialog.maxZ ) {
@ -283,28 +268,35 @@ $.widget("ui.dialog", {
}
if ( self.overlay ) {
$.ui.dialog.maxZ += 1;
self.overlay.$el.css('z-index', $.ui.dialog.overlay.maxZ = $.ui.dialog.maxZ);
$.ui.dialog.overlay.maxZ = $.ui.dialog.maxZ;
self.overlay.$el.css( "z-index", $.ui.dialog.overlay.maxZ );
}
//Save and then restore scroll since Opera 9.5+ resets when parent z-Index is changed.
// http://ui.jquery.com/bugs/ticket/3193
saveScroll = { scrollTop: self.element.attr('scrollTop'), scrollLeft: self.element.attr('scrollLeft') };
// Save and then restore scroll
// Opera 9.5+ resets when parent z-index is changed.
// http://bugs.jqueryui.com/ticket/3193
saveScroll = {
scrollTop: self.element.attr( "scrollTop" ),
scrollLeft: self.element.attr( "scrollLeft" )
};
$.ui.dialog.maxZ += 1;
self.uiDialog.css('z-index', $.ui.dialog.maxZ);
self.uiDialog.css( "z-index", $.ui.dialog.maxZ );
self.element.attr( saveScroll );
self._trigger('focus', event);
self._trigger( "focus", event );
return self;
},
open: function() {
if (this._isOpen) { return; }
if ( this._isOpen ) {
return;
}
var self = this,
options = self.options,
uiDialog = self.uiDialog;
self.overlay = options.modal ? new $.ui.dialog.overlay(self) : null;
self.overlay = options.modal ? new $.ui.dialog.overlay( self ) : null;
self._size();
self._position( options.position );
uiDialog.show( options.show );
@ -312,14 +304,14 @@ $.widget("ui.dialog", {
// prevent tabbing out of modal dialogs
if ( options.modal ) {
uiDialog.bind('keypress.ui-dialog', function(event) {
uiDialog.bind( "keypress.ui-dialog", function( event ) {
if ( event.keyCode !== $.ui.keyCode.TAB ) {
return;
}
var tabbables = $(':tabbable', this),
first = tabbables.filter(':first'),
last = tabbables.filter(':last');
var tabbables = $( ":tabbable", this ),
first = tabbables.filter( ":first" ),
last = tabbables.filter( ":last" );
if ( event.target === last[0] && !event.shiftKey ) {
first.focus( 1 );
@ -333,12 +325,12 @@ $.widget("ui.dialog", {
// set focus to the first tabbable element in the content area or the first button
// if there are no tabbable elements, set focus on the dialog itself
$(self.element.find(':tabbable').get().concat(
uiDialog.find('.ui-dialog-buttonpane :tabbable').get().concat(
$( self.element.find( ":tabbable" ).get().concat(
uiDialog.find( ".ui-dialog-buttonpane :tabbable" ).get().concat(
uiDialog.get() ) ) ).eq( 0 ).focus();
self._isOpen = true;
self._trigger('open');
self._trigger( "open" );
return self;
},
@ -346,20 +338,16 @@ $.widget("ui.dialog", {
_createButtons: function( buttons ) {
var self = this,
hasButtons = false,
uiDialogButtonPane = $('<div></div>')
.addClass(
'ui-dialog-buttonpane ' +
'ui-widget-content ' +
'ui-helper-clearfix'
),
uiButtonSet = $( "<div></div>" )
uiDialogButtonPane = $( "<div>" )
.addClass( "ui-dialog-buttonpane ui-widget-content ui-helper-clearfix" ),
uiButtonSet = $( "<div>" )
.addClass( "ui-dialog-buttonset" )
.appendTo( uiDialogButtonPane );
// if we already have a button pane, remove it
self.uiDialog.find('.ui-dialog-buttonpane').remove();
self.uiDialog.find( ".ui-dialog-buttonpane" ).remove();
if (typeof buttons === 'object' && buttons !== null) {
if ( typeof buttons === "object" && buttons !== null ) {
$.each( buttons, function() {
return !(hasButtons = true);
});
@ -369,9 +357,9 @@ $.widget("ui.dialog", {
props = $.isFunction( props ) ?
{ click: props, text: name } :
props;
var button = $('<button type="button"></button>')
var button = $( "<button type='button'>" )
.attr( props, true )
.unbind('click')
.unbind( "click" )
.click(function() {
props.click.apply( self.element[0], arguments );
})
@ -398,22 +386,28 @@ $.widget("ui.dialog", {
}
self.uiDialog.draggable({
cancel: '.ui-dialog-content, .ui-dialog-titlebar-close',
handle: '.ui-dialog-titlebar',
containment: 'document',
cancel: ".ui-dialog-content, .ui-dialog-titlebar-close",
handle: ".ui-dialog-titlebar",
containment: "document",
start: function( event, ui ) {
heightBeforeDrag = options.height === "auto" ? "auto" : $( this ).height();
$(this).height($(this).height()).addClass("ui-dialog-dragging");
self._trigger('dragStart', event, filteredUi(ui));
$( this )
.height( $( this ).height() )
.addClass( "ui-dialog-dragging" );
self._trigger( "dragStart", event, filteredUi( ui ) );
},
drag: function( event, ui ) {
self._trigger('drag', event, filteredUi(ui));
self._trigger( "drag", event, filteredUi( ui ) );
},
stop: function( event, ui ) {
options.position = [ui.position.left - doc.scrollLeft(),
ui.position.top - doc.scrollTop()];
$(this).removeClass("ui-dialog-dragging").height(heightBeforeDrag);
self._trigger('dragStop', event, filteredUi(ui));
options.position = [
ui.position.left - doc.scrollLeft(),
ui.position.top - doc.scrollTop()
];
$( this )
.removeClass( "ui-dialog-dragging" )
.height( heightBeforeDrag );
self._trigger( "dragStop", event, filteredUi( ui ) );
$.ui.dialog.overlay.resize();
}
});
@ -425,11 +419,10 @@ $.widget("ui.dialog", {
options = self.options,
// .ui-resizable has position: relative defined in the stylesheet
// but dialogs have to use absolute or fixed positioning
position = self.uiDialog.css('position'),
resizeHandles = (typeof handles === 'string' ?
position = self.uiDialog.css( "position" ),
resizeHandles = typeof handles === 'string' ?
handles :
'n,e,s,w,se,sw,ne,nw'
);
"n,e,s,w,se,sw,ne,nw";
function filteredUi( ui ) {
return {
@ -441,8 +434,8 @@ $.widget("ui.dialog", {
}
self.uiDialog.resizable({
cancel: '.ui-dialog-content',
containment: 'document',
cancel: ".ui-dialog-content",
containment: "document",
alsoResize: self.element,
maxWidth: options.maxWidth,
maxHeight: options.maxHeight,
@ -451,27 +444,28 @@ $.widget("ui.dialog", {
handles: resizeHandles,
start: function( event, ui ) {
$( this ).addClass( "ui-dialog-resizing" );
self._trigger('resizeStart', event, filteredUi(ui));
self._trigger( "resizeStart", event, filteredUi( ui ) );
},
resize: function( event, ui ) {
self._trigger('resize', event, filteredUi(ui));
self._trigger( "resize", event, filteredUi( ui ) );
},
stop: function( event, ui ) {
$( this ).removeClass( "ui-dialog-resizing" );
options.height = $( this ).height();
options.width = $( this ).width();
self._trigger('resizeStop', event, filteredUi(ui));
self._trigger( "resizeStop", event, filteredUi( ui ) );
$.ui.dialog.overlay.resize();
}
})
.css('position', position)
.find('.ui-resizable-se').addClass('ui-icon ui-icon-grip-diagonal-se');
.css( "position", position )
.find( ".ui-resizable-se" )
.addClass( "ui-icon ui-icon-grip-diagonal-se" );
},
_minHeight: function() {
var options = this.options;
if (options.height === 'auto') {
if ( options.height === "auto" ) {
return options.minHeight;
} else {
return Math.min( options.minHeight, options.height );
@ -488,13 +482,13 @@ $.widget("ui.dialog", {
// if (typeof position == 'string' || $.isArray(position)) {
// myAt = $.isArray(position) ? position : position.split(' ');
if (typeof position === 'string' || (typeof position === 'object' && '0' in position)) {
myAt = position.split ? position.split(' ') : [position[0], position[1]];
if ( typeof position === "string" || (typeof position === "object" && "0" in position ) ) {
myAt = position.split ? position.split( " " ) : [ position[ 0 ], position[ 1 ] ];
if ( myAt.length === 1 ) {
myAt[ 1 ] = myAt[ 0 ];
}
$.each(['left', 'top'], function(i, offsetPosition) {
$.each( [ "left", "top" ], function( i, offsetPosition ) {
if ( +myAt[ i ] === myAt[ i ] ) {
offset[ i ] = myAt[ i ];
myAt[ i ] = offsetPosition;
@ -514,7 +508,7 @@ $.widget("ui.dialog", {
}
// need to show the dialog to get the actual offset in the position plugin
isVisible = this.uiDialog.is(':visible');
isVisible = this.uiDialog.is( ":visible" );
if ( !isVisible ) {
this.uiDialog.show();
}
@ -567,9 +561,9 @@ $.widget("ui.dialog", {
break;
case "disabled":
if ( value ) {
uiDialog.addClass('ui-dialog-disabled');
uiDialog.addClass( "ui-dialog-disabled" );
} else {
uiDialog.removeClass('ui-dialog-disabled');
uiDialog.removeClass( "ui-dialog-disabled" );
}
break;
case "draggable":
@ -589,12 +583,12 @@ $.widget("ui.dialog", {
// currently resizable, becoming non-resizable
var isResizable = uiDialog.is( ":data(resizable)" );
if ( isResizable && !value ) {
uiDialog.resizable('destroy');
uiDialog.resizable( "destroy" );
}
// currently resizable, changing handles
if (isResizable && typeof value === 'string') {
uiDialog.resizable('option', 'handles', value);
if ( isResizable && typeof value === "string" ) {
uiDialog.resizable( "option", "handles", value );
}
// currently non-resizable, becoming resizable
@ -604,7 +598,8 @@ $.widget("ui.dialog", {
break;
case "title":
// convert whatever was passed in o a string, for html() to not throw up
$(".ui-dialog-title", self.uiDialogTitlebar).html("" + (value || '&#160;'));
$( ".ui-dialog-title", self.uiDialogTitlebar )
.html( "" + ( value || "&#160;" ) );
break;
}
@ -622,7 +617,7 @@ $.widget("ui.dialog", {
// reset content sizing
this.element.show().css({
width: 'auto',
width: "auto",
minHeight: 0,
height: 0
});
@ -634,7 +629,7 @@ $.widget("ui.dialog", {
// reset wrapper sizing
// determine the height of all the non-content elements
nonContentHeight = this.uiDialog.css({
height: 'auto',
height: "auto",
width: options.width
})
.height();
@ -659,8 +654,8 @@ $.widget("ui.dialog", {
this.element.height( Math.max( options.height - nonContentHeight, 0 ) );
}
if (this.uiDialog.is(':data(resizable)')) {
this.uiDialog.resizable('option', 'minHeight', this._minHeight());
if (this.uiDialog.is( ":data(resizable)" ) ) {
this.uiDialog.resizable( "option", "minHeight", this._minHeight() );
}
}
});
@ -672,12 +667,12 @@ $.extend($.ui.dialog, {
maxZ: 0,
getTitleId: function($el) {
var id = $el.attr('id');
var id = $el.attr( "id" );
if ( !id ) {
this.uuid += 1;
id = this.uuid;
}
return 'ui-dialog-title-' + id;
return "ui-dialog-title-" + id;
},
overlay: function( dialog ) {
@ -690,8 +685,12 @@ $.extend($.ui.dialog.overlay, {
// reuse old instances due to IE memory leak with alpha transparency (see #5185)
oldInstances: [],
maxZ: 0,
events: $.map('focus,mousedown,mouseup,keydown,keypress,click'.split(','),
function(event) { return event + '.dialog-overlay'; }).join(' '),
events: $.map(
"focus,mousedown,mouseup,keydown,keypress,click".split( "," ),
function( event ) {
return event + ".dialog-overlay";
}
).join( " " ),
create: function( dialog ) {
if ( this.instances.length === 0 ) {
// prevent use of anchors and inputs
@ -711,7 +710,7 @@ $.extend($.ui.dialog.overlay, {
}, 1 );
// allow closing by pressing the escape key
$(document).bind('keydown.dialog-overlay', function(event) {
$( document ).bind( "keydown.dialog-overlay", function( event ) {
if ( dialog.options.closeOnEscape && event.keyCode &&
event.keyCode === $.ui.keyCode.ESCAPE ) {
@ -721,10 +720,10 @@ $.extend($.ui.dialog.overlay, {
});
// handle window resize
$(window).bind('resize.dialog-overlay', $.ui.dialog.overlay.resize);
$( window ).bind( "resize.dialog-overlay", $.ui.dialog.overlay.resize );
}
var $el = (this.oldInstances.pop() || $('<div></div>').addClass('ui-widget-overlay'))
var $el = ( this.oldInstances.pop() || $( "<div>" ).addClass( "ui-widget-overlay" ) )
.appendTo( document.body )
.css({
width: this.width(),
@ -741,12 +740,12 @@ $.extend($.ui.dialog.overlay, {
destroy: function( $el ) {
var indexOf = $.inArray( $el, this.instances );
if (indexOf != -1){
if ( indexOf !== -1 ) {
this.oldInstances.push( this.instances.splice( indexOf, 1 )[ 0 ] );
}
if ( this.instances.length === 0 ) {
$([document, window]).unbind('.dialog-overlay');
$( [ document, window ] ).unbind( ".dialog-overlay" );
}
$el.remove();
@ -754,7 +753,7 @@ $.extend($.ui.dialog.overlay, {
// adjust the maxZ to allow other modal dialogs to continue to work (see #4309)
var maxZ = 0;
$.each( this.instances, function() {
maxZ = Math.max(maxZ, this.css('z-index'));
maxZ = Math.max( maxZ, this.css( "z-index" ) );
});
this.maxZ = maxZ;
},
@ -774,13 +773,13 @@ $.extend($.ui.dialog.overlay, {
);
if ( scrollHeight < offsetHeight ) {
return $(window).height() + 'px';
return $( window ).height() + "px";
} else {
return scrollHeight + 'px';
return scrollHeight + "px";
}
// handle "good" browsers
} else {
return $(document).height() + 'px';
return $( document ).height() + "px";
}
},
@ -799,13 +798,13 @@ $.extend($.ui.dialog.overlay, {
);
if ( scrollWidth < offsetWidth ) {
return $(window).width() + 'px';
return $( window ).width() + "px";
} else {
return scrollWidth + 'px';
return scrollWidth + "px";
}
// handle "good" browsers
} else {
return $(document).width() + 'px';
return $( document ).width() + "px";
}
},