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.getNextNumber() + '_label';
\r
151 var children = this._.children = [];
\r
153 var innerHTML = function()
\r
156 if ( elementDefinition.labelLayout != 'horizontal' )
\r
157 html.push( '<label class="cke_dialog_ui_labeled_label" ',
\r
158 ' id="'+ _.labelId + '"',
\r
159 ' for="' + _.inputId + '"',
\r
160 ' style="' + elementDefinition.labelStyle + '">',
\r
161 elementDefinition.label,
\r
163 '<div class="cke_dialog_ui_labeled_content" role="presentation">',
\r
164 contentHtml.call( this, dialog, elementDefinition ),
\r
168 var hboxDefinition = {
\r
170 widths : elementDefinition.widths,
\r
176 html : '<label class="cke_dialog_ui_labeled_label"' +
\r
177 ' id="' + _.labelId + '"' +
\r
178 ' for="' + _.inputId + '"' +
\r
179 ' style="' + elementDefinition.labelStyle + '">' +
\r
180 CKEDITOR.tools.htmlEncode( elementDefinition.label ) +
\r
185 html : '<span class="cke_dialog_ui_labeled_content">' +
\r
186 contentHtml.call( this, dialog, elementDefinition ) +
\r
191 CKEDITOR.dialog._.uiElementBuilders.hbox.build( dialog, hboxDefinition, html );
\r
193 return html.join( '' );
\r
195 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'div', null, { role : 'presentation' }, innerHTML );
\r
199 * A text input with a label. This UI element class represents both the
\r
200 * single-line text inputs and password inputs in dialog boxes.
\r
203 * @extends CKEDITOR.ui.dialog.labeledElement
\r
204 * @param {CKEDITOR.dialog} dialog
\r
205 * Parent dialog object.
\r
206 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
207 * The element definition. Accepted fields:
\r
209 * <li><strong>default</strong> (Optional) The default value.</li>
\r
210 * <li><strong>validate</strong> (Optional) The validation function. </li>
\r
211 * <li><strong>maxLength</strong> (Optional) The maximum length of text box
\r
213 * <li><strong>size</strong> (Optional) The size of the text box. This is
\r
214 * usually overridden by the size defined by the skin, however.</li>
\r
216 * @param {Array} htmlList
\r
217 * List of HTML code to output to.
\r
219 textInput : function( dialog, elementDefinition, htmlList )
\r
221 if ( arguments.length < 3 )
\r
224 initPrivateObject.call( this, elementDefinition );
\r
225 var domId = this._.inputId = CKEDITOR.tools.getNextNumber() + '_textInput',
\r
226 attributes = { 'class' : 'cke_dialog_ui_input_' + elementDefinition.type, id : domId, type : 'text' },
\r
229 // Set the validator, if any.
\r
230 if ( elementDefinition.validate )
\r
231 this.validate = elementDefinition.validate;
\r
233 // Set the max length and size.
\r
234 if ( elementDefinition.maxLength )
\r
235 attributes.maxlength = elementDefinition.maxLength;
\r
236 if ( elementDefinition.size )
\r
237 attributes.size = elementDefinition.size;
\r
239 // If user presses Enter in a text box, it implies clicking OK for the dialog.
\r
240 var me = this, keyPressedOnMe = false;
\r
241 dialog.on( 'load', function()
\r
243 me.getInputElement().on( 'keydown', function( evt )
\r
245 if ( evt.data.getKeystroke() == 13 )
\r
246 keyPressedOnMe = true;
\r
249 // Lower the priority this 'keyup' since 'ok' will close the dialog.(#3749)
\r
250 me.getInputElement().on( 'keyup', function( evt )
\r
252 if ( evt.data.getKeystroke() == 13 && keyPressedOnMe )
\r
254 dialog.getButton( 'ok' ) && setTimeout( function ()
\r
256 dialog.getButton( 'ok' ).click();
\r
258 keyPressedOnMe = false;
\r
260 }, null, null, 1000 );
\r
264 var innerHTML = function()
\r
266 // IE BUG: Text input fields in IE at 100% would exceed a <td> or inline
\r
267 // container's width, so need to wrap it inside a <div>.
\r
268 var html = [ '<div class="cke_dialog_ui_input_', elementDefinition.type, '" role="presentation"' ];
\r
270 if ( elementDefinition.width )
\r
271 html.push( 'style="width:'+ elementDefinition.width +'" ' );
\r
273 html.push( '><input ' );
\r
275 attributes[ 'aria-labelledby' ] = this._.labelId;
\r
276 this._.required && ( attributes[ 'aria-required' ] = this._.required );
\r
277 for ( var i in attributes )
\r
278 html.push( i + '="' + attributes[i] + '" ' );
\r
279 html.push( ' /></div>' );
\r
280 return html.join( '' );
\r
282 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
286 * A text area with a label on the top or left.
\r
288 * @extends CKEDITOR.ui.dialog.labeledElement
\r
290 * @param {CKEDITOR.dialog} dialog
\r
291 * Parent dialog object.
\r
292 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
293 * The element definition. Accepted fields:
\r
295 * <li><strong>rows</strong> (Optional) The number of rows displayed.
\r
296 * Defaults to 5 if not defined.</li>
\r
297 * <li><strong>cols</strong> (Optional) The number of cols displayed.
\r
298 * Defaults to 20 if not defined. Usually overridden by skins.</li>
\r
299 * <li><strong>default</strong> (Optional) The default value.</li>
\r
300 * <li><strong>validate</strong> (Optional) The validation function. </li>
\r
302 * @param {Array} htmlList
\r
303 * List of HTML code to output to.
\r
305 textarea : function( dialog, elementDefinition, htmlList )
\r
307 if ( arguments.length < 3 )
\r
310 initPrivateObject.call( this, elementDefinition );
\r
312 domId = this._.inputId = CKEDITOR.tools.getNextNumber() + '_textarea',
\r
315 if ( elementDefinition.validate )
\r
316 this.validate = elementDefinition.validate;
\r
318 // Generates the essential attributes for the textarea tag.
\r
319 attributes.rows = elementDefinition.rows || 5;
\r
320 attributes.cols = elementDefinition.cols || 20;
\r
323 var innerHTML = function()
\r
325 attributes[ 'aria-labelledby' ] = this._.labelId;
\r
326 this._.required && ( attributes[ 'aria-required' ] = this._.required );
\r
327 var html = [ '<div class="cke_dialog_ui_input_textarea" role="presentation"><textarea class="cke_dialog_ui_input_textarea" id="', domId, '" ' ];
\r
328 for ( var i in attributes )
\r
329 html.push( i + '="' + CKEDITOR.tools.htmlEncode( attributes[i] ) + '" ' );
\r
330 html.push( '>', CKEDITOR.tools.htmlEncode( me._['default'] ), '</textarea></div>' );
\r
331 return html.join( '' );
\r
333 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
337 * A single checkbox with a label on the right.
\r
339 * @extends CKEDITOR.ui.dialog.uiElement
\r
341 * @param {CKEDITOR.dialog} dialog
\r
342 * Parent dialog object.
\r
343 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
344 * The element definition. Accepted fields:
\r
346 * <li><strong>checked</strong> (Optional) Whether the checkbox is checked
\r
347 * on instantiation. Defaults to false.</li>
\r
348 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
349 * <li><strong>label</strong> (Optional) The checkbox label.</li>
\r
351 * @param {Array} htmlList
\r
352 * List of HTML code to output to.
\r
354 checkbox : function( dialog, elementDefinition, htmlList )
\r
356 if ( arguments.length < 3 )
\r
359 var _ = initPrivateObject.call( this, elementDefinition, { 'default' : !!elementDefinition[ 'default' ] } );
\r
361 if ( elementDefinition.validate )
\r
362 this.validate = elementDefinition.validate;
\r
365 var innerHTML = function()
\r
367 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
369 id : elementDefinition.id ? elementDefinition.id + '_checkbox' : CKEDITOR.tools.getNextNumber() + '_checkbox'
\r
373 var labelId = CKEDITOR.tools.getNextNumber() + '_label';
\r
374 var attributes = { 'class' : 'cke_dialog_ui_checkbox_input', type : 'checkbox', 'aria-labelledby' : labelId };
\r
375 cleanInnerDefinition( myDefinition );
\r
376 if ( elementDefinition[ 'default' ] )
\r
377 attributes.checked = 'checked';
\r
378 _.checkbox = new CKEDITOR.ui.dialog.uiElement( dialog, myDefinition, html, 'input', null, attributes );
\r
379 html.push( ' <label id="', labelId, '" for="', attributes.id, '">',
\r
380 CKEDITOR.tools.htmlEncode( elementDefinition.label ),
\r
382 return html.join( '' );
\r
385 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'span', null, null, innerHTML );
\r
389 * A group of radio buttons.
\r
392 * @extends CKEDITOR.ui.dialog.labeledElement
\r
393 * @param {CKEDITOR.dialog} dialog
\r
394 * Parent dialog object.
\r
395 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
396 * The element definition. Accepted fields:
\r
398 * <li><strong>default</strong> (Required) The default value.</li>
\r
399 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
400 * <li><strong>items</strong> (Required) An array of options. Each option
\r
401 * is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value'
\r
402 * is missing, then the value would be assumed to be the same as the
\r
403 * description.</li>
\r
405 * @param {Array} htmlList
\r
406 * List of HTML code to output to.
\r
408 radio : function( dialog, elementDefinition, htmlList )
\r
410 if ( arguments.length < 3)
\r
413 initPrivateObject.call( this, elementDefinition );
\r
414 if ( !this._['default'] )
\r
415 this._['default'] = this._.initValue = elementDefinition.items[0][1];
\r
416 if ( elementDefinition.validate )
\r
417 this.validate = elementDefinition.valdiate;
\r
418 var children = [], me = this;
\r
421 var innerHTML = function()
\r
423 var inputHtmlList = [], html = [],
\r
424 commonAttributes = { 'class' : 'cke_dialog_ui_radio_item', 'aria-labelledby' : this._.labelId },
\r
425 commonName = elementDefinition.id ? elementDefinition.id + '_radio' : CKEDITOR.tools.getNextNumber() + '_radio';
\r
426 for ( var i = 0 ; i < elementDefinition.items.length ; i++ )
\r
428 var item = elementDefinition.items[i],
\r
429 title = item[2] !== undefined ? item[2] : item[0],
\r
430 value = item[1] !== undefined ? item[1] : item[0],
\r
431 inputId = CKEDITOR.tools.getNextNumber() + '_radio_input',
\r
432 labelId = inputId + '_label',
\r
433 inputDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
439 labelDefinition = CKEDITOR.tools.extend( {}, inputDefinition,
\r
446 'class' : 'cke_dialog_ui_radio_input',
\r
449 'aria-labelledby' : labelId
\r
452 if ( me._['default'] == value )
\r
453 inputAttributes.checked = 'checked';
\r
454 cleanInnerDefinition( inputDefinition );
\r
455 cleanInnerDefinition( labelDefinition );
\r
456 children.push( new CKEDITOR.ui.dialog.uiElement( dialog, inputDefinition, inputHtml, 'input', null, inputAttributes ) );
\r
457 inputHtml.push( ' ' );
\r
458 new CKEDITOR.ui.dialog.uiElement( dialog, labelDefinition, inputHtml, 'label', null, { id : labelId, 'for' : inputAttributes.id },
\r
460 inputHtmlList.push( inputHtml.join( '' ) );
\r
462 new CKEDITOR.ui.dialog.hbox( dialog, [], inputHtmlList, html );
\r
463 return html.join( '' );
\r
466 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
467 this._.children = children;
\r
471 * A button with a label inside.
\r
474 * @extends CKEDITOR.ui.dialog.uiElement
\r
475 * @param {CKEDITOR.dialog} dialog
\r
476 * Parent dialog object.
\r
477 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
478 * The element definition. Accepted fields:
\r
480 * <li><strong>label</strong> (Required) The button label.</li>
\r
481 * <li><strong>disabled</strong> (Optional) Set to true if you want the
\r
482 * button to appear in disabled state.</li>
\r
484 * @param {Array} htmlList
\r
485 * List of HTML code to output to.
\r
487 button : function( dialog, elementDefinition, htmlList )
\r
489 if ( !arguments.length )
\r
492 if ( typeof elementDefinition == 'function' )
\r
493 elementDefinition = elementDefinition( dialog.getParentEditor() );
\r
495 initPrivateObject.call( this, elementDefinition, { disabled : elementDefinition.disabled || false } );
\r
497 // Add OnClick event to this input.
\r
498 CKEDITOR.event.implementOn( this );
\r
502 // Register an event handler for processing button clicks.
\r
503 dialog.on( 'load', function( eventInfo )
\r
505 var element = this.getElement();
\r
509 element.on( 'click', function( evt )
\r
511 me.fire( 'click', { dialog : me.getDialog() } );
\r
512 evt.data.preventDefault();
\r
515 element.on( 'keydown', function( evt )
\r
517 if ( evt.data.getKeystroke() in { 32:1 } )
\r
520 evt.data.preventDefault();
\r
525 element.unselectable();
\r
528 var outerDefinition = CKEDITOR.tools.extend( {}, elementDefinition );
\r
529 delete outerDefinition.style;
\r
531 var labelId = CKEDITOR.tools.getNextNumber() + '_label';
\r
532 CKEDITOR.ui.dialog.uiElement.call(
\r
540 style : elementDefinition.style,
\r
541 href : 'javascript:void(0)',
\r
542 title : elementDefinition.label,
\r
543 hidefocus : 'true',
\r
544 'class' : elementDefinition['class'],
\r
546 'aria-labelledby' : labelId
\r
548 '<span id="' + labelId + '" class="cke_dialog_ui_button">' +
\r
549 CKEDITOR.tools.htmlEncode( elementDefinition.label ) +
\r
555 * @extends CKEDITOR.ui.dialog.uiElement
\r
558 * @param {CKEDITOR.dialog} dialog
\r
559 * Parent dialog object.
\r
560 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
561 * The element definition. Accepted fields:
\r
563 * <li><strong>default</strong> (Required) The default value.</li>
\r
564 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
565 * <li><strong>items</strong> (Required) An array of options. Each option
\r
566 * is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value'
\r
567 * is missing, then the value would be assumed to be the same as the
\r
568 * description.</li>
\r
569 * <li><strong>multiple</strong> (Optional) Set this to true if you'd like
\r
570 * to have a multiple-choice select box.</li>
\r
571 * <li><strong>size</strong> (Optional) The number of items to display in
\r
572 * the select box.</li>
\r
574 * @param {Array} htmlList
\r
575 * List of HTML code to output to.
\r
577 select : function( dialog, elementDefinition, htmlList )
\r
579 if ( arguments.length < 3 )
\r
582 var _ = initPrivateObject.call( this, elementDefinition );
\r
584 if ( elementDefinition.validate )
\r
585 this.validate = elementDefinition.validate;
\r
587 _.inputId = CKEDITOR.tools.getNextNumber() + '_select';
\r
589 var innerHTML = function()
\r
591 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition,
\r
593 id : elementDefinition.id ? elementDefinition.id + '_select' : CKEDITOR.tools.getNextNumber() + '_select'
\r
597 attributes = { 'id' : _.inputId, 'class' : 'cke_dialog_ui_input_select', 'aria-labelledby' : this._.labelId };
\r
599 // Add multiple and size attributes from element definition.
\r
600 if ( elementDefinition.size != undefined )
\r
601 attributes.size = elementDefinition.size;
\r
602 if ( elementDefinition.multiple != undefined )
\r
603 attributes.multiple = elementDefinition.multiple;
\r
605 cleanInnerDefinition( myDefinition );
\r
606 for ( var i = 0, item ; i < elementDefinition.items.length && ( item = elementDefinition.items[i] ) ; i++ )
\r
608 innerHTML.push( '<option value="',
\r
609 CKEDITOR.tools.htmlEncode( item[1] !== undefined ? item[1] : item[0] ), '" /> ',
\r
610 CKEDITOR.tools.htmlEncode( item[0] ) );
\r
613 _.select = new CKEDITOR.ui.dialog.uiElement( dialog, myDefinition, html, 'select', null, attributes, innerHTML.join( '' ) );
\r
614 return html.join( '' );
\r
617 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
621 * A file upload input.
\r
622 * @extends CKEDITOR.ui.dialog.labeledElement
\r
625 * @param {CKEDITOR.dialog} dialog
\r
626 * Parent dialog object.
\r
627 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
628 * The element definition. Accepted fields:
\r
630 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
632 * @param {Array} htmlList
\r
633 * List of HTML code to output to.
\r
635 file : function( dialog, elementDefinition, htmlList )
\r
637 if ( arguments.length < 3 )
\r
640 if ( elementDefinition['default'] === undefined )
\r
641 elementDefinition['default'] = '';
\r
643 var _ = CKEDITOR.tools.extend( initPrivateObject.call( this, elementDefinition ), { definition : elementDefinition, buttons : [] } );
\r
645 if ( elementDefinition.validate )
\r
646 this.validate = elementDefinition.validate;
\r
649 var innerHTML = function()
\r
651 _.frameId = CKEDITOR.tools.getNextNumber() + '_fileInput';
\r
653 // Support for custom document.domain in IE.
\r
654 var isCustomDomain = CKEDITOR.env.isCustomDomain();
\r
658 ' frameborder="0"' +
\r
659 ' allowtransparency="0"' +
\r
660 ' class="cke_dialog_ui_input_file"' +
\r
661 ' id="', _.frameId, '"' +
\r
662 ' title="', elementDefinition.label, '"' +
\r
663 ' src="javascript:void(' ];
\r
668 'document.open();' +
\r
669 'document.domain=\'' + document.domain + '\';' +
\r
670 'document.close();' +
\r
679 return html.join( '' );
\r
682 // IE BUG: Parent container does not resize to contain the iframe automatically.
\r
683 dialog.on( 'load', function()
\r
685 var iframe = CKEDITOR.document.getById( _.frameId ),
\r
686 contentDiv = iframe.getParent();
\r
687 contentDiv.addClass( 'cke_dialog_ui_input_file' );
\r
690 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
\r
694 * A button for submitting the file in a file upload input.
\r
695 * @extends CKEDITOR.ui.dialog.button
\r
698 * @param {CKEDITOR.dialog} dialog
\r
699 * Parent dialog object.
\r
700 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
701 * The element definition. Accepted fields:
\r
703 * <li><strong>for</strong> (Required) The file input's page and element Id
\r
704 * to associate to, in a 2-item array format: [ 'page_id', 'element_id' ].
\r
706 * <li><strong>validate</strong> (Optional) The validation function.</li>
\r
708 * @param {Array} htmlList
\r
709 * List of HTML code to output to.
\r
711 fileButton : function( dialog, elementDefinition, htmlList )
\r
713 if ( arguments.length < 3 )
\r
716 var _ = initPrivateObject.call( this, elementDefinition ),
\r
719 if ( elementDefinition.validate )
\r
720 this.validate = elementDefinition.validate;
\r
722 var myDefinition = CKEDITOR.tools.extend( {}, elementDefinition );
\r
723 var onClick = myDefinition.onClick;
\r
724 myDefinition.className = ( myDefinition.className ? myDefinition.className + ' ' : '' ) + 'cke_dialog_ui_button';
\r
725 myDefinition.onClick = function( evt )
\r
727 var target = elementDefinition[ 'for' ]; // [ pageId, elementId ]
\r
728 if ( !onClick || onClick.call( this, evt ) !== false )
\r
730 dialog.getContentElement( target[0], target[1] ).submit();
\r
735 dialog.on( 'load', function()
\r
737 dialog.getContentElement( elementDefinition[ 'for' ][0], elementDefinition[ 'for' ][1] )._.buttons.push( me );
\r
740 CKEDITOR.ui.dialog.button.call( this, dialog, myDefinition, htmlList );
\r
745 var myHtmlRe = /^\s*<[\w:]+\s+([^>]*)?>/,
\r
746 theirHtmlRe = /^(\s*<[\w:]+(?:\s+[^>]*)?)((?:.|\r|\n)+)$/,
\r
747 emptyTagRe = /\/$/;
\r
749 * A dialog element made from raw HTML code.
\r
750 * @extends CKEDITOR.ui.dialog.uiElement
\r
751 * @name CKEDITOR.ui.dialog.html
\r
752 * @param {CKEDITOR.dialog} dialog Parent dialog object.
\r
753 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition Element definition.
\r
756 * <li><strong>html</strong> (Required) HTML code of this element.</li>
\r
758 * @param {Array} htmlList List of HTML code to be added to the dialog's content area.
\r
762 return function( dialog, elementDefinition, htmlList )
\r
764 if ( arguments.length < 3 )
\r
767 var myHtmlList = [],
\r
769 theirHtml = elementDefinition.html,
\r
770 myMatch, theirMatch;
\r
772 // If the HTML input doesn't contain any tags at the beginning, add a <span> tag around it.
\r
773 if ( theirHtml.charAt( 0 ) != '<' )
\r
774 theirHtml = '<span>' + theirHtml + '</span>';
\r
776 // Look for focus function in definition.
\r
777 var focus = elementDefinition.focus;
\r
780 var oldFocus = this.focus;
\r
781 this.focus = function()
\r
783 oldFocus.call( this );
\r
784 typeof focus == 'function' && focus.call( this );
\r
785 this.fire( 'focus' );
\r
787 if ( elementDefinition.isFocusable )
\r
789 var oldIsFocusable = this.isFocusable;
\r
790 this.isFocusable = oldIsFocusable;
\r
792 this.keyboardFocusable = true;
\r
795 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, myHtmlList, 'span', null, null, '' );
\r
797 // Append the attributes created by the uiElement call to the real HTML.
\r
798 myHtml = myHtmlList.join( '' );
\r
799 myMatch = myHtml.match( myHtmlRe );
\r
800 theirMatch = theirHtml.match( theirHtmlRe ) || [ '', '', '' ];
\r
802 if ( emptyTagRe.test( theirMatch[1] ) )
\r
804 theirMatch[1] = theirMatch[1].slice( 0, -1 );
\r
805 theirMatch[2] = '/' + theirMatch[2];
\r
808 htmlList.push( [ theirMatch[1], ' ', myMatch[1] || '', theirMatch[2] ].join( '' ) );
\r
813 * Form fieldset for grouping dialog UI elements.
\r
815 * @extends CKEDITOR.ui.dialog.uiElement
\r
816 * @param {CKEDITOR.dialog} dialog Parent dialog object.
\r
817 * @param {Array} childObjList
\r
818 * Array of {@link CKEDITOR.ui.dialog.uiElement} objects inside this
\r
820 * @param {Array} childHtmlList
\r
821 * Array of HTML code that correspond to the HTML output of all the
\r
822 * objects in childObjList.
\r
823 * @param {Array} htmlList
\r
824 * Array of HTML code that this element will output to.
\r
825 * @param {CKEDITOR.dialog.uiElementDefinition} elementDefinition
\r
826 * The element definition. Accepted fields:
\r
828 * <li><strong>label</strong> (Optional) The legend of the this fieldset.</li>
\r
829 * <li><strong>children</strong> (Required) An array of dialog field definitions which will be grouped inside this fieldset. </li>
\r
832 fieldset : function( dialog, childObjList, childHtmlList, htmlList, elementDefinition )
\r
834 var legendLabel = elementDefinition.label;
\r
836 var innerHTML = function()
\r
839 legendLabel && html.push( '<legend>' + legendLabel + '</legend>' );
\r
840 for ( var i = 0; i < childHtmlList.length; i++ )
\r
841 html.push( childHtmlList[ i ] );
\r
842 return html.join( '' );
\r
845 this._ = { children : childObjList };
\r
846 CKEDITOR.ui.dialog.uiElement.call( this, dialog, elementDefinition, htmlList, 'fieldset', null, null, innerHTML );
\r
851 CKEDITOR.ui.dialog.html.prototype = new CKEDITOR.ui.dialog.uiElement;
\r
853 CKEDITOR.ui.dialog.labeledElement.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
854 /** @lends CKEDITOR.ui.dialog.labeledElement.prototype */
\r
857 * Sets the label text of the element.
\r
858 * @param {String} label The new label text.
\r
859 * @returns {CKEDITOR.ui.dialog.labeledElement} The current labeled element.
\r
862 setLabel : function( label )
\r
864 var node = CKEDITOR.document.getById( this._.labelId );
\r
865 if ( node.getChildCount() < 1 )
\r
866 ( new CKEDITOR.dom.text( label, CKEDITOR.document ) ).appendTo( node );
\r
868 node.getChild( 0 ).$.nodeValue = label;
\r
873 * Retrieves the current label text of the elment.
\r
874 * @returns {String} The current label text.
\r
877 getLabel : function()
\r
879 var node = CKEDITOR.document.getById( this._.labelId );
\r
880 if ( !node || node.getChildCount() < 1 )
\r
883 return node.getChild( 0 ).getText();
\r
887 * Defines the onChange event for UI element definitions.
\r
892 eventProcessors : commonEventProcessors
\r
895 CKEDITOR.ui.dialog.button.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
896 /** @lends CKEDITOR.ui.dialog.button.prototype */
\r
899 * Simulates a click to the button.
\r
901 * @returns {Object} Return value of the 'click' event.
\r
905 if ( !this._.disabled )
\r
906 return this.fire( 'click', { dialog : this._.dialog } );
\r
907 this.getElement().$.blur();
\r
912 * Enables the button.
\r
915 enable : function()
\r
917 this._.disabled = false;
\r
918 var element = this.getElement();
\r
919 element && element.removeClass( 'disabled' );
\r
923 * Disables the button.
\r
926 disable : function()
\r
928 this._.disabled = true;
\r
929 this.getElement().addClass( 'disabled' );
\r
932 isVisible : function()
\r
934 return this.getElement().getFirst().isVisible();
\r
937 isEnabled : function()
\r
939 return !this._.disabled;
\r
943 * Defines the onChange event and onClick for button element definitions.
\r
948 eventProcessors : CKEDITOR.tools.extend( {}, CKEDITOR.ui.dialog.uiElement.prototype.eventProcessors,
\r
951 onClick : function( dialog, func )
\r
953 this.on( 'click', func );
\r
958 * Handler for the element's access key up event. Simulates a click to
\r
962 accessKeyUp : function()
\r
968 * Handler for the element's access key down event. Simulates a mouse
\r
969 * down to the button.
\r
972 accessKeyDown : function()
\r
977 keyboardFocusable : true
\r
980 CKEDITOR.ui.dialog.textInput.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
981 /** @lends CKEDITOR.ui.dialog.textInput.prototype */
\r
984 * Gets the text input DOM element under this UI object.
\r
986 * @returns {CKEDITOR.dom.element} The DOM element of the text input.
\r
988 getInputElement : function()
\r
990 return CKEDITOR.document.getById( this._.inputId );
\r
994 * Puts focus into the text input.
\r
999 var me = this.selectParentTab();
\r
1001 // GECKO BUG: setTimeout() is needed to workaround invisible selections.
\r
1002 setTimeout( function()
\r
1004 var element = me.getInputElement();
\r
1005 element && element.$.focus();
\r
1010 * Selects all the text in the text input.
\r
1013 select : function()
\r
1015 var me = this.selectParentTab();
\r
1017 // GECKO BUG: setTimeout() is needed to workaround invisible selections.
\r
1018 setTimeout( function()
\r
1020 var e = me.getInputElement();
\r
1030 * Handler for the text input's access key up event. Makes a select()
\r
1031 * call to the text input.
\r
1034 accessKeyUp : function()
\r
1040 * Sets the value of this text input object.
\r
1041 * @param {Object} value The new value.
\r
1042 * @returns {CKEDITOR.ui.dialog.textInput} The current UI element.
\r
1044 * uiElement.setValue( 'Blamo' );
\r
1046 setValue : function( value )
\r
1048 !value && ( value = '' );
\r
1049 return CKEDITOR.ui.dialog.uiElement.prototype.setValue.call( this, value );
\r
1052 keyboardFocusable : true
\r
1053 }, commonPrototype, true );
\r
1055 CKEDITOR.ui.dialog.textarea.prototype = new CKEDITOR.ui.dialog.textInput();
\r
1057 CKEDITOR.ui.dialog.select.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
1058 /** @lends CKEDITOR.ui.dialog.select.prototype */
\r
1061 * Gets the DOM element of the select box.
\r
1062 * @returns {CKEDITOR.dom.element} The <select> element of this UI
\r
1066 getInputElement : function()
\r
1068 return this._.select.getElement();
\r
1072 * Adds an option to the select box.
\r
1073 * @param {String} label Option label.
\r
1074 * @param {String} value (Optional) Option value, if not defined it'll be
\r
1075 * assumed to be the same as the label.
\r
1076 * @param {Number} index (Optional) Position of the option to be inserted
\r
1077 * to. If not defined the new option will be inserted to the end of list.
\r
1079 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1081 add : function( label, value, index )
\r
1083 var option = new CKEDITOR.dom.element( 'option', this.getDialog().getParentEditor().document ),
\r
1084 selectElement = this.getInputElement().$;
\r
1085 option.$.text = label;
\r
1086 option.$.value = ( value === undefined || value === null ) ? label : value;
\r
1087 if ( index === undefined || index === null )
\r
1089 if ( CKEDITOR.env.ie )
\r
1090 selectElement.add( option.$ );
\r
1092 selectElement.add( option.$, null );
\r
1095 selectElement.add( option.$, index );
\r
1100 * Removes an option from the selection list.
\r
1101 * @param {Number} index Index of the option to be removed.
\r
1103 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1105 remove : function( index )
\r
1107 var selectElement = this.getInputElement().$;
\r
1108 selectElement.remove( index );
\r
1113 * Clears all options out of the selection list.
\r
1114 * @returns {CKEDITOR.ui.dialog.select} The current select UI element.
\r
1116 clear : function()
\r
1118 var selectElement = this.getInputElement().$;
\r
1119 while ( selectElement.length > 0 )
\r
1120 selectElement.remove( 0 );
\r
1124 keyboardFocusable : true
\r
1125 }, commonPrototype, true );
\r
1127 CKEDITOR.ui.dialog.checkbox.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
1128 /** @lends CKEDITOR.ui.dialog.checkbox.prototype */
\r
1131 * Gets the checkbox DOM element.
\r
1133 * @returns {CKEDITOR.dom.element} The DOM element of the checkbox.
\r
1135 getInputElement : function()
\r
1137 return this._.checkbox.getElement();
\r
1141 * Sets the state of the checkbox.
\r
1143 * @param {Boolean} true to tick the checkbox, false to untick it.
\r
1145 setValue : function( checked )
\r
1147 this.getInputElement().$.checked = checked;
\r
1148 this.fire( 'change', { value : checked } );
\r
1152 * Gets the state of the checkbox.
\r
1154 * @returns {Boolean} true means the checkbox is ticked, false means it's not ticked.
\r
1156 getValue : function()
\r
1158 return this.getInputElement().$.checked;
\r
1162 * Handler for the access key up event. Toggles the checkbox.
\r
1165 accessKeyUp : function()
\r
1167 this.setValue( !this.getValue() );
\r
1171 * Defines the onChange event for UI element definitions.
\r
1178 onChange : function( dialog, func )
\r
1180 if ( !CKEDITOR.env.ie )
\r
1181 return commonEventProcessors.onChange.apply( this, arguments );
\r
1184 dialog.on( 'load', function()
\r
1186 var element = this._.checkbox.getElement();
\r
1187 element.on( 'propertychange', function( evt )
\r
1190 if ( evt.propertyName == 'checked' )
\r
1191 this.fire( 'change', { value : element.$.checked } );
\r
1194 this.on( 'change', func );
\r
1200 keyboardFocusable : true
\r
1201 }, commonPrototype, true );
\r
1203 CKEDITOR.ui.dialog.radio.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.uiElement,
\r
1204 /** @lends CKEDITOR.ui.dialog.radio.prototype */
\r
1207 * Checks one of the radio buttons in this button group.
\r
1209 * @param {String} value The value of the button to be chcked.
\r
1211 setValue : function( value )
\r
1213 var children = this._.children,
\r
1215 for ( var i = 0 ; ( i < children.length ) && ( item = children[i] ) ; i++ )
\r
1216 item.getElement().$.checked = ( item.getValue() == value );
\r
1217 this.fire( 'change', { value : value } );
\r
1221 * Gets the value of the currently checked radio button.
\r
1223 * @returns {String} The currently checked button's value.
\r
1225 getValue : function()
\r
1227 var children = this._.children;
\r
1228 for ( var i = 0 ; i < children.length ; i++ )
\r
1230 if ( children[i].getElement().$.checked )
\r
1231 return children[i].getValue();
\r
1237 * Handler for the access key up event. Focuses the currently
\r
1238 * selected radio button, or the first radio button if none is
\r
1242 accessKeyUp : function()
\r
1244 var children = this._.children, i;
\r
1245 for ( i = 0 ; i < children.length ; i++ )
\r
1247 if ( children[i].getElement().$.checked )
\r
1249 children[i].getElement().focus();
\r
1253 children[0].getElement().focus();
\r
1257 * Defines the onChange event for UI element definitions.
\r
1264 onChange : function( dialog, func )
\r
1266 if ( !CKEDITOR.env.ie )
\r
1267 return commonEventProcessors.onChange.apply( this, arguments );
\r
1270 dialog.on( 'load', function()
\r
1272 var children = this._.children, me = this;
\r
1273 for ( var i = 0 ; i < children.length ; i++ )
\r
1275 var element = children[i].getElement();
\r
1276 element.on( 'propertychange', function( evt )
\r
1279 if ( evt.propertyName == 'checked' && this.$.checked )
\r
1280 me.fire( 'change', { value : this.getAttribute( 'value' ) } );
\r
1284 this.on( 'change', func );
\r
1290 keyboardFocusable : true
\r
1291 }, commonPrototype, true );
\r
1293 CKEDITOR.ui.dialog.file.prototype = CKEDITOR.tools.extend( new CKEDITOR.ui.dialog.labeledElement,
\r
1295 /** @lends CKEDITOR.ui.dialog.file.prototype */
\r
1298 * Gets the <input> element of this file input.
\r
1299 * @returns {CKEDITOR.dom.element} The file input element.
\r
1302 getInputElement : function()
\r
1304 var frameDocument = CKEDITOR.document.getById( this._.frameId ).getFrameDocument();
\r
1305 return frameDocument.$.forms.length > 0 ?
\r
1306 new CKEDITOR.dom.element( frameDocument.$.forms[0].elements[0] ) :
\r
1307 this.getElement();
\r
1311 * Uploads the file in the file input.
\r
1312 * @returns {CKEDITOR.ui.dialog.file} This object.
\r
1315 submit : function()
\r
1317 this.getInputElement().getParent().$.submit();
\r
1322 * Get the action assigned to the form.
\r
1323 * @returns {String} The value of the action.
\r
1326 getAction : function( action )
\r
1328 return this.getInputElement().getParent().$.action;
\r
1332 * Redraws the file input and resets the file path in the file input.
\r
1333 * The redraw logic is necessary because non-IE browsers tend to clear
\r
1334 * the <iframe> containing the file input after closing the dialog.
\r
1337 reset : function()
\r
1339 var frameElement = CKEDITOR.document.getById( this._.frameId ),
\r
1340 frameDocument = frameElement.getFrameDocument(),
\r
1341 elementDefinition = this._.definition,
\r
1342 buttons = this._.buttons;
\r
1344 function generateFormField()
\r
1346 frameDocument.$.open();
\r
1348 // Support for custom document.domain in IE.
\r
1349 if ( CKEDITOR.env.isCustomDomain() )
\r
1350 frameDocument.$.domain = document.domain;
\r
1353 if ( elementDefinition.size )
\r
1354 size = elementDefinition.size - ( CKEDITOR.env.ie ? 7 : 0 ); // "Browse" button is bigger in IE.
\r
1356 frameDocument.$.write( [ '<html><head><title></title></head><body style="margin: 0; overflow: hidden; background: transparent;">',
\r
1357 '<form enctype="multipart/form-data" method="POST" action="',
\r
1358 CKEDITOR.tools.htmlEncode( elementDefinition.action ),
\r
1360 '<input type="file" name="',
\r
1361 CKEDITOR.tools.htmlEncode( elementDefinition.id || 'cke_upload' ),
\r
1363 CKEDITOR.tools.htmlEncode( size > 0 ? size : "" ),
\r
1366 '</body></html>' ].join( '' ) );
\r
1368 frameDocument.$.close();
\r
1370 for ( var i = 0 ; i < buttons.length ; i++ )
\r
1371 buttons[i].enable();
\r
1374 // #3465: Wait for the browser to finish rendering the dialog first.
\r
1375 if ( CKEDITOR.env.gecko )
\r
1376 setTimeout( generateFormField, 500 );
\r
1378 generateFormField();
\r
1381 getValue : function()
\r
1383 // The file path returned from the input tag is incomplete anyway, so it's
\r
1384 // safe to ignore it and prevent the confirmation dialog from appearing.
\r
1385 // (Part of #3465)
\r
1390 * Defines the onChange event for UI element definitions.
\r
1395 eventProcessors : commonEventProcessors,
\r
1397 keyboardFocusable : true
\r
1400 CKEDITOR.ui.dialog.fileButton.prototype = new CKEDITOR.ui.dialog.button;
\r
1402 CKEDITOR.ui.dialog.fieldset.prototype = CKEDITOR.tools.clone( CKEDITOR.ui.dialog.hbox.prototype );
\r
1404 CKEDITOR.dialog.addUIElement( 'text', textBuilder );
\r
1405 CKEDITOR.dialog.addUIElement( 'password', textBuilder );
\r
1406 CKEDITOR.dialog.addUIElement( 'textarea', commonBuilder );
\r
1407 CKEDITOR.dialog.addUIElement( 'checkbox', commonBuilder );
\r
1408 CKEDITOR.dialog.addUIElement( 'radio', commonBuilder );
\r
1409 CKEDITOR.dialog.addUIElement( 'button', commonBuilder );
\r
1410 CKEDITOR.dialog.addUIElement( 'select', commonBuilder );
\r
1411 CKEDITOR.dialog.addUIElement( 'file', commonBuilder );
\r
1412 CKEDITOR.dialog.addUIElement( 'fileButton', commonBuilder );
\r
1413 CKEDITOR.dialog.addUIElement( 'html', commonBuilder );
\r
1414 CKEDITOR.dialog.addUIElement( 'fieldset', containerBuilder );
\r