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(){ this.fire( 'change', { value : this.getValue() } ); }, this );
\r
92 this._.domOnChangeRegistered = true;
\r
95 this.on( 'change', func );
\r
98 eventRegex = /^on([A-Z]\w+)/,
\r
99 cleanInnerDefinition = function( def )
\r
101 // An inner UI element should not have the parent's type, title or events.
\r
102 for ( var i in def )
\r
104 if ( eventRegex.test( i ) || i == 'title' || i == 'type' )
\r
110 CKEDITOR.tools.extend( CKEDITOR.ui.dialog,
\r
111 /** @lends CKEDITOR.ui.dialog */
\r
114 * Base class for all dialog elements with a textual label on the left.
\r
117 * @extends CKEDITOR.ui.dialog.uiElement
\r
118 * @param {CKEDITOR.dialog} dialog
\r
119 * Parent dialog object.
\r
120 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
121 * The element definition. Accepted fields:
\r
123 * <li><strong>label</strong> (Required) The label string.</li>
\r
124 * <li><strong>labelLayout</strong> (Optional) Put 'horizontal' here if the
\r
125 * label element is to be layed out horizontally. Otherwise a vertical
\r
126 * layout will be used.</li>
\r
127 * <li><strong>widths</strong> (Optional) This applies only for horizontal
\r
128 * layouts - an 2-element array of lengths to specify the widths of the
\r
129 * label and the content element.</li>
\r
131 * @param {Array} htmlList
\r
132 * List of HTML code to output to.
\r
133 * @param {Function} contentHtml
\r
134 * A function returning the HTML code string to be added inside the content
\r
137 labeledElement : function( dialog, elementDefinition, htmlList, contentHtml )
\r
139 if ( arguments.length < 4 )
\r
142 var _ = initPrivateObject.call( this, elementDefinition );
\r
143 _.labelId = CKEDITOR.tools.getNextNumber() + '_label';
\r
144 var children = this._.children = [];
\r
146 var innerHTML = function()
\r
149 if ( elementDefinition.labelLayout != 'horizontal' )
\r
150 html.push( '<label class="cke_dialog_ui_labeled_label" ',
\r
151 ' id="'+ _.labelId + '"',
\r
152 ' for="' + _.inputId + '"',
\r
153 ' style="' + elementDefinition.labelStyle + '">',
\r
154 elementDefinition.label,
\r
156 '<div class="cke_dialog_ui_labeled_content" role="presentation">',
\r
157 contentHtml.call( this, dialog, elementDefinition ),
\r
161 var hboxDefinition = {
\r
163 widths : elementDefinition.widths,
\r
169 html : '<label class="cke_dialog_ui_labeled_label"' +
\r
170 ' id="' + _.labelId + '"' +
\r
171 ' for="' + _.inputId + '"' +
\r
172 ' style="' + elementDefinition.labelStyle + '">' +
\r
173 CKEDITOR.tools.htmlEncode( elementDefinition.label ) +
\r
178 html : '<span class="cke_dialog_ui_labeled_content">' +
\r
179 contentHtml.call( this, dialog, elementDefinition ) +
\r
184 CKEDITOR.dialog._.uiElementBuilders.hbox.build( dialog, hboxDefinition, html );
\r
186 return html.join( '' );
\r
188 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'div', null, { role : 'presentation' }, innerHTML );
\r
192 * A text input with a label. This UI element class represents both the
\r
193 * single-line text inputs and password inputs in dialog boxes.
\r
196 * @extends CKEDITOR.ui.dialog.labeledElement
\r
197 * @param {CKEDITOR.dialog} dialog
\r
198 * Parent dialog object.
\r
199 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
200 * The element definition. Accepted fields:
\r
202 * <li><strong>default</strong> (Optional) The default value.</li>
\r
203 * <li><strong>validate</strong> (Optional) The validation function. </li>
\r
204 * <li><strong>maxLength</strong> (Optional) The maximum length of text box
\r
206 * <li><strong>size</strong> (Optional) The size of the text box. This is
\r
207 * usually overridden by the size defined by the skin, however.</li>
\r
209 * @param {Array} htmlList
\r
210 * List of HTML code to output to.
\r
212 textInput : function( dialog, elementDefinition, htmlList )
\r
214 if ( arguments.length < 3 )
\r
217 initPrivateObject.call( this, elementDefinition );
\r
218 var domId = this._.inputId = CKEDITOR.tools.getNextNumber() + '_textInput',
\r
219 attributes = { 'class' : 'cke_dialog_ui_input_' + elementDefinition.type, id : domId, type : 'text' },
\r
222 // Set the validator, if any.
\r
223 if ( elementDefinition.validate )
\r
224 this.validate = elementDefinition.validate;
\r
226 // Set the max length and size.
\r
227 if ( elementDefinition.maxLength )
\r
228 attributes.maxlength = elementDefinition.maxLength;
\r
229 if ( elementDefinition.size )
\r
230 attributes.size = elementDefinition.size;
\r
232 // If user presses Enter in a text box, it implies clicking OK for the dialog.
\r
233 var me = this, keyPressedOnMe = false;
\r
234 dialog.on( 'load', function()
\r
236 me.getInputElement().on( 'keydown', function( evt )
\r
238 if ( evt.data.getKeystroke() == 13 )
\r
239 keyPressedOnMe = true;
\r
242 // Lower the priority this 'keyup' since 'ok' will close the dialog.(#3749)
\r
243 me.getInputElement().on( 'keyup', function( evt )
\r
245 if ( evt.data.getKeystroke() == 13 && keyPressedOnMe )
\r
247 dialog.getButton( 'ok' ) && setTimeout( function ()
\r
249 dialog.getButton( 'ok' ).click();
\r
251 keyPressedOnMe = false;
\r
253 }, null, null, 1000 );
\r
257 var innerHTML = function()
\r
259 // IE BUG: Text input fields in IE at 100% would exceed a <td> or inline
\r
260 // container's width, so need to wrap it inside a <div>.
\r
261 var html = [ '<div class="cke_dialog_ui_input_', elementDefinition.type, '" role="presentation"' ];
\r
263 if ( elementDefinition.width )
\r
264 html.push( 'style="width:'+ elementDefinition.width +'" ' );
\r
266 html.push( '><input ' );
\r
268 attributes[ 'aria-labelledby' ] = this._.labelId;
\r
269 this._.required && ( attributes[ 'aria-required' ] = this._.required );
\r
270 for ( var i in attributes )
\r
271 html.push( i + '="' + attributes[i] + '" ' );
\r
272 html.push( ' /></div>' );
\r
273 return html.join( '' );
\r
275 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
279 * A text area with a label on the top or left.
\r
281 * @extends CKEDITOR.ui.dialog.labeledElement
\r
283 * @param {CKEDITOR.dialog} dialog
\r
284 * Parent dialog object.
\r
285 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
286 * The element definition. Accepted fields:
\r
288 * <li><strong>rows</strong> (Optional) The number of rows displayed.
\r
289 * Defaults to 5 if not defined.</li>
\r
290 * <li><strong>cols</strong> (Optional) The number of cols displayed.
\r
291 * Defaults to 20 if not defined. Usually overridden by skins.</li>
\r
292 * <li><strong>default</strong> (Optional) The default value.</li>
\r
293 * <li><strong>validate</strong> (Optional) The validation function. </li>
\r
295 * @param {Array} htmlList
\r
296 * List of HTML code to output to.
\r
298 textarea : function( dialog, elementDefinition, htmlList )
\r
300 if ( arguments.length < 3 )
\r
303 initPrivateObject.call( this, elementDefinition );
\r
305 domId = this._.inputId = CKEDITOR.tools.getNextNumber() + '_textarea',
\r
308 if ( elementDefinition.validate )
\r
309 this.validate = elementDefinition.validate;
\r
311 // Generates the essential attributes for the textarea tag.
\r
312 attributes.rows = elementDefinition.rows || 5;
\r
313 attributes.cols = elementDefinition.cols || 20;
\r
316 var innerHTML = function()
\r
318 attributes[ 'aria-labelledby' ] = this._.labelId;
\r
319 this._.required && ( attributes[ 'aria-required' ] = this._.required );
\r
320 var html = [ '<div class="cke_dialog_ui_input_textarea" role="presentation"><textarea class="cke_dialog_ui_input_textarea" id="', domId, '" ' ];
\r
321 for ( var i in attributes )
\r
322 html.push( i + '="' + CKEDITOR.tools.htmlEncode( attributes[i] ) + '" ' );
\r
323 html.push( '>', CKEDITOR.tools.htmlEncode( me._['default'] ), '</textarea></div>' );
\r
324 return html.join( '' );
\r
326 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
330 * A single checkbox with a label on the right.
\r
332 * @extends CKEDITOR.ui.dialog.uiElement
\r
334 * @param {CKEDITOR.dialog} dialog
\r
335 * Parent dialog object.
\r
336 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
337 * The element definition. Accepted fields:
\r
339 * <li><strong>checked</strong> (Optional) Whether the checkbox is checked
\r
340 * on instantiation. Defaults to false.</li>
\r
341 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
342 * <li><strong>label</strong> (Optional) The checkbox label.</li>
\r
344 * @param {Array} htmlList
\r
345 * List of HTML code to output to.
\r
347 checkbox : function( dialog, elementDefinition, htmlList )
\r
349 if ( arguments.length < 3 )
\r
352 var _ = initPrivateObject.call( this, elementDefinition, { 'default' : !!elementDefinition[ 'default' ] } );
\r
354 if ( elementDefinition.validate )
\r
355 this.validate = elementDefinition.validate;
\r
358 var innerHTML = function()
\r
360 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
362 id : elementDefinition.id ? elementDefinition.id + '_checkbox' : CKEDITOR.tools.getNextNumber() + '_checkbox'
\r
366 var labelId = CKEDITOR.tools.getNextNumber() + '_label';
\r
367 var attributes = { 'class' : 'cke_dialog_ui_checkbox_input', type : 'checkbox', 'aria-labelledby' : labelId };
\r
368 cleanInnerDefinition( myDefinition );
\r
369 if ( elementDefinition[ 'default' ] )
\r
370 attributes.checked = 'checked';
\r
371 _.checkbox = new CKEDITOR.ui.dialog.uiElement( dialog, myDefinition, html, 'input', null, attributes );
\r
372 html.push( ' <label id="', labelId, '" for="', attributes.id, '">',
\r
373 CKEDITOR.tools.htmlEncode( elementDefinition.label ),
\r
375 return html.join( '' );
\r
378 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'span', null, null, innerHTML );
\r
382 * A group of radio buttons.
\r
385 * @extends CKEDITOR.ui.dialog.labeledElement
\r
386 * @param {CKEDITOR.dialog} dialog
\r
387 * Parent dialog object.
\r
388 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
389 * The element definition. Accepted fields:
\r
391 * <li><strong>default</strong> (Required) The default value.</li>
\r
392 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
393 * <li><strong>items</strong> (Required) An array of options. Each option
\r
394 * is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value'
\r
395 * is missing, then the value would be assumed to be the same as the
\r
396 * description.</li>
\r
398 * @param {Array} htmlList
\r
399 * List of HTML code to output to.
\r
401 radio : function( dialog, elementDefinition, htmlList )
\r
403 if ( arguments.length < 3)
\r
406 initPrivateObject.call( this, elementDefinition );
\r
407 if ( !this._['default'] )
\r
408 this._['default'] = this._.initValue = elementDefinition.items[0][1];
\r
409 if ( elementDefinition.validate )
\r
410 this.validate = elementDefinition.valdiate;
\r
411 var children = [], me = this;
\r
414 var innerHTML = function()
\r
416 var inputHtmlList = [], html = [],
\r
417 commonAttributes = { 'class' : 'cke_dialog_ui_radio_item', 'aria-labelledby' : this._.labelId },
\r
418 commonName = elementDefinition.id ? elementDefinition.id + '_radio' : CKEDITOR.tools.getNextNumber() + '_radio';
\r
419 for ( var i = 0 ; i < elementDefinition.items.length ; i++ )
\r
421 var item = elementDefinition.items[i],
\r
422 title = item[2] !== undefined ? item[2] : item[0],
\r
423 value = item[1] !== undefined ? item[1] : item[0],
\r
424 inputId = CKEDITOR.tools.getNextNumber() + '_radio_input',
\r
425 labelId = inputId + '_label',
\r
426 inputDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
432 labelDefinition = CKEDITOR.tools.extend( {}, inputDefinition,
\r
439 'class' : 'cke_dialog_ui_radio_input',
\r
442 'aria-labelledby' : labelId
\r
445 if ( me._['default'] == value )
\r
446 inputAttributes.checked = 'checked';
\r
447 cleanInnerDefinition( inputDefinition );
\r
448 cleanInnerDefinition( labelDefinition );
\r
449 children.push( new CKEDITOR.ui.dialog.uiElement( dialog, inputDefinition, inputHtml, 'input', null, inputAttributes ) );
\r
450 inputHtml.push( ' ' );
\r
451 new CKEDITOR.ui.dialog.uiElement( dialog, labelDefinition, inputHtml, 'label', null, { id : labelId, 'for' : inputAttributes.id },
\r
453 inputHtmlList.push( inputHtml.join( '' ) );
\r
455 new CKEDITOR.ui.dialog.hbox( dialog, [], inputHtmlList, html );
\r
456 return html.join( '' );
\r
459 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
460 this._.children = children;
\r
464 * A button with a label inside.
\r
467 * @extends CKEDITOR.ui.dialog.uiElement
\r
468 * @param {CKEDITOR.dialog} dialog
\r
469 * Parent dialog object.
\r
470 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
471 * The element definition. Accepted fields:
\r
473 * <li><strong>label</strong> (Required) The button label.</li>
\r
474 * <li><strong>disabled</strong> (Optional) Set to true if you want the
\r
475 * button to appear in disabled state.</li>
\r
477 * @param {Array} htmlList
\r
478 * List of HTML code to output to.
\r
480 button : function( dialog, elementDefinition, htmlList )
\r
482 if ( !arguments.length )
\r
485 if ( typeof elementDefinition == 'function' )
\r
486 elementDefinition = elementDefinition( dialog.getParentEditor() );
\r
488 initPrivateObject.call( this, elementDefinition, { disabled : elementDefinition.disabled || false } );
\r
490 // Add OnClick event to this input.
\r
491 CKEDITOR.event.implementOn( this );
\r
495 // Register an event handler for processing button clicks.
\r
496 dialog.on( 'load', function( eventInfo )
\r
498 var element = this.getElement();
\r
502 element.on( 'click', function( evt )
\r
504 me.fire( 'click', { dialog : me.getDialog() } );
\r
505 evt.data.preventDefault();
\r
508 element.on( 'keydown', function( evt )
\r
510 if ( evt.data.getKeystroke() in { 32:1, 13:1 } )
\r
513 evt.data.preventDefault();
\r
518 element.unselectable();
\r
521 var outerDefinition = CKEDITOR.tools.extend( {}, elementDefinition );
\r
522 delete outerDefinition.style;
\r
524 var labelId = CKEDITOR.tools.getNextNumber() + '_label';
\r
525 CKEDITOR.ui.dialog.uiElement.call(
\r
533 style : elementDefinition.style,
\r
534 href : 'javascript:void(0)',
\r
535 title : elementDefinition.label,
\r
536 hidefocus : 'true',
\r
537 'class' : elementDefinition['class'],
\r
539 'aria-labelledby' : labelId
\r
541 '<span id="' + labelId + '" class="cke_dialog_ui_button">' +
\r
542 CKEDITOR.tools.htmlEncode( elementDefinition.label ) +
\r
548 * @extends CKEDITOR.ui.dialog.uiElement
\r
551 * @param {CKEDITOR.dialog} dialog
\r
552 * Parent dialog object.
\r
553 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
554 * The element definition. Accepted fields:
\r
556 * <li><strong>default</strong> (Required) The default value.</li>
\r
557 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
558 * <li><strong>items</strong> (Required) An array of options. Each option
\r
559 * is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value'
\r
560 * is missing, then the value would be assumed to be the same as the
\r
561 * description.</li>
\r
562 * <li><strong>multiple</strong> (Optional) Set this to true if you'd like
\r
563 * to have a multiple-choice select box.</li>
\r
564 * <li><strong>size</strong> (Optional) The number of items to display in
\r
565 * the select box.</li>
\r
567 * @param {Array} htmlList
\r
568 * List of HTML code to output to.
\r
570 select : function( dialog, elementDefinition, htmlList )
\r
572 if ( arguments.length < 3 )
\r
575 var _ = initPrivateObject.call( this, elementDefinition );
\r
577 if ( elementDefinition.validate )
\r
578 this.validate = elementDefinition.validate;
\r
580 _.inputId = CKEDITOR.tools.getNextNumber() + '_select';
\r
582 var innerHTML = function()
\r
584 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
586 id : elementDefinition.id ? elementDefinition.id + '_select' : CKEDITOR.tools.getNextNumber() + '_select'
\r
590 attributes = { 'id' : _.inputId, 'class' : 'cke_dialog_ui_input_select', 'aria-labelledby' : this._.labelId };
\r
592 // Add multiple and size attributes from element definition.
\r
593 if ( elementDefinition.size != undefined )
\r
594 attributes.size = elementDefinition.size;
\r
595 if ( elementDefinition.multiple != undefined )
\r
596 attributes.multiple = elementDefinition.multiple;
\r
598 cleanInnerDefinition( myDefinition );
\r
599 for ( var i = 0, item ; i < elementDefinition.items.length && ( item = elementDefinition.items[i] ) ; i++ )
\r
601 innerHTML.push( '<option value="',
\r
602 CKEDITOR.tools.htmlEncode( item[1] !== undefined ? item[1] : item[0] ), '" /> ',
\r
603 CKEDITOR.tools.htmlEncode( item[0] ) );
\r
606 _.select = new CKEDITOR.ui.dialog.uiElement( dialog, myDefinition, html, 'select', null, attributes, innerHTML.join( '' ) );
\r
607 return html.join( '' );
\r
610 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
614 * A file upload input.
\r
615 * @extends CKEDITOR.ui.dialog.labeledElement
\r
618 * @param {CKEDITOR.dialog} dialog
\r
619 * Parent dialog object.
\r
620 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
621 * The element definition. Accepted fields:
\r
623 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
625 * @param {Array} htmlList
\r
626 * List of HTML code to output to.
\r
628 file : function( dialog, elementDefinition, htmlList )
\r
630 if ( arguments.length < 3 )
\r
633 if ( elementDefinition['default'] === undefined )
\r
634 elementDefinition['default'] = '';
\r
636 var _ = CKEDITOR.tools.extend( initPrivateObject.call( this, elementDefinition ), { definition : elementDefinition, buttons : [] } );
\r
638 if ( elementDefinition.validate )
\r
639 this.validate = elementDefinition.validate;
\r
642 var innerHTML = function()
\r
644 _.frameId = CKEDITOR.tools.getNextNumber() + '_fileInput';
\r
646 // Support for custom document.domain in IE.
\r
647 var isCustomDomain = CKEDITOR.env.isCustomDomain();
\r
651 ' frameborder="0"' +
\r
652 ' allowtransparency="0"' +
\r
653 ' class="cke_dialog_ui_input_file"' +
\r
654 ' id="', _.frameId, '"' +
\r
655 ' title="', elementDefinition.label, '"' +
\r
656 ' src="javascript:void(' ];
\r
661 'document.open();' +
\r
662 'document.domain=\'' + document.domain + '\';' +
\r
663 'document.close();' +
\r
672 return html.join( '' );
\r
675 // IE BUG: Parent container does not resize to contain the iframe automatically.
\r
676 dialog.on( 'load', function()
\r
678 var iframe = CKEDITOR.document.getById( _.frameId ),
\r
679 contentDiv = iframe.getParent();
\r
680 contentDiv.addClass( 'cke_dialog_ui_input_file' );
\r
683 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
687 * A button for submitting the file in a file upload input.
\r
688 * @extends CKEDITOR.ui.dialog.button
\r
691 * @param {CKEDITOR.dialog} dialog
\r
692 * Parent dialog object.
\r
693 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
694 * The element definition. Accepted fields:
\r
696 * <li><strong>for</strong> (Required) The file input's page and element Id
\r
697 * to associate to, in a 2-item array format: [ 'page_id', 'element_id' ].
\r
699 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
701 * @param {Array} htmlList
\r
702 * List of HTML code to output to.
\r
704 fileButton : function( dialog, elementDefinition, htmlList )
\r
706 if ( arguments.length < 3 )
\r
709 var _ = initPrivateObject.call( this, elementDefinition ),
\r
712 if ( elementDefinition.validate )
\r
713 this.validate = elementDefinition.validate;
\r
715 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition );
\r
716 var onClick = myDefinition.onClick;
\r
717 myDefinition.className = ( myDefinition.className ? myDefinition.className + ' ' : '' ) + 'cke_dialog_ui_button';
\r
718 myDefinition.onClick = function( evt )
\r
720 var target = elementDefinition[ 'for' ]; // [ pageId, elementId ]
\r
721 if ( !onClick || onClick.call( this, evt ) !== false )
\r
723 dialog.getContentElement( target[0], target[1] ).submit();
\r
728 dialog.on( 'load', function()
\r
730 dialog.getContentElement( elementDefinition[ 'for' ][0], elementDefinition[ 'for' ][1] )._.buttons.push( me );
\r
733 CKEDITOR.ui.dialog.button.call( this, dialog, myDefinition, htmlList );
\r
738 var myHtmlRe = /^\s*<[\w:]+\s+([^>]*)?>/,
\r
739 theirHtmlRe = /^(\s*<[\w:]+(?:\s+[^>]*)?)((?:.|\r|\n)+)$/,
\r
740 emptyTagRe = /\/$/;
\r
742 * A dialog element made from raw HTML code.
\r
743 * @extends CKEDITOR.ui.dialog.uiElement
\r
744 * @name CKEDITOR.ui.dialog.html
\r
745 * @param {CKEDITOR.dialog} dialog Parent dialog object.
\r
746 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition Element definition.
\r
749 * <li><strong>html</strong> (Required) HTML code of this element.</li>
\r
751 * @param {Array} htmlList List of HTML code to be added to the dialog's content area.
\r
755 return function( dialog, elementDefinition, htmlList )
\r
757 if ( arguments.length < 3 )
\r
760 var myHtmlList = [],
\r
762 theirHtml = elementDefinition.html,
\r
763 myMatch, theirMatch;
\r
765 // If the HTML input doesn't contain any tags at the beginning, add a <span> tag around it.
\r
766 if ( theirHtml.charAt( 0 ) != '<' )
\r
767 theirHtml = '<span>' + theirHtml + '</span>';
\r
769 // Look for focus function in definition.
\r
770 var focus = elementDefinition.focus;
\r
773 var oldFocus = this.focus;
\r
774 this.focus = function()
\r
776 oldFocus.call( this );
\r
777 typeof focus == 'function' && focus.call( this );
\r
778 this.fire( 'focus' );
\r
780 if ( elementDefinition.isFocusable )
\r
782 var oldIsFocusable = this.isFocusable;
\r
783 this.isFocusable = oldIsFocusable;
\r
785 this.keyboardFocusable = true;
\r
788 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, myHtmlList, 'span', null, null, '' );
\r
790 // Append the attributes created by the uiElement call to the real HTML.
\r
791 myHtml = myHtmlList.join( '' );
\r
792 myMatch = myHtml.match( myHtmlRe );
\r
793 theirMatch = theirHtml.match( theirHtmlRe ) || [ '', '', '' ];
\r
795 if ( emptyTagRe.test( theirMatch[1] ) )
\r
797 theirMatch[1] = theirMatch[1].slice( 0, -1 );
\r
798 theirMatch[2] = '/' + theirMatch[2];
\r
801 htmlList.push( [ theirMatch[1], ' ', myMatch[1] || '', theirMatch[2] ].join( '' ) );
\r
806 * Form fieldset for grouping dialog UI elements.
\r
808 * @extends CKEDITOR.ui.dialog.uiElement
\r
809 * @param {CKEDITOR.dialog} dialog Parent dialog object.
\r
810 * @param {Array} childObjList
\r
811 * Array of {@link CKEDITOR.ui.dialog.uiElement} objects inside this
\r
813 * @param {Array} childHtmlList
\r
814 * Array of HTML code that correspond to the HTML output of all the
\r
815 * objects in childObjList.
\r
816 * @param {Array} htmlList
\r
817 * Array of HTML code that this element will output to.
\r
818 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
819 * The element definition. Accepted fields:
\r
821 * <li><strong>label</strong> (Optional) The legend of the this fieldset.</li>
\r
822 * <li><strong>children</strong> (Required) An array of dialog field definitions which will be grouped inside this fieldset. </li>
\r
825 fieldset : function( dialog, childObjList, childHtmlList, htmlList, elementDefinition )
\r
827 var legendLabel = elementDefinition.label;
\r
829 var innerHTML = function()
\r
832 legendLabel && html.push( '<legend>' + legendLabel + '</legend>' );
\r
833 for ( var i = 0; i < childHtmlList.length; i++ )
\r
834 html.push( childHtmlList[ i ] );
\r
835 return html.join( '' );
\r
838 this._ = { children : childObjList };
\r
839 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'fieldset', null, null, innerHTML );
\r
844 CKEDITOR.ui.dialog.html.prototype = new CKEDITOR.ui.dialog.uiElement;
\r
846 CKEDITOR.ui.dialog.labeledElement.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
847 /** @lends CKEDITOR.ui.dialog.labeledElement.prototype */
\r
850 * Sets the label text of the element.
\r
851 * @param {String} label The new label text.
\r
852 * @returns {CKEDITOR.ui.dialog.labeledElement} The current labeled element.
\r
855 setLabel : function( label )
\r
857 var node = CKEDITOR.document.getById( this._.labelId );
\r
858 if ( node.getChildCount() < 1 )
\r
859 ( new CKEDITOR.dom.text( label, CKEDITOR.document ) ).appendTo( node );
\r
861 node.getChild( 0 ).$.nodeValue = label;
\r
866 * Retrieves the current label text of the elment.
\r
867 * @returns {String} The current label text.
\r
870 getLabel : function()
\r
872 var node = CKEDITOR.document.getById( this._.labelId );
\r
873 if ( !node || node.getChildCount() < 1 )
\r
876 return node.getChild( 0 ).getText();
\r
880 * Defines the onChange event for UI element definitions.
\r
885 eventProcessors : commonEventProcessors
\r
888 CKEDITOR.ui.dialog.button.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
889 /** @lends CKEDITOR.ui.dialog.button.prototype */
\r
892 * Simulates a click to the button.
\r
894 * @returns {Object} Return value of the 'click' event.
\r
898 if ( !this._.disabled )
\r
899 return this.fire( 'click', { dialog : this._.dialog } );
\r
900 this.getElement().$.blur();
\r
905 * Enables the button.
\r
908 enable : function()
\r
910 this._.disabled = false;
\r
911 var element = this.getElement();
\r
912 element && element.removeClass( 'disabled' );
\r
916 * Disables the button.
\r
919 disable : function()
\r
921 this._.disabled = true;
\r
922 this.getElement().addClass( 'disabled' );
\r
925 isVisible : function()
\r
927 return this.getElement().getFirst().isVisible();
\r
930 isEnabled : function()
\r
932 return !this._.disabled;
\r
936 * Defines the onChange event and onClick for button element definitions.
\r
941 eventProcessors : CKEDITOR.tools.extend( {}, CKEDITOR.ui.dialog.uiElement.prototype.eventProcessors,
\r
944 onClick : function( dialog, func )
\r
946 this.on( 'click', func );
\r
951 * Handler for the element's access key up event. Simulates a click to
\r
955 accessKeyUp : function()
\r
961 * Handler for the element's access key down event. Simulates a mouse
\r
962 * down to the button.
\r
965 accessKeyDown : function()
\r
970 keyboardFocusable : true
\r
973 CKEDITOR.ui.dialog.textInput.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
974 /** @lends CKEDITOR.ui.dialog.textInput.prototype */
\r
977 * Gets the text input DOM element under this UI object.
\r
979 * @returns {CKEDITOR.dom.element} The DOM element of the text input.
\r
981 getInputElement : function()
\r
983 return CKEDITOR.document.getById( this._.inputId );
\r
987 * Puts focus into the text input.
\r
992 var me = this.selectParentTab();
\r
994 // GECKO BUG: setTimeout() is needed to workaround invisible selections.
\r
995 setTimeout( function()
\r
997 var element = me.getInputElement();
\r
998 element && element.$.focus();
\r
1003 * Selects all the text in the text input.
\r
1006 select : function()
\r
1008 var me = this.selectParentTab();
\r
1010 // GECKO BUG: setTimeout() is needed to workaround invisible selections.
\r
1011 setTimeout( function()
\r
1013 var e = me.getInputElement();
\r
1023 * Handler for the text input's access key up event. Makes a select()
\r
1024 * call to the text input.
\r
1027 accessKeyUp : function()
\r
1033 * Sets the value of this text input object.
\r
1034 * @param {Object} value The new value.
\r
1035 * @returns {CKEDITOR.ui.dialog.textInput} The current UI element.
\r
1037 * uiElement.setValue( 'Blamo' );
\r
1039 setValue : function( value )
\r
1041 !value && ( value = '' );
\r
1042 return CKEDITOR.ui.dialog.uiElement.prototype.setValue.call( this, value );
\r
1045 keyboardFocusable : true
\r
1046 }, commonPrototype, true );
\r
1048 CKEDITOR.ui.dialog.textarea.prototype = new CKEDITOR.ui.dialog.textInput();
\r
1050 CKEDITOR.ui.dialog.select.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
1051 /** @lends CKEDITOR.ui.dialog.select.prototype */
\r
1054 * Gets the DOM element of the select box.
\r
1055 * @returns {CKEDITOR.dom.element} The <select> element of this UI
\r
1059 getInputElement : function()
\r
1061 return this._.select.getElement();
\r
1065 * Adds an option to the select box.
\r
1066 * @param {String} label Option label.
\r
1067 * @param {String} value (Optional) Option value, if not defined it'll be
\r
1068 * assumed to be the same as the label.
\r
1069 * @param {Number} index (Optional) Position of the option to be inserted
\r
1070 * to. If not defined the new option will be inserted to the end of list.
\r
1072 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1074 add : function( label, value, index )
\r
1076 var option = new CKEDITOR.dom.element( 'option', this.getDialog().getParentEditor().document ),
\r
1077 selectElement = this.getInputElement().$;
\r
1078 option.$.text = label;
\r
1079 option.$.value = ( value === undefined || value === null ) ? label : value;
\r
1080 if ( index === undefined || index === null )
\r
1082 if ( CKEDITOR.env.ie )
\r
1083 selectElement.add( option.$ );
\r
1085 selectElement.add( option.$, null );
\r
1088 selectElement.add( option.$, index );
\r
1093 * Removes an option from the selection list.
\r
1094 * @param {Number} index Index of the option to be removed.
\r
1096 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1098 remove : function( index )
\r
1100 var selectElement = this.getInputElement().$;
\r
1101 selectElement.remove( index );
\r
1106 * Clears all options out of the selection list.
\r
1107 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1109 clear : function()
\r
1111 var selectElement = this.getInputElement().$;
\r
1112 while ( selectElement.length > 0 )
\r
1113 selectElement.remove( 0 );
\r
1117 keyboardFocusable : true
\r
1118 }, commonPrototype, true );
\r
1120 CKEDITOR.ui.dialog.checkbox.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
1121 /** @lends CKEDITOR.ui.dialog.checkbox.prototype */
\r
1124 * Gets the checkbox DOM element.
\r
1126 * @returns {CKEDITOR.dom.element} The DOM element of the checkbox.
\r
1128 getInputElement : function()
\r
1130 return this._.checkbox.getElement();
\r
1134 * Sets the state of the checkbox.
\r
1136 * @param {Boolean} true to tick the checkbox, false to untick it.
\r
1138 setValue : function( checked )
\r
1140 this.getInputElement().$.checked = checked;
\r
1141 this.fire( 'change', { value : checked } );
\r
1145 * Gets the state of the checkbox.
\r
1147 * @returns {Boolean} true means the checkbox is ticked, false means it's not ticked.
\r
1149 getValue : function()
\r
1151 return this.getInputElement().$.checked;
\r
1155 * Handler for the access key up event. Toggles the checkbox.
\r
1158 accessKeyUp : function()
\r
1160 this.setValue( !this.getValue() );
\r
1164 * Defines the onChange event for UI element definitions.
\r
1171 onChange : function( dialog, func )
\r
1173 if ( !CKEDITOR.env.ie )
\r
1174 return commonEventProcessors.onChange.apply( this, arguments );
\r
1177 dialog.on( 'load', function()
\r
1179 var element = this._.checkbox.getElement();
\r
1180 element.on( 'propertychange', function( evt )
\r
1183 if ( evt.propertyName == 'checked' )
\r
1184 this.fire( 'change', { value : element.$.checked } );
\r
1187 this.on( 'change', func );
\r
1193 keyboardFocusable : true
\r
1194 }, commonPrototype, true );
\r
1196 CKEDITOR.ui.dialog.radio.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
1197 /** @lends CKEDITOR.ui.dialog.radio.prototype */
\r
1200 * Checks one of the radio buttons in this button group.
\r
1202 * @param {String} value The value of the button to be chcked.
\r
1204 setValue : function( value )
\r
1206 var children = this._.children,
\r
1208 for ( var i = 0 ; ( i < children.length ) && ( item = children[i] ) ; i++ )
\r
1209 item.getElement().$.checked = ( item.getValue() == value );
\r
1210 this.fire( 'change', { value : value } );
\r
1214 * Gets the value of the currently checked radio button.
\r
1216 * @returns {String} The currently checked button's value.
\r
1218 getValue : function()
\r
1220 var children = this._.children;
\r
1221 for ( var i = 0 ; i < children.length ; i++ )
\r
1223 if ( children[i].getElement().$.checked )
\r
1224 return children[i].getValue();
\r
1230 * Handler for the access key up event. Focuses the currently
\r
1231 * selected radio button, or the first radio button if none is
\r
1235 accessKeyUp : function()
\r
1237 var children = this._.children, i;
\r
1238 for ( i = 0 ; i < children.length ; i++ )
\r
1240 if ( children[i].getElement().$.checked )
\r
1242 children[i].getElement().focus();
\r
1246 children[0].getElement().focus();
\r
1250 * Defines the onChange event for UI element definitions.
\r
1257 onChange : function( dialog, func )
\r
1259 if ( !CKEDITOR.env.ie )
\r
1260 return commonEventProcessors.onChange.apply( this, arguments );
\r
1263 dialog.on( 'load', function()
\r
1265 var children = this._.children, me = this;
\r
1266 for ( var i = 0 ; i < children.length ; i++ )
\r
1268 var element = children[i].getElement();
\r
1269 element.on( 'propertychange', function( evt )
\r
1272 if ( evt.propertyName == 'checked' && this.$.checked )
\r
1273 me.fire( 'change', { value : this.getAttribute( 'value' ) } );
\r
1277 this.on( 'change', func );
\r
1283 keyboardFocusable : true
\r
1284 }, commonPrototype, true );
\r
1286 CKEDITOR.ui.dialog.file.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
1288 /** @lends CKEDITOR.ui.dialog.file.prototype */
\r
1291 * Gets the <input> element of this file input.
\r
1292 * @returns {CKEDITOR.dom.element} The file input element.
\r
1295 getInputElement : function()
\r
1297 var frameDocument = CKEDITOR.document.getById( this._.frameId ).getFrameDocument();
\r
1298 return frameDocument.$.forms.length > 0 ?
\r
1299 new CKEDITOR.dom.element( frameDocument.$.forms[0].elements[0] ) :
\r
1300 this.getElement();
\r
1304 * Uploads the file in the file input.
\r
1305 * @returns {CKEDITOR.ui.dialog.file} This object.
\r
1308 submit : function()
\r
1310 this.getInputElement().getParent().$.submit();
\r
1315 * Get the action assigned to the form.
\r
1316 * @returns {String} The value of the action.
\r
1319 getAction : function( action )
\r
1321 return this.getInputElement().getParent().$.action;
\r
1325 * Redraws the file input and resets the file path in the file input.
\r
1326 * The redraw logic is necessary because non-IE browsers tend to clear
\r
1327 * the <iframe> containing the file input after closing the dialog.
\r
1330 reset : function()
\r
1332 var frameElement = CKEDITOR.document.getById( this._.frameId ),
\r
1333 frameDocument = frameElement.getFrameDocument(),
\r
1334 elementDefinition = this._.definition,
\r
1335 buttons = this._.buttons;
\r
1337 function generateFormField()
\r
1339 frameDocument.$.open();
\r
1341 // Support for custom document.domain in IE.
\r
1342 if ( CKEDITOR.env.isCustomDomain() )
\r
1343 frameDocument.$.domain = document.domain;
\r
1346 if ( elementDefinition.size )
\r
1347 size = elementDefinition.size - ( CKEDITOR.env.ie ? 7 : 0 ); // "Browse" button is bigger in IE.
\r
1349 frameDocument.$.write( [ '<html><head><title></title></head><body style="margin: 0; overflow: hidden; background: transparent;">',
\r
1350 '<form enctype="multipart/form-data" method="POST" action="',
\r
1351 CKEDITOR.tools.htmlEncode( elementDefinition.action ),
\r
1353 '<input type="file" name="',
\r
1354 CKEDITOR.tools.htmlEncode( elementDefinition.id || 'cke_upload' ),
\r
1356 CKEDITOR.tools.htmlEncode( size > 0 ? size : "" ),
\r
1359 '</body></html>' ].join( '' ) );
\r
1361 frameDocument.$.close();
\r
1363 for ( var i = 0 ; i < buttons.length ; i++ )
\r
1364 buttons[i].enable();
\r
1367 // #3465: Wait for the browser to finish rendering the dialog first.
\r
1368 if ( CKEDITOR.env.gecko )
\r
1369 setTimeout( generateFormField, 500 );
\r
1371 generateFormField();
\r
1374 getValue : function()
\r
1376 // The file path returned from the input tag is incomplete anyway, so it's
\r
1377 // safe to ignore it and prevent the confirmation dialog from appearing.
\r
1378 // (Part of #3465)
\r
1383 * Defines the onChange event for UI element definitions.
\r
1388 eventProcessors : commonEventProcessors,
\r
1390 keyboardFocusable : true
\r
1393 CKEDITOR.ui.dialog.fileButton.prototype = new CKEDITOR.ui.dialog.button;
\r
1395 CKEDITOR.ui.dialog.fieldset.prototype = CKEDITOR.tools.clone( CKEDITOR.ui.dialog.hbox.prototype );
\r
1397 CKEDITOR.dialog.addUIElement( 'text', textBuilder );
\r
1398 CKEDITOR.dialog.addUIElement( 'password', textBuilder );
\r
1399 CKEDITOR.dialog.addUIElement( 'textarea', commonBuilder );
\r
1400 CKEDITOR.dialog.addUIElement( 'checkbox', commonBuilder );
\r
1401 CKEDITOR.dialog.addUIElement( 'radio', commonBuilder );
\r
1402 CKEDITOR.dialog.addUIElement( 'button', commonBuilder );
\r
1403 CKEDITOR.dialog.addUIElement( 'select', commonBuilder );
\r
1404 CKEDITOR.dialog.addUIElement( 'file', commonBuilder );
\r
1405 CKEDITOR.dialog.addUIElement( 'fileButton', commonBuilder );
\r
1406 CKEDITOR.dialog.addUIElement( 'html', commonBuilder );
\r
1407 CKEDITOR.dialog.addUIElement( 'fieldset', containerBuilder );
\r