X-Git-Url: https://jasonwoof.com/gitweb/?p=ckeditor.git;a=blobdiff_plain;f=_source%2Fplugins%2Ffilebrowser%2Fplugin.js;h=5f8718017de8b3475d38aa5fb555f7dcd9372d5a;hp=799d68f2be5ba18313c2340ac5df1f5ab2aae2e7;hb=e73319a12b56100b29ef456fd74114fe5519e01c;hpb=f0610347140239143439a511ee2bd48cb784f470 diff --git a/_source/plugins/filebrowser/plugin.js b/_source/plugins/filebrowser/plugin.js index 799d68f..5f87180 100644 --- a/_source/plugins/filebrowser/plugin.js +++ b/_source/plugins/filebrowser/plugin.js @@ -4,15 +4,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license */ /** - * @fileOverview The "filebrowser" plugin, it adds support for file uploads and + * @fileOverview The "filebrowser" plugin that adds support for file uploads and * browsing. * - * When file is selected inside of the file browser or uploaded, its url is - * inserted automatically to a field, which is described in the 'filebrowser' - * attribute. To specify field that should be updated, pass the tab id and - * element id, separated with a colon. + * When a file is uploaded or selected inside the file browser, its URL is + * inserted automatically into a field defined in the filebrowser + * attribute. In order to specify a field that should be updated, pass the tab ID and + * the element ID, separated with a colon.

* - * Example 1: (Browse) + * Example 1: (Browse) * * 
  * {
@@ -23,10 +23,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * }
  *
* - * If you set the 'filebrowser' attribute on any element other than - * 'fileButton', the 'Browse' action will be triggered. + * If you set the filebrowser attribute for an element other than + * the fileButton, the Browse action will be triggered.

* - * Example 2: (Quick Upload) + * Example 2: (Quick Upload) * * 
  * {
@@ -38,23 +38,23 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * }
  *
* - * If you set the 'filebrowser' attribute on a fileButton element, the - * 'QuickUpload' action will be executed. + * If you set the filebrowser attribute for a fileButton + * element, the QuickUpload action will be executed.

* - * Filebrowser plugin also supports more advanced configuration (through - * javascript object). + * The filebrowser plugin also supports more advanced configuration performed through + * a JavaScript object. * * The following settings are supported: * - * 
- *  [action] - Browse or QuickUpload
- *  [target] - field to update, tabId:elementId
- *  [params] - additional arguments to be passed to the server connector (optional)
- *  [onSelect] - function to execute when file is selected/uploaded (optional)
- *  [url] - the URL to be called (optional)
- *
+ * * - * Example 3: (Quick Upload) + * Example 3: (Quick Upload) * * 
  * {
@@ -63,16 +63,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * 	id : 'buttonId',
  * 	filebrowser :
  * 	{
- * 		action : 'QuickUpload', //required
- * 		target : 'tab1:elementId', //required
- * 		params : //optional
+ * 		action : 'QuickUpload', // required
+ * 		target : 'tab1:elementId', // required
+ * 		params : // optional
  * 		{
  * 			type : 'Files',
  * 			currentFolder : '/folder/'
  * 		},
- * 		onSelect : function( fileUrl, errorMessage ) //optional
+ * 		onSelect : function( fileUrl, errorMessage ) // optional
  * 		{
- * 			// Do not call the built-in selectFuntion
+ * 			// Do not call the built-in selectFuntion.
  * 			// return false;
  * 		}
  * 	},
@@ -80,14 +80,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * }
  *
* - * Suppose we have a file element with id 'myFile', text field with id - * 'elementId' and a fileButton. If filebowser.url is not specified explicitly, - * form action will be set to 'filebrowser[DialogName]UploadUrl' or, if not - * specified, to 'filebrowserUploadUrl'. Additional parameters from 'params' - * object will be added to the query string. It is possible to create your own - * uploadHandler and cancel the built-in updateTargetElement command. + * Suppose you have a file element with an ID of myFile, a text + * field with an ID of elementId and a fileButton. + * If the filebowser.url attribute is not specified explicitly, + * the form action will be set to filebrowser[DialogWindowName]UploadUrl + * or, if not specified, to filebrowserUploadUrl. Additional parameters + * from the params object will be added to the query string. It is + * possible to create your own uploadHandler and cancel the built-in + * updateTargetElement command.

* - * Example 4: (Browse) + * Example 4: (Browse) * * 
  * {
@@ -103,12 +105,12 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * }
  *
* - * In this example, after pressing a button, file browser will be opened in a - * popup. If we don't specify filebrowser.url attribute, - * 'filebrowser[DialogName]BrowseUrl' or 'filebrowserBrowseUrl' will be used. - * After selecting a file in a file browser, an element with id 'elementId' will - * be updated. Just like in the third example, a custom 'onSelect' function may be - * defined. + * In this example, when the button is pressed, the file browser will be opened in a + * popup window. If you do not specify the filebrowser.url attribute, + * filebrowser[DialogName]BrowseUrl or + * filebrowserBrowseUrl will be used. After selecting a file in the file + * browser, an element with an ID of elementId will be updated. Just + * like in the third example, a custom onSelect function may be defined. */ ( function() { @@ -174,7 +176,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license params.langCode = editor.langCode; var url = addQueryString( this.filebrowser.url, params ); - editor.popup( url, width, height, editor.config.fileBrowserWindowFeatures ); + // TODO: V4: Remove backward compatibility (#8163). + editor.popup( url, width, height, editor.config.filebrowserWindowFeatures || editor.config.fileBrowserWindowFeatures ); } /* @@ -413,99 +416,105 @@ For licensing, see LICENSE.html or http://ckeditor.com/license } )(); /** - * The location of an external file browser, that should be launched when "Browse Server" button is pressed. - * If configured, the "Browse Server" button will appear in Link, Image and Flash dialogs. + * The location of an external file browser that should be launched when the Browse Server + * button is pressed. If configured, the Browse Server button will appear in the + * Link, Image, and Flash dialog windows. * @see The File Browser/Uploader documentation. * @name CKEDITOR.config.filebrowserBrowseUrl * @since 3.0 * @type String - * @default '' (empty string = disabled) + * @default '' (empty string = disabled) * @example * config.filebrowserBrowseUrl = '/browser/browse.php'; */ /** - * The location of a script that handles file uploads. - * If set, the "Upload" tab will appear in "Link", "Image" and "Flash" dialogs. + * The location of the script that handles file uploads. + * If set, the Upload tab will appear in the Link, Image, + * and Flash dialog windows. * @name CKEDITOR.config.filebrowserUploadUrl * @see The File Browser/Uploader documentation. * @since 3.0 * @type String - * @default '' (empty string = disabled) + * @default '' (empty string = disabled) * @example * config.filebrowserUploadUrl = '/uploader/upload.php'; */ /** - * The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Image dialog. - * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}. + * The location of an external file browser that should be launched when the Browse Server + * button is pressed in the Image dialog window. + * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}. * @name CKEDITOR.config.filebrowserImageBrowseUrl * @since 3.0 * @type String - * @default '' (empty string = disabled) + * @default '' (empty string = disabled) * @example * config.filebrowserImageBrowseUrl = '/browser/browse.php?type=Images'; */ /** - * The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Flash dialog. - * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}. + * The location of an external file browser that should be launched when the Browse Server + * button is pressed in the Flash dialog window. + * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}. * @name CKEDITOR.config.filebrowserFlashBrowseUrl * @since 3.0 * @type String - * @default '' (empty string = disabled) + * @default '' (empty string = disabled) * @example * config.filebrowserFlashBrowseUrl = '/browser/browse.php?type=Flash'; */ /** - * The location of a script that handles file uploads in the Image dialog. - * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserUploadUrl}. + * The location of the script that handles file uploads in the Image dialog window. + * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserUploadUrl}. * @name CKEDITOR.config.filebrowserImageUploadUrl * @since 3.0 * @type String - * @default '' (empty string = disabled) + * @default '' (empty string = disabled) * @example * config.filebrowserImageUploadUrl = '/uploader/upload.php?type=Images'; */ /** - * The location of a script that handles file uploads in the Flash dialog. - * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserUploadUrl}. + * The location of the script that handles file uploads in the Flash dialog window. + * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserUploadUrl}. * @name CKEDITOR.config.filebrowserFlashUploadUrl * @since 3.0 * @type String - * @default '' (empty string = disabled) + * @default '' (empty string = disabled) * @example * config.filebrowserFlashUploadUrl = '/uploader/upload.php?type=Flash'; */ /** - * The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Link tab of Image dialog. - * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}. + * The location of an external file browser that should be launched when the Browse Server + * button is pressed in the Link tab of the Image dialog window. + * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}. * @name CKEDITOR.config.filebrowserImageBrowseLinkUrl * @since 3.2 * @type String - * @default '' (empty string = disabled) + * @default '' (empty string = disabled) * @example * config.filebrowserImageBrowseLinkUrl = '/browser/browse.php'; */ /** - * The "features" to use in the file browser popup window. + * The features to use in the file browser popup window. * @name CKEDITOR.config.filebrowserWindowFeatures * @since 3.4.1 * @type String - * @default 'location=no,menubar=no,toolbar=no,dependent=yes,minimizable=no,modal=yes,alwaysRaised=yes,resizable=yes,scrollbars=yes' + * @default 'location=no,menubar=no,toolbar=no,dependent=yes,minimizable=no,modal=yes,alwaysRaised=yes,resizable=yes,scrollbars=yes' * @example * config.filebrowserWindowFeatures = 'resizable=yes,scrollbars=no'; */ /** - * The width of the file browser popup window. It can be a number or a percent string. + * The width of the file browser popup window. It can be a number denoting a value in + * pixels or a percent string. * @name CKEDITOR.config.filebrowserWindowWidth * @type Number|String - * @default '80%' + * @default '80%' * @example * config.filebrowserWindowWidth = 750; * @example @@ -513,10 +522,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license */ /** - * The height of the file browser popup window. It can be a number or a percent string. + * The height of the file browser popup window. It can be a number denoting a value in + * pixels or a percent string. * @name CKEDITOR.config.filebrowserWindowHeight * @type Number|String - * @default '70%' + * @default '70%' * @example * config.filebrowserWindowHeight = 580; * @example