2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
6 /** @fileoverview The "dialogui" plugin. */
\r
8 CKEDITOR.plugins.add( 'dialogui' );
\r
12 var initPrivateObject = function( elementDefinition )
\r
14 this._ || ( this._ = {} );
\r
15 this._['default'] = this._.initValue = elementDefinition['default'] || '';
\r
16 this._.required = elementDefinition[ 'required' ] || false;
\r
17 var args = [ this._ ];
\r
18 for ( var i = 1 ; i < arguments.length ; i++ )
\r
19 args.push( arguments[i] );
\r
21 CKEDITOR.tools.extend.apply( CKEDITOR.tools, args );
\r
26 build : function( dialog, elementDefinition, output )
\r
28 return new CKEDITOR.ui.dialog.textInput( dialog, elementDefinition, output );
\r
33 build : function( dialog, elementDefinition, output )
\r
35 return new CKEDITOR.ui.dialog[elementDefinition.type]( dialog, elementDefinition, output );
\r
40 build : function( dialog, elementDefinition, output )
\r
42 var children = elementDefinition.children,
\r
46 for ( var i = 0 ; ( i < children.length && ( child = children[i] ) ) ; i++ )
\r
49 childHtmlList.push( childHtml );
\r
50 childObjList.push( CKEDITOR.dialog._.uiElementBuilders[ child.type ].build( dialog, child, childHtml ) );
\r
52 return new CKEDITOR.ui.dialog[ elementDefinition.type ]( dialog, childObjList, childHtmlList, output, elementDefinition );
\r
57 isChanged : function()
\r
59 return this.getValue() != this.getInitValue();
\r
64 this.setValue( this.getInitValue() );
\r
67 setInitValue : function()
\r
69 this._.initValue = this.getValue();
\r
72 resetInitValue : function()
\r
74 this._.initValue = this._['default'];
\r
77 getInitValue : function()
\r
79 return this._.initValue;
\r
82 commonEventProcessors = CKEDITOR.tools.extend( {}, CKEDITOR.ui.dialog.uiElement.prototype.eventProcessors,
\r
84 onChange : function( dialog, func )
\r
86 if ( !this._.domOnChangeRegistered )
\r
88 dialog.on( 'load', function()
\r
90 this.getInputElement().on( 'change', function()
\r
92 // Make sure 'onchange' doesn't get fired after dialog closed. (#5719)
\r
93 if ( !dialog.parts.dialog.isVisible() )
\r
96 this.fire( 'change', { value : this.getValue() } );
\r
99 this._.domOnChangeRegistered = true;
\r
102 this.on( 'change', func );
\r
105 eventRegex = /^on([A-Z]\w+)/,
\r
106 cleanInnerDefinition = function( def )
\r
108 // An inner UI element should not have the parent's type, title or events.
\r
109 for ( var i in def )
\r
111 if ( eventRegex.test( i ) || i == 'title' || i == 'type' )
\r
117 CKEDITOR.tools.extend( CKEDITOR.ui.dialog,
\r
118 /** @lends CKEDITOR.ui.dialog */
\r
121 * Base class for all dialog elements with a textual label on the left.
\r
124 * @extends CKEDITOR.ui.dialog.uiElement
\r
125 * @param {CKEDITOR.dialog} dialog
\r
126 * Parent dialog object.
\r
127 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
128 * The element definition. Accepted fields:
\r
130 * <li><strong>label</strong> (Required) The label string.</li>
\r
131 * <li><strong>labelLayout</strong> (Optional) Put 'horizontal' here if the
\r
132 * label element is to be layed out horizontally. Otherwise a vertical
\r
133 * layout will be used.</li>
\r
134 * <li><strong>widths</strong> (Optional) This applies only for horizontal
\r
135 * layouts - an 2-element array of lengths to specify the widths of the
\r
136 * label and the content element.</li>
\r
138 * @param {Array} htmlList
\r
139 * List of HTML code to output to.
\r
140 * @param {Function} contentHtml
\r
141 * A function returning the HTML code string to be added inside the content
\r
144 labeledElement : function( dialog, elementDefinition, htmlList, contentHtml )
\r
146 if ( arguments.length < 4 )
\r
149 var _ = initPrivateObject.call( this, elementDefinition );
\r
150 _.labelId = CKEDITOR.tools.getNextId() + '_label';
\r
151 var children = this._.children = [];
\r
153 var innerHTML = function()
\r
156 requiredClass = elementDefinition.required ? ' cke_required' : '' ;
\r
157 if ( elementDefinition.labelLayout != 'horizontal' )
\r
158 html.push( '<label class="cke_dialog_ui_labeled_label' + requiredClass + '" ',
\r
159 ' id="'+ _.labelId + '"',
\r
160 ' for="' + _.inputId + '"',
\r
161 ' style="' + elementDefinition.labelStyle + '">',
\r
162 elementDefinition.label,
\r
164 '<div class="cke_dialog_ui_labeled_content" role="presentation">',
\r
165 contentHtml.call( this, dialog, elementDefinition ),
\r
169 var hboxDefinition = {
\r
171 widths : elementDefinition.widths,
\r
177 html : '<label class="cke_dialog_ui_labeled_label' + requiredClass + '"' +
\r
178 ' id="' + _.labelId + '"' +
\r
179 ' for="' + _.inputId + '"' +
\r
180 ' style="' + elementDefinition.labelStyle + '">' +
\r
181 CKEDITOR.tools.htmlEncode( elementDefinition.label ) +
\r
186 html : '<span class="cke_dialog_ui_labeled_content">' +
\r
187 contentHtml.call( this, dialog, elementDefinition ) +
\r
192 CKEDITOR.dialog._.uiElementBuilders.hbox.build( dialog, hboxDefinition, html );
\r
194 return html.join( '' );
\r
196 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'div', null, { role : 'presentation' }, innerHTML );
\r
200 * A text input with a label. This UI element class represents both the
\r
201 * single-line text inputs and password inputs in dialog boxes.
\r
204 * @extends CKEDITOR.ui.dialog.labeledElement
\r
205 * @param {CKEDITOR.dialog} dialog
\r
206 * Parent dialog object.
\r
207 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
208 * The element definition. Accepted fields:
\r
210 * <li><strong>default</strong> (Optional) The default value.</li>
\r
211 * <li><strong>validate</strong> (Optional) The validation function. </li>
\r
212 * <li><strong>maxLength</strong> (Optional) The maximum length of text box
\r
214 * <li><strong>size</strong> (Optional) The size of the text box. This is
\r
215 * usually overridden by the size defined by the skin, however.</li>
\r
217 * @param {Array} htmlList
\r
218 * List of HTML code to output to.
\r
220 textInput : function( dialog, elementDefinition, htmlList )
\r
222 if ( arguments.length < 3 )
\r
225 initPrivateObject.call( this, elementDefinition );
\r
226 var domId = this._.inputId = CKEDITOR.tools.getNextId() + '_textInput',
\r
227 attributes = { 'class' : 'cke_dialog_ui_input_' + elementDefinition.type, id : domId, type : 'text' },
\r
230 // Set the validator, if any.
\r
231 if ( elementDefinition.validate )
\r
232 this.validate = elementDefinition.validate;
\r
234 // Set the max length and size.
\r
235 if ( elementDefinition.maxLength )
\r
236 attributes.maxlength = elementDefinition.maxLength;
\r
237 if ( elementDefinition.size )
\r
238 attributes.size = elementDefinition.size;
\r
240 if ( elementDefinition.controlStyle )
\r
241 attributes.style = elementDefinition.controlStyle;
\r
243 // If user presses Enter in a text box, it implies clicking OK for the dialog.
\r
244 var me = this, keyPressedOnMe = false;
\r
245 dialog.on( 'load', function()
\r
247 me.getInputElement().on( 'keydown', function( evt )
\r
249 if ( evt.data.getKeystroke() == 13 )
\r
250 keyPressedOnMe = true;
\r
253 // Lower the priority this 'keyup' since 'ok' will close the dialog.(#3749)
\r
254 me.getInputElement().on( 'keyup', function( evt )
\r
256 if ( evt.data.getKeystroke() == 13 && keyPressedOnMe )
\r
258 dialog.getButton( 'ok' ) && setTimeout( function ()
\r
260 dialog.getButton( 'ok' ).click();
\r
262 keyPressedOnMe = false;
\r
264 }, null, null, 1000 );
\r
268 var innerHTML = function()
\r
270 // IE BUG: Text input fields in IE at 100% would exceed a <td> or inline
\r
271 // container's width, so need to wrap it inside a <div>.
\r
272 var html = [ '<div class="cke_dialog_ui_input_', elementDefinition.type, '" role="presentation"' ];
\r
274 if ( elementDefinition.width )
\r
275 html.push( 'style="width:'+ elementDefinition.width +'" ' );
\r
277 html.push( '><input ' );
\r
279 attributes[ 'aria-labelledby' ] = this._.labelId;
\r
280 this._.required && ( attributes[ 'aria-required' ] = this._.required );
\r
281 for ( var i in attributes )
\r
282 html.push( i + '="' + attributes[i] + '" ' );
\r
283 html.push( ' /></div>' );
\r
284 return html.join( '' );
\r
286 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
290 * A text area with a label on the top or left.
\r
292 * @extends CKEDITOR.ui.dialog.labeledElement
\r
294 * @param {CKEDITOR.dialog} dialog
\r
295 * Parent dialog object.
\r
296 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
297 * The element definition. Accepted fields:
\r
299 * <li><strong>rows</strong> (Optional) The number of rows displayed.
\r
300 * Defaults to 5 if not defined.</li>
\r
301 * <li><strong>cols</strong> (Optional) The number of cols displayed.
\r
302 * Defaults to 20 if not defined. Usually overridden by skins.</li>
\r
303 * <li><strong>default</strong> (Optional) The default value.</li>
\r
304 * <li><strong>validate</strong> (Optional) The validation function. </li>
\r
306 * @param {Array} htmlList
\r
307 * List of HTML code to output to.
\r
309 textarea : function( dialog, elementDefinition, htmlList )
\r
311 if ( arguments.length < 3 )
\r
314 initPrivateObject.call( this, elementDefinition );
\r
316 domId = this._.inputId = CKEDITOR.tools.getNextId() + '_textarea',
\r
319 if ( elementDefinition.validate )
\r
320 this.validate = elementDefinition.validate;
\r
322 // Generates the essential attributes for the textarea tag.
\r
323 attributes.rows = elementDefinition.rows || 5;
\r
324 attributes.cols = elementDefinition.cols || 20;
\r
327 var innerHTML = function()
\r
329 attributes[ 'aria-labelledby' ] = this._.labelId;
\r
330 this._.required && ( attributes[ 'aria-required' ] = this._.required );
\r
331 var html = [ '<div class="cke_dialog_ui_input_textarea" role="presentation"><textarea class="cke_dialog_ui_input_textarea" id="', domId, '" ' ];
\r
332 for ( var i in attributes )
\r
333 html.push( i + '="' + CKEDITOR.tools.htmlEncode( attributes[i] ) + '" ' );
\r
334 html.push( '>', CKEDITOR.tools.htmlEncode( me._['default'] ), '</textarea></div>' );
\r
335 return html.join( '' );
\r
337 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
341 * A single checkbox with a label on the right.
\r
343 * @extends CKEDITOR.ui.dialog.uiElement
\r
345 * @param {CKEDITOR.dialog} dialog
\r
346 * Parent dialog object.
\r
347 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
348 * The element definition. Accepted fields:
\r
350 * <li><strong>checked</strong> (Optional) Whether the checkbox is checked
\r
351 * on instantiation. Defaults to false.</li>
\r
352 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
353 * <li><strong>label</strong> (Optional) The checkbox label.</li>
\r
355 * @param {Array} htmlList
\r
356 * List of HTML code to output to.
\r
358 checkbox : function( dialog, elementDefinition, htmlList )
\r
360 if ( arguments.length < 3 )
\r
363 var _ = initPrivateObject.call( this, elementDefinition, { 'default' : !!elementDefinition[ 'default' ] } );
\r
365 if ( elementDefinition.validate )
\r
366 this.validate = elementDefinition.validate;
\r
369 var innerHTML = function()
\r
371 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
373 id : elementDefinition.id ? elementDefinition.id + '_checkbox' : CKEDITOR.tools.getNextId() + '_checkbox'
\r
377 var labelId = CKEDITOR.tools.getNextId() + '_label';
\r
378 var attributes = { 'class' : 'cke_dialog_ui_checkbox_input', type : 'checkbox', 'aria-labelledby' : labelId };
\r
379 cleanInnerDefinition( myDefinition );
\r
380 if ( elementDefinition[ 'default' ] )
\r
381 attributes.checked = 'checked';
\r
383 if (typeof myDefinition.controlStyle != 'undefined')
\r
384 myDefinition.style = myDefinition.controlStyle;
\r
386 _.checkbox = new CKEDITOR.ui.dialog.uiElement( dialog, myDefinition, html, 'input', null, attributes );
\r
387 html.push( ' <label id="', labelId, '" for="', attributes.id, '">',
\r
388 CKEDITOR.tools.htmlEncode( elementDefinition.label ),
\r
390 return html.join( '' );
\r
393 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'span', null, null, innerHTML );
\r
397 * A group of radio buttons.
\r
400 * @extends CKEDITOR.ui.dialog.labeledElement
\r
401 * @param {CKEDITOR.dialog} dialog
\r
402 * Parent dialog object.
\r
403 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
404 * The element definition. Accepted fields:
\r
406 * <li><strong>default</strong> (Required) The default value.</li>
\r
407 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
408 * <li><strong>items</strong> (Required) An array of options. Each option
\r
409 * is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value'
\r
410 * is missing, then the value would be assumed to be the same as the
\r
411 * description.</li>
\r
413 * @param {Array} htmlList
\r
414 * List of HTML code to output to.
\r
416 radio : function( dialog, elementDefinition, htmlList )
\r
418 if ( arguments.length < 3)
\r
421 initPrivateObject.call( this, elementDefinition );
\r
422 if ( !this._['default'] )
\r
423 this._['default'] = this._.initValue = elementDefinition.items[0][1];
\r
424 if ( elementDefinition.validate )
\r
425 this.validate = elementDefinition.valdiate;
\r
426 var children = [], me = this;
\r
429 var innerHTML = function()
\r
431 var inputHtmlList = [], html = [],
\r
432 commonAttributes = { 'class' : 'cke_dialog_ui_radio_item', 'aria-labelledby' : this._.labelId },
\r
433 commonName = elementDefinition.id ? elementDefinition.id + '_radio' : CKEDITOR.tools.getNextId() + '_radio';
\r
434 for ( var i = 0 ; i < elementDefinition.items.length ; i++ )
\r
436 var item = elementDefinition.items[i],
\r
437 title = item[2] !== undefined ? item[2] : item[0],
\r
438 value = item[1] !== undefined ? item[1] : item[0],
\r
439 inputId = CKEDITOR.tools.getNextId() + '_radio_input',
\r
440 labelId = inputId + '_label',
\r
441 inputDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
447 labelDefinition = CKEDITOR.tools.extend( {}, inputDefinition,
\r
454 'class' : 'cke_dialog_ui_radio_input',
\r
457 'aria-labelledby' : labelId
\r
460 if ( me._['default'] == value )
\r
461 inputAttributes.checked = 'checked';
\r
462 cleanInnerDefinition( inputDefinition );
\r
463 cleanInnerDefinition( labelDefinition );
\r
465 if (typeof inputDefinition.controlStyle != 'undefined')
\r
466 inputDefinition.style = inputDefinition.controlStyle;
\r
468 children.push( new CKEDITOR.ui.dialog.uiElement( dialog, inputDefinition, inputHtml, 'input', null, inputAttributes ) );
\r
469 inputHtml.push( ' ' );
\r
470 new CKEDITOR.ui.dialog.uiElement( dialog, labelDefinition, inputHtml, 'label', null, { id : labelId, 'for' : inputAttributes.id },
\r
472 inputHtmlList.push( inputHtml.join( '' ) );
\r
474 new CKEDITOR.ui.dialog.hbox( dialog, [], inputHtmlList, html );
\r
475 return html.join( '' );
\r
478 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
479 this._.children = children;
\r
483 * A button with a label inside.
\r
486 * @extends CKEDITOR.ui.dialog.uiElement
\r
487 * @param {CKEDITOR.dialog} dialog
\r
488 * Parent dialog object.
\r
489 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
490 * The element definition. Accepted fields:
\r
492 * <li><strong>label</strong> (Required) The button label.</li>
\r
493 * <li><strong>disabled</strong> (Optional) Set to true if you want the
\r
494 * button to appear in disabled state.</li>
\r
496 * @param {Array} htmlList
\r
497 * List of HTML code to output to.
\r
499 button : function( dialog, elementDefinition, htmlList )
\r
501 if ( !arguments.length )
\r
504 if ( typeof elementDefinition == 'function' )
\r
505 elementDefinition = elementDefinition( dialog.getParentEditor() );
\r
507 initPrivateObject.call( this, elementDefinition, { disabled : elementDefinition.disabled || false } );
\r
509 // Add OnClick event to this input.
\r
510 CKEDITOR.event.implementOn( this );
\r
514 // Register an event handler for processing button clicks.
\r
515 dialog.on( 'load', function( eventInfo )
\r
517 var element = this.getElement();
\r
521 element.on( 'click', function( evt )
\r
523 me.fire( 'click', { dialog : me.getDialog() } );
\r
524 evt.data.preventDefault();
\r
527 element.on( 'keydown', function( evt )
\r
529 if ( evt.data.getKeystroke() in { 32:1 } )
\r
532 evt.data.preventDefault();
\r
537 element.unselectable();
\r
540 var outerDefinition = CKEDITOR.tools.extend( {}, elementDefinition );
\r
541 delete outerDefinition.style;
\r
543 var labelId = CKEDITOR.tools.getNextId() + '_label';
\r
544 CKEDITOR.ui.dialog.uiElement.call(
\r
552 style : elementDefinition.style,
\r
553 href : 'javascript:void(0)',
\r
554 title : elementDefinition.label,
\r
555 hidefocus : 'true',
\r
556 'class' : elementDefinition['class'],
\r
558 'aria-labelledby' : labelId
\r
560 '<span id="' + labelId + '" class="cke_dialog_ui_button">' +
\r
561 CKEDITOR.tools.htmlEncode( elementDefinition.label ) +
\r
567 * @extends CKEDITOR.ui.dialog.uiElement
\r
570 * @param {CKEDITOR.dialog} dialog
\r
571 * Parent dialog object.
\r
572 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
573 * The element definition. Accepted fields:
\r
575 * <li><strong>default</strong> (Required) The default value.</li>
\r
576 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
577 * <li><strong>items</strong> (Required) An array of options. Each option
\r
578 * is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value'
\r
579 * is missing, then the value would be assumed to be the same as the
\r
580 * description.</li>
\r
581 * <li><strong>multiple</strong> (Optional) Set this to true if you'd like
\r
582 * to have a multiple-choice select box.</li>
\r
583 * <li><strong>size</strong> (Optional) The number of items to display in
\r
584 * the select box.</li>
\r
586 * @param {Array} htmlList
\r
587 * List of HTML code to output to.
\r
589 select : function( dialog, elementDefinition, htmlList )
\r
591 if ( arguments.length < 3 )
\r
594 var _ = initPrivateObject.call( this, elementDefinition );
\r
596 if ( elementDefinition.validate )
\r
597 this.validate = elementDefinition.validate;
\r
599 _.inputId = CKEDITOR.tools.getNextId() + '_select';
\r
601 var innerHTML = function()
\r
603 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
605 id : elementDefinition.id ? elementDefinition.id + '_select' : CKEDITOR.tools.getNextId() + '_select'
\r
609 attributes = { 'id' : _.inputId, 'class' : 'cke_dialog_ui_input_select', 'aria-labelledby' : this._.labelId };
\r
611 // Add multiple and size attributes from element definition.
\r
612 if ( elementDefinition.size != undefined )
\r
613 attributes.size = elementDefinition.size;
\r
614 if ( elementDefinition.multiple != undefined )
\r
615 attributes.multiple = elementDefinition.multiple;
\r
617 cleanInnerDefinition( myDefinition );
\r
618 for ( var i = 0, item ; i < elementDefinition.items.length && ( item = elementDefinition.items[i] ) ; i++ )
\r
620 innerHTML.push( '<option value="',
\r
621 CKEDITOR.tools.htmlEncode( item[1] !== undefined ? item[1] : item[0] ), '" /> ',
\r
622 CKEDITOR.tools.htmlEncode( item[0] ) );
\r
625 if (typeof myDefinition.controlStyle != 'undefined')
\r
626 myDefinition.style = myDefinition.controlStyle;
\r
628 _.select = new CKEDITOR.ui.dialog.uiElement( dialog, myDefinition, html, 'select', null, attributes, innerHTML.join( '' ) );
\r
629 return html.join( '' );
\r
632 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
636 * A file upload input.
\r
637 * @extends CKEDITOR.ui.dialog.labeledElement
\r
640 * @param {CKEDITOR.dialog} dialog
\r
641 * Parent dialog object.
\r
642 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
643 * The element definition. Accepted fields:
\r
645 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
647 * @param {Array} htmlList
\r
648 * List of HTML code to output to.
\r
650 file : function( dialog, elementDefinition, htmlList )
\r
652 if ( arguments.length < 3 )
\r
655 if ( elementDefinition['default'] === undefined )
\r
656 elementDefinition['default'] = '';
\r
658 var _ = CKEDITOR.tools.extend( initPrivateObject.call( this, elementDefinition ), { definition : elementDefinition, buttons : [] } );
\r
660 if ( elementDefinition.validate )
\r
661 this.validate = elementDefinition.validate;
\r
664 var innerHTML = function()
\r
666 _.frameId = CKEDITOR.tools.getNextId() + '_fileInput';
\r
668 // Support for custom document.domain in IE.
\r
669 var isCustomDomain = CKEDITOR.env.isCustomDomain();
\r
673 ' frameborder="0"' +
\r
674 ' allowtransparency="0"' +
\r
675 ' class="cke_dialog_ui_input_file"' +
\r
676 ' id="', _.frameId, '"' +
\r
677 ' title="', elementDefinition.label, '"' +
\r
678 ' src="javascript:void(' ];
\r
683 'document.open();' +
\r
684 'document.domain=\'' + document.domain + '\';' +
\r
685 'document.close();' +
\r
694 return html.join( '' );
\r
697 // IE BUG: Parent container does not resize to contain the iframe automatically.
\r
698 dialog.on( 'load', function()
\r
700 var iframe = CKEDITOR.document.getById( _.frameId ),
\r
701 contentDiv = iframe.getParent();
\r
702 contentDiv.addClass( 'cke_dialog_ui_input_file' );
\r
705 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
709 * A button for submitting the file in a file upload input.
\r
710 * @extends CKEDITOR.ui.dialog.button
\r
713 * @param {CKEDITOR.dialog} dialog
\r
714 * Parent dialog object.
\r
715 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
716 * The element definition. Accepted fields:
\r
718 * <li><strong>for</strong> (Required) The file input's page and element Id
\r
719 * to associate to, in a 2-item array format: [ 'page_id', 'element_id' ].
\r
721 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
723 * @param {Array} htmlList
\r
724 * List of HTML code to output to.
\r
726 fileButton : function( dialog, elementDefinition, htmlList )
\r
728 if ( arguments.length < 3 )
\r
731 var _ = initPrivateObject.call( this, elementDefinition ),
\r
734 if ( elementDefinition.validate )
\r
735 this.validate = elementDefinition.validate;
\r
737 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition );
\r
738 var onClick = myDefinition.onClick;
\r
739 myDefinition.className = ( myDefinition.className ? myDefinition.className + ' ' : '' ) + 'cke_dialog_ui_button';
\r
740 myDefinition.onClick = function( evt )
\r
742 var target = elementDefinition[ 'for' ]; // [ pageId, elementId ]
\r
743 if ( !onClick || onClick.call( this, evt ) !== false )
\r
745 dialog.getContentElement( target[0], target[1] ).submit();
\r
750 dialog.on( 'load', function()
\r
752 dialog.getContentElement( elementDefinition[ 'for' ][0], elementDefinition[ 'for' ][1] )._.buttons.push( me );
\r
755 CKEDITOR.ui.dialog.button.call( this, dialog, myDefinition, htmlList );
\r
760 var myHtmlRe = /^\s*<[\w:]+\s+([^>]*)?>/,
\r
761 theirHtmlRe = /^(\s*<[\w:]+(?:\s+[^>]*)?)((?:.|\r|\n)+)$/,
\r
762 emptyTagRe = /\/$/;
\r
764 * A dialog element made from raw HTML code.
\r
765 * @extends CKEDITOR.ui.dialog.uiElement
\r
766 * @name CKEDITOR.ui.dialog.html
\r
767 * @param {CKEDITOR.dialog} dialog Parent dialog object.
\r
768 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition Element definition.
\r
771 * <li><strong>html</strong> (Required) HTML code of this element.</li>
\r
773 * @param {Array} htmlList List of HTML code to be added to the dialog's content area.
\r
777 return function( dialog, elementDefinition, htmlList )
\r
779 if ( arguments.length < 3 )
\r
782 var myHtmlList = [],
\r
784 theirHtml = elementDefinition.html,
\r
785 myMatch, theirMatch;
\r
787 // If the HTML input doesn't contain any tags at the beginning, add a <span> tag around it.
\r
788 if ( theirHtml.charAt( 0 ) != '<' )
\r
789 theirHtml = '<span>' + theirHtml + '</span>';
\r
791 // Look for focus function in definition.
\r
792 var focus = elementDefinition.focus;
\r
795 var oldFocus = this.focus;
\r
796 this.focus = function()
\r
798 oldFocus.call( this );
\r
799 typeof focus == 'function' && focus.call( this );
\r
800 this.fire( 'focus' );
\r
802 if ( elementDefinition.isFocusable )
\r
804 var oldIsFocusable = this.isFocusable;
\r
805 this.isFocusable = oldIsFocusable;
\r
807 this.keyboardFocusable = true;
\r
810 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, myHtmlList, 'span', null, null, '' );
\r
812 // Append the attributes created by the uiElement call to the real HTML.
\r
813 myHtml = myHtmlList.join( '' );
\r
814 myMatch = myHtml.match( myHtmlRe );
\r
815 theirMatch = theirHtml.match( theirHtmlRe ) || [ '', '', '' ];
\r
817 if ( emptyTagRe.test( theirMatch[1] ) )
\r
819 theirMatch[1] = theirMatch[1].slice( 0, -1 );
\r
820 theirMatch[2] = '/' + theirMatch[2];
\r
823 htmlList.push( [ theirMatch[1], ' ', myMatch[1] || '', theirMatch[2] ].join( '' ) );
\r
828 * Form fieldset for grouping dialog UI elements.
\r
830 * @extends CKEDITOR.ui.dialog.uiElement
\r
831 * @param {CKEDITOR.dialog} dialog Parent dialog object.
\r
832 * @param {Array} childObjList
\r
833 * Array of {@link CKEDITOR.ui.dialog.uiElement} objects inside this
\r
835 * @param {Array} childHtmlList
\r
836 * Array of HTML code that correspond to the HTML output of all the
\r
837 * objects in childObjList.
\r
838 * @param {Array} htmlList
\r
839 * Array of HTML code that this element will output to.
\r
840 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
841 * The element definition. Accepted fields:
\r
843 * <li><strong>label</strong> (Optional) The legend of the this fieldset.</li>
\r
844 * <li><strong>children</strong> (Required) An array of dialog field definitions which will be grouped inside this fieldset. </li>
\r
847 fieldset : function( dialog, childObjList, childHtmlList, htmlList, elementDefinition )
\r
849 var legendLabel = elementDefinition.label;
\r
851 var innerHTML = function()
\r
854 legendLabel && html.push( '<legend>' + legendLabel + '</legend>' );
\r
855 for ( var i = 0; i < childHtmlList.length; i++ )
\r
856 html.push( childHtmlList[ i ] );
\r
857 return html.join( '' );
\r
860 this._ = { children : childObjList };
\r
861 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'fieldset', null, null, innerHTML );
\r
866 CKEDITOR.ui.dialog.html.prototype = new CKEDITOR.ui.dialog.uiElement;
\r
868 CKEDITOR.ui.dialog.labeledElement.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
869 /** @lends CKEDITOR.ui.dialog.labeledElement.prototype */
\r
872 * Sets the label text of the element.
\r
873 * @param {String} label The new label text.
\r
874 * @returns {CKEDITOR.ui.dialog.labeledElement} The current labeled element.
\r
877 setLabel : function( label )
\r
879 var node = CKEDITOR.document.getById( this._.labelId );
\r
880 if ( node.getChildCount() < 1 )
\r
881 ( new CKEDITOR.dom.text( label, CKEDITOR.document ) ).appendTo( node );
\r
883 node.getChild( 0 ).$.nodeValue = label;
\r
888 * Retrieves the current label text of the elment.
\r
889 * @returns {String} The current label text.
\r
892 getLabel : function()
\r
894 var node = CKEDITOR.document.getById( this._.labelId );
\r
895 if ( !node || node.getChildCount() < 1 )
\r
898 return node.getChild( 0 ).getText();
\r
902 * Defines the onChange event for UI element definitions.
\r
907 eventProcessors : commonEventProcessors
\r
910 CKEDITOR.ui.dialog.button.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
911 /** @lends CKEDITOR.ui.dialog.button.prototype */
\r
914 * Simulates a click to the button.
\r
916 * @returns {Object} Return value of the 'click' event.
\r
920 if ( !this._.disabled )
\r
921 return this.fire( 'click', { dialog : this._.dialog } );
\r
922 this.getElement().$.blur();
\r
927 * Enables the button.
\r
930 enable : function()
\r
932 this._.disabled = false;
\r
933 var element = this.getElement();
\r
934 element && element.removeClass( 'disabled' );
\r
938 * Disables the button.
\r
941 disable : function()
\r
943 this._.disabled = true;
\r
944 this.getElement().addClass( 'disabled' );
\r
947 isVisible : function()
\r
949 return this.getElement().getFirst().isVisible();
\r
952 isEnabled : function()
\r
954 return !this._.disabled;
\r
958 * Defines the onChange event and onClick for button element definitions.
\r
963 eventProcessors : CKEDITOR.tools.extend( {}, CKEDITOR.ui.dialog.uiElement.prototype.eventProcessors,
\r
966 onClick : function( dialog, func )
\r
968 this.on( 'click', func );
\r
973 * Handler for the element's access key up event. Simulates a click to
\r
977 accessKeyUp : function()
\r
983 * Handler for the element's access key down event. Simulates a mouse
\r
984 * down to the button.
\r
987 accessKeyDown : function()
\r
992 keyboardFocusable : true
\r
995 CKEDITOR.ui.dialog.textInput.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
996 /** @lends CKEDITOR.ui.dialog.textInput.prototype */
\r
999 * Gets the text input DOM element under this UI object.
\r
1001 * @returns {CKEDITOR.dom.element} The DOM element of the text input.
\r
1003 getInputElement : function()
\r
1005 return CKEDITOR.document.getById( this._.inputId );
\r
1009 * Puts focus into the text input.
\r
1012 focus : function()
\r
1014 var me = this.selectParentTab();
\r
1016 // GECKO BUG: setTimeout() is needed to workaround invisible selections.
\r
1017 setTimeout( function()
\r
1019 var element = me.getInputElement();
\r
1020 element && element.$.focus();
\r
1025 * Selects all the text in the text input.
\r
1028 select : function()
\r
1030 var me = this.selectParentTab();
\r
1032 // GECKO BUG: setTimeout() is needed to workaround invisible selections.
\r
1033 setTimeout( function()
\r
1035 var e = me.getInputElement();
\r
1045 * Handler for the text input's access key up event. Makes a select()
\r
1046 * call to the text input.
\r
1049 accessKeyUp : function()
\r
1055 * Sets the value of this text input object.
\r
1056 * @param {Object} value The new value.
\r
1057 * @returns {CKEDITOR.ui.dialog.textInput} The current UI element.
\r
1059 * uiElement.setValue( 'Blamo' );
\r
1061 setValue : function( value )
\r
1063 !value && ( value = '' );
\r
1064 return CKEDITOR.ui.dialog.uiElement.prototype.setValue.call( this, value );
\r
1067 keyboardFocusable : true
\r
1068 }, commonPrototype, true );
\r
1070 CKEDITOR.ui.dialog.textarea.prototype = new CKEDITOR.ui.dialog.textInput();
\r
1072 CKEDITOR.ui.dialog.select.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
1073 /** @lends CKEDITOR.ui.dialog.select.prototype */
\r
1076 * Gets the DOM element of the select box.
\r
1077 * @returns {CKEDITOR.dom.element} The <select> element of this UI
\r
1081 getInputElement : function()
\r
1083 return this._.select.getElement();
\r
1087 * Adds an option to the select box.
\r
1088 * @param {String} label Option label.
\r
1089 * @param {String} value (Optional) Option value, if not defined it'll be
\r
1090 * assumed to be the same as the label.
\r
1091 * @param {Number} index (Optional) Position of the option to be inserted
\r
1092 * to. If not defined the new option will be inserted to the end of list.
\r
1094 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1096 add : function( label, value, index )
\r
1098 var option = new CKEDITOR.dom.element( 'option', this.getDialog().getParentEditor().document ),
\r
1099 selectElement = this.getInputElement().$;
\r
1100 option.$.text = label;
\r
1101 option.$.value = ( value === undefined || value === null ) ? label : value;
\r
1102 if ( index === undefined || index === null )
\r
1104 if ( CKEDITOR.env.ie )
\r
1105 selectElement.add( option.$ );
\r
1107 selectElement.add( option.$, null );
\r
1110 selectElement.add( option.$, index );
\r
1115 * Removes an option from the selection list.
\r
1116 * @param {Number} index Index of the option to be removed.
\r
1118 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1120 remove : function( index )
\r
1122 var selectElement = this.getInputElement().$;
\r
1123 selectElement.remove( index );
\r
1128 * Clears all options out of the selection list.
\r
1129 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1131 clear : function()
\r
1133 var selectElement = this.getInputElement().$;
\r
1134 while ( selectElement.length > 0 )
\r
1135 selectElement.remove( 0 );
\r
1139 keyboardFocusable : true
\r
1140 }, commonPrototype, true );
\r
1142 CKEDITOR.ui.dialog.checkbox.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
1143 /** @lends CKEDITOR.ui.dialog.checkbox.prototype */
\r
1146 * Gets the checkbox DOM element.
\r
1148 * @returns {CKEDITOR.dom.element} The DOM element of the checkbox.
\r
1150 getInputElement : function()
\r
1152 return this._.checkbox.getElement();
\r
1156 * Sets the state of the checkbox.
\r
1158 * @param {Boolean} true to tick the checkbox, false to untick it.
\r
1160 setValue : function( checked )
\r
1162 this.getInputElement().$.checked = checked;
\r
1163 this.fire( 'change', { value : checked } );
\r
1167 * Gets the state of the checkbox.
\r
1169 * @returns {Boolean} true means the checkbox is ticked, false means it's not ticked.
\r
1171 getValue : function()
\r
1173 return this.getInputElement().$.checked;
\r
1177 * Handler for the access key up event. Toggles the checkbox.
\r
1180 accessKeyUp : function()
\r
1182 this.setValue( !this.getValue() );
\r
1186 * Defines the onChange event for UI element definitions.
\r
1193 onChange : function( dialog, func )
\r
1195 if ( !CKEDITOR.env.ie )
\r
1196 return commonEventProcessors.onChange.apply( this, arguments );
\r
1199 dialog.on( 'load', function()
\r
1201 var element = this._.checkbox.getElement();
\r
1202 element.on( 'propertychange', function( evt )
\r
1205 if ( evt.propertyName == 'checked' )
\r
1206 this.fire( 'change', { value : element.$.checked } );
\r
1209 this.on( 'change', func );
\r
1215 keyboardFocusable : true
\r
1216 }, commonPrototype, true );
\r
1218 CKEDITOR.ui.dialog.radio.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
1219 /** @lends CKEDITOR.ui.dialog.radio.prototype */
\r
1222 * Checks one of the radio buttons in this button group.
\r
1224 * @param {String} value The value of the button to be chcked.
\r
1226 setValue : function( value )
\r
1228 var children = this._.children,
\r
1230 for ( var i = 0 ; ( i < children.length ) && ( item = children[i] ) ; i++ )
\r
1231 item.getElement().$.checked = ( item.getValue() == value );
\r
1232 this.fire( 'change', { value : value } );
\r
1236 * Gets the value of the currently checked radio button.
\r
1238 * @returns {String} The currently checked button's value.
\r
1240 getValue : function()
\r
1242 var children = this._.children;
\r
1243 for ( var i = 0 ; i < children.length ; i++ )
\r
1245 if ( children[i].getElement().$.checked )
\r
1246 return children[i].getValue();
\r
1252 * Handler for the access key up event. Focuses the currently
\r
1253 * selected radio button, or the first radio button if none is
\r
1257 accessKeyUp : function()
\r
1259 var children = this._.children, i;
\r
1260 for ( i = 0 ; i < children.length ; i++ )
\r
1262 if ( children[i].getElement().$.checked )
\r
1264 children[i].getElement().focus();
\r
1268 children[0].getElement().focus();
\r
1272 * Defines the onChange event for UI element definitions.
\r
1279 onChange : function( dialog, func )
\r
1281 if ( !CKEDITOR.env.ie )
\r
1282 return commonEventProcessors.onChange.apply( this, arguments );
\r
1285 dialog.on( 'load', function()
\r
1287 var children = this._.children, me = this;
\r
1288 for ( var i = 0 ; i < children.length ; i++ )
\r
1290 var element = children[i].getElement();
\r
1291 element.on( 'propertychange', function( evt )
\r
1294 if ( evt.propertyName == 'checked' && this.$.checked )
\r
1295 me.fire( 'change', { value : this.getAttribute( 'value' ) } );
\r
1299 this.on( 'change', func );
\r
1305 keyboardFocusable : true
\r
1306 }, commonPrototype, true );
\r
1308 CKEDITOR.ui.dialog.file.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
1310 /** @lends CKEDITOR.ui.dialog.file.prototype */
\r
1313 * Gets the <input> element of this file input.
\r
1314 * @returns {CKEDITOR.dom.element} The file input element.
\r
1317 getInputElement : function()
\r
1319 var frameDocument = CKEDITOR.document.getById( this._.frameId ).getFrameDocument();
\r
1320 return frameDocument.$.forms.length > 0 ?
\r
1321 new CKEDITOR.dom.element( frameDocument.$.forms[0].elements[0] ) :
\r
1322 this.getElement();
\r
1326 * Uploads the file in the file input.
\r
1327 * @returns {CKEDITOR.ui.dialog.file} This object.
\r
1330 submit : function()
\r
1332 this.getInputElement().getParent().$.submit();
\r
1337 * Get the action assigned to the form.
\r
1338 * @returns {String} The value of the action.
\r
1341 getAction : function()
\r
1343 return this.getInputElement().getParent().$.action;
\r
1347 * The events must be applied on the inner input element, and
\r
1348 * that must be done when the iframe & form has been loaded
\r
1350 registerEvents : function( definition )
\r
1352 var regex = /^on([A-Z]\w+)/,
\r
1355 var registerDomEvent = function( uiElement, dialog, eventName, func )
\r
1357 uiElement.on( 'formLoaded', function()
\r
1359 uiElement.getInputElement().on( eventName, func, uiElement );
\r
1363 for ( var i in definition )
\r
1365 if ( !( match = i.match( regex ) ) )
\r
1368 if ( this.eventProcessors[i] )
\r
1369 this.eventProcessors[i].call( this, this._.dialog, definition[i] );
\r
1371 registerDomEvent( this, this._.dialog, match[1].toLowerCase(), definition[i] );
\r
1378 * Redraws the file input and resets the file path in the file input.
\r
1379 * The redraw logic is necessary because non-IE browsers tend to clear
\r
1380 * the <iframe> containing the file input after closing the dialog.
\r
1383 reset : function()
\r
1385 var frameElement = CKEDITOR.document.getById( this._.frameId ),
\r
1386 frameDocument = frameElement.getFrameDocument(),
\r
1387 elementDefinition = this._.definition,
\r
1388 buttons = this._.buttons,
\r
1389 callNumber = this.formLoadedNumber,
\r
1390 unloadNumber = this.formUnloadNumber,
\r
1391 langDir = this._.dialog._.editor.lang.dir,
\r
1392 langCode = this._.dialog._.editor.langCode;
\r
1394 // The callback function for the iframe, but we must call tools.addFunction only once
\r
1395 // so we store the function number in this.formLoadedNumber
\r
1398 callNumber = this.formLoadedNumber = CKEDITOR.tools.addFunction(
\r
1401 // Now we can apply the events to the input type=file
\r
1402 this.fire( 'formLoaded' ) ;
\r
1405 // Remove listeners attached to the content of the iframe (the file input)
\r
1406 unloadNumber = this.formUnloadNumber = CKEDITOR.tools.addFunction(
\r
1409 this.getInputElement().clearCustomData();
\r
1412 this.getDialog()._.editor.on( 'destroy', function()
\r
1414 CKEDITOR.tools.removeFunction( callNumber );
\r
1415 CKEDITOR.tools.removeFunction( unloadNumber );
\r
1419 function generateFormField()
\r
1421 frameDocument.$.open();
\r
1423 // Support for custom document.domain in IE.
\r
1424 if ( CKEDITOR.env.isCustomDomain() )
\r
1425 frameDocument.$.domain = document.domain;
\r
1428 if ( elementDefinition.size )
\r
1429 size = elementDefinition.size - ( CKEDITOR.env.ie ? 7 : 0 ); // "Browse" button is bigger in IE.
\r
1431 frameDocument.$.write( [ '<html dir="' + langDir + '" lang="' + langCode + '"><head><title></title></head><body style="margin: 0; overflow: hidden; background: transparent;">',
\r
1432 '<form enctype="multipart/form-data" method="POST" dir="' + langDir + '" lang="' + langCode + '" action="',
\r
1433 CKEDITOR.tools.htmlEncode( elementDefinition.action ),
\r
1435 '<input type="file" name="',
\r
1436 CKEDITOR.tools.htmlEncode( elementDefinition.id || 'cke_upload' ),
\r
1438 CKEDITOR.tools.htmlEncode( size > 0 ? size : "" ),
\r
1442 '<script>window.parent.CKEDITOR.tools.callFunction(' + callNumber + ');',
\r
1443 'window.onbeforeunload = function() {window.parent.CKEDITOR.tools.callFunction(' + unloadNumber + ')}</script>' ].join( '' ) );
\r
1445 frameDocument.$.close();
\r
1447 for ( var i = 0 ; i < buttons.length ; i++ )
\r
1448 buttons[i].enable();
\r
1451 // #3465: Wait for the browser to finish rendering the dialog first.
\r
1452 if ( CKEDITOR.env.gecko )
\r
1453 setTimeout( generateFormField, 500 );
\r
1455 generateFormField();
\r
1458 getValue : function()
\r
1460 return this.getInputElement().$.value;
\r
1464 * The default value of input type="file" is an empty string, but during initialization
\r
1465 * of this UI element, the iframe still isn't ready so it can't be read from that object
\r
1466 * Setting it manually prevents later issues about the current value ("") being different
\r
1467 * of the initial value (undefined as it asked for .value of a div)
\r
1469 setInitValue : function()
\r
1471 this._.initValue = '';
\r
1475 * Defines the onChange event for UI element definitions.
\r
1482 onChange : function( dialog, func )
\r
1484 // If this method is called several times (I'm not sure about how this can happen but the default
\r
1485 // onChange processor includes this protection)
\r
1486 // In order to reapply to the new element, the property is deleted at the beggining of the registerEvents method
\r
1487 if ( !this._.domOnChangeRegistered )
\r
1489 // By listening for the formLoaded event, this handler will get reapplied when a new
\r
1490 // form is created
\r
1491 this.on( 'formLoaded', function()
\r
1493 this.getInputElement().on( 'change', function(){ this.fire( 'change', { value : this.getValue() } ); }, this );
\r
1495 this._.domOnChangeRegistered = true;
\r
1498 this.on( 'change', func );
\r
1502 keyboardFocusable : true
\r
1505 CKEDITOR.ui.dialog.fileButton.prototype = new CKEDITOR.ui.dialog.button;
\r
1507 CKEDITOR.ui.dialog.fieldset.prototype = CKEDITOR.tools.clone( CKEDITOR.ui.dialog.hbox.prototype );
\r
1509 CKEDITOR.dialog.addUIElement( 'text', textBuilder );
\r
1510 CKEDITOR.dialog.addUIElement( 'password', textBuilder );
\r
1511 CKEDITOR.dialog.addUIElement( 'textarea', commonBuilder );
\r
1512 CKEDITOR.dialog.addUIElement( 'checkbox', commonBuilder );
\r
1513 CKEDITOR.dialog.addUIElement( 'radio', commonBuilder );
\r
1514 CKEDITOR.dialog.addUIElement( 'button', commonBuilder );
\r
1515 CKEDITOR.dialog.addUIElement( 'select', commonBuilder );
\r
1516 CKEDITOR.dialog.addUIElement( 'file', commonBuilder );
\r
1517 CKEDITOR.dialog.addUIElement( 'fileButton', commonBuilder );
\r
1518 CKEDITOR.dialog.addUIElement( 'html', commonBuilder );
\r
1519 CKEDITOR.dialog.addUIElement( 'fieldset', containerBuilder );
\r
Got questions, comments, patches, etc.? Contact Jason Woofenden