/*\r
-Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
For licensing, see LICENSE.html or http://ckeditor.com/license\r
*/\r
\r
*/\r
( function()\r
{\r
- /**\r
+ /*\r
* Adds (additional) arguments to given url.\r
*\r
* @param {String}\r
return url + ( ( url.indexOf( "?" ) != -1 ) ? "&" : "?" ) + queryString.join( "&" );\r
}\r
\r
- /**\r
+ /*\r
* Make a string's first character uppercase.\r
*\r
* @param {String}\r
return f + str.substr( 1 );\r
}\r
\r
- /**\r
+ /*\r
* The onlick function assigned to the 'Browse Server' button. Opens the\r
* file browser and updates target field when file is selected.\r
*\r
params.langCode = editor.langCode;\r
\r
var url = addQueryString( this.filebrowser.url, params );\r
- editor.popup( url, width, height );\r
+ editor.popup( url, width, height, editor.config.fileBrowserWindowFeatures );\r
}\r
\r
- /**\r
+ /*\r
* The onlick function assigned to the 'Upload' button. Makes the final\r
* decision whether form is really submitted and updates target field when\r
* file is uploaded.\r
return true;\r
}\r
\r
- /**\r
+ /*\r
* Setups the file element.\r
*\r
* @param {CKEDITOR.ui.dialog.file}\r
fileInput.filebrowser = filebrowser;\r
}\r
\r
- /**\r
+ /*\r
* Traverse through the content definition and attach filebrowser to\r
* elements with 'filebrowser' attribute.\r
*\r
* @param String\r
* dialogName Dialog name.\r
- * @param {CKEDITOR.dialog.dialogDefinitionObject}\r
+ * @param {CKEDITOR.dialog.definitionObject}\r
* definition Dialog definition.\r
* @param {Array}\r
- * elements Array of {@link CKEDITOR.dialog.contentDefinition}\r
+ * elements Array of {@link CKEDITOR.dialog.definition.content}\r
* objects.\r
*/\r
function attachFileBrowser( editor, dialogName, definition, elements )\r
\r
if ( element.filebrowser.action == 'Browse' )\r
{\r
- var url = element.filebrowser.url || editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'BrowseUrl' ]\r
- || editor.config.filebrowserBrowseUrl;\r
+ var url = element.filebrowser.url;\r
+ if ( url === undefined )\r
+ {\r
+ url = editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'BrowseUrl' ];\r
+ if ( url === undefined )\r
+ url = editor.config.filebrowserBrowseUrl;\r
+ }\r
\r
if ( url )\r
{\r
}\r
else if ( element.filebrowser.action == 'QuickUpload' && element[ 'for' ] )\r
{\r
- url = element.filebrowser.url || editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'UploadUrl' ]\r
- || editor.config.filebrowserUploadUrl;\r
+ url = element.filebrowser.url;\r
+ if ( url === undefined )\r
+ {\r
+ url = editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'UploadUrl' ];\r
+ if ( url === undefined )\r
+ url = editor.config.filebrowserUploadUrl;\r
+ }\r
\r
if ( url )\r
{\r
- element.onClick = uploadFile;\r
+ var onClick = element.onClick;\r
+ element.onClick = function( evt )\r
+ {\r
+ // "element" here means the definition object, so we need to find the correct\r
+ // button to scope the event call\r
+ var sender = evt.sender;\r
+ if ( onClick && onClick.call( sender, evt ) === false )\r
+ return false;\r
+\r
+ return uploadFile.call( sender, evt );\r
+ };\r
+\r
element.filebrowser.url = url;\r
element.hidden = false;\r
setupFileElement( editor, definition.getContents( element[ 'for' ][ 0 ] ).get( element[ 'for' ][ 1 ] ), element.filebrowser );\r
}\r
}\r
\r
- /**\r
+ /*\r
* Updates the target element with the url of uploaded/selected file.\r
*\r
* @param {String}\r
}\r
}\r
\r
- /**\r
+ /*\r
* Returns true if filebrowser is configured in one of the elements.\r
*\r
- * @param {CKEDITOR.dialog.dialogDefinitionObject}\r
+ * @param {CKEDITOR.dialog.definitionObject}\r
* definition Dialog definition.\r
* @param String\r
* tabId The tab id where element(s) can be found.\r
var ids = elementId.split( ";" );\r
for ( var i = 0 ; i < ids.length ; i++ )\r
{\r
- if ( isConfigured( definition, tabId, ids[i]) )\r
+ if ( isConfigured( definition, tabId, ids[i] ) )\r
return true;\r
}\r
return false;\r
}\r
\r
- return ( definition.getContents( tabId ).get( elementId ).filebrowser && definition.getContents( tabId ).get( elementId ).filebrowser.url );\r
+ var elementFileBrowser = definition.getContents( tabId ).get( elementId ).filebrowser;\r
+ return ( elementFileBrowser && elementFileBrowser.url );\r
}\r
\r
function setUrl( fileUrl, data )\r
if ( targetInput )\r
dialog.getContentElement( targetInput[ 0 ], targetInput[ 1 ] ).reset();\r
\r
+ if ( typeof data == 'function' && data.call( this._.filebrowserSe ) === false )\r
+ return;\r
+\r
if ( onSelect && onSelect.call( this._.filebrowserSe, fileUrl, data ) === false )\r
return;\r
\r
init : function( editor, pluginPath )\r
{\r
editor._.filebrowserFn = CKEDITOR.tools.addFunction( setUrl, editor );\r
+ editor.on( 'destroy', function () { CKEDITOR.tools.removeFunction( this._.filebrowserFn ); } );\r
+ }\r
+ } );\r
\r
- CKEDITOR.on( 'dialogDefinition', function( evt )\r
+ CKEDITOR.on( 'dialogDefinition', function( evt )\r
+ {\r
+ var definition = evt.data.definition,\r
+ element;\r
+ // Associate filebrowser to elements with 'filebrowser' attribute.\r
+ for ( var i in definition.contents )\r
+ {\r
+ if ( ( element = definition.contents[ i ] ) )\r
{\r
- // Associate filebrowser to elements with 'filebrowser' attribute.\r
- for ( var i in evt.data.definition.contents )\r
+ attachFileBrowser( evt.editor, evt.data.name, definition, element.elements );\r
+ if ( element.hidden && element.filebrowser )\r
{\r
- attachFileBrowser( evt.editor, evt.data.name, evt.data.definition, evt.data.definition.contents[ i ].elements );\r
- if ( evt.data.definition.contents[ i ].hidden && evt.data.definition.contents[ i ].filebrowser )\r
- {\r
- evt.data.definition.contents[ i ].hidden =\r
- !isConfigured( evt.data.definition, evt.data.definition.contents[ i ][ 'id' ], evt.data.definition.contents[ i ].filebrowser );\r
- }\r
+ element.hidden = !isConfigured( definition, element[ 'id' ], element.filebrowser );\r
}\r
- } );\r
+ }\r
}\r
} );\r
\r
} )();\r
+\r
+/**\r
+ * The location of an external file browser, that should be launched when "Browse Server" button is pressed.\r
+ * If configured, the "Browse Server" button will appear in Link, Image and Flash dialogs.\r
+ * @see The <a href="http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_(Uploader)">File Browser/Uploader</a> documentation.\r
+ * @name CKEDITOR.config.filebrowserBrowseUrl\r
+ * @since 3.0\r
+ * @type String\r
+ * @default '' (empty string = disabled)\r
+ * @example\r
+ * config.filebrowserBrowseUrl = '/browser/browse.php';\r
+ */\r
+\r
+/**\r
+ * The location of a script that handles file uploads.\r
+ * If set, the "Upload" tab will appear in "Link", "Image" and "Flash" dialogs.\r
+ * @name CKEDITOR.config.filebrowserUploadUrl\r
+ * @see The <a href="http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_(Uploader)">File Browser/Uploader</a> documentation.\r
+ * @since 3.0\r
+ * @type String\r
+ * @default '' (empty string = disabled)\r
+ * @example\r
+ * config.filebrowserUploadUrl = '/uploader/upload.php';\r
+ */\r
+\r
+/**\r
+ * The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Image dialog.\r
+ * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}.\r
+ * @name CKEDITOR.config.filebrowserImageBrowseUrl\r
+ * @since 3.0\r
+ * @type String\r
+ * @default '' (empty string = disabled)\r
+ * @example\r
+ * config.filebrowserImageBrowseUrl = '/browser/browse.php?type=Images';\r
+ */\r
+\r
+/**\r
+ * The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Flash dialog.\r
+ * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}.\r
+ * @name CKEDITOR.config.filebrowserFlashBrowseUrl\r
+ * @since 3.0\r
+ * @type String\r
+ * @default '' (empty string = disabled)\r
+ * @example\r
+ * config.filebrowserFlashBrowseUrl = '/browser/browse.php?type=Flash';\r
+ */\r
+\r
+/**\r
+ * The location of a script that handles file uploads in the Image dialog.\r
+ * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserUploadUrl}.\r
+ * @name CKEDITOR.config.filebrowserImageUploadUrl\r
+ * @since 3.0\r
+ * @type String\r
+ * @default '' (empty string = disabled)\r
+ * @example\r
+ * config.filebrowserImageUploadUrl = '/uploader/upload.php?type=Images';\r
+ */\r
+\r
+/**\r
+ * The location of a script that handles file uploads in the Flash dialog.\r
+ * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserUploadUrl}.\r
+ * @name CKEDITOR.config.filebrowserFlashUploadUrl\r
+ * @since 3.0\r
+ * @type String\r
+ * @default '' (empty string = disabled)\r
+ * @example\r
+ * config.filebrowserFlashUploadUrl = '/uploader/upload.php?type=Flash';\r
+ */\r
+\r
+/**\r
+ * The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Link tab of Image dialog.\r
+ * If not set, CKEditor will use {@link CKEDITOR.config.filebrowserBrowseUrl}.\r
+ * @name CKEDITOR.config.filebrowserImageBrowseLinkUrl\r
+ * @since 3.2\r
+ * @type String\r
+ * @default '' (empty string = disabled)\r
+ * @example\r
+ * config.filebrowserImageBrowseLinkUrl = '/browser/browse.php';\r
+ */\r
+\r
+/**\r
+ * The "features" to use in the file browser popup window.\r
+ * @name CKEDITOR.config.filebrowserWindowFeatures\r
+ * @since 3.4.1\r
+ * @type String\r
+ * @default 'location=no,menubar=no,toolbar=no,dependent=yes,minimizable=no,modal=yes,alwaysRaised=yes,resizable=yes,scrollbars=yes'\r
+ * @example\r
+ * config.filebrowserWindowFeatures = 'resizable=yes,scrollbars=no';\r
+ */\r
+\r
+/**\r
+ * The width of the file browser popup window. It can be a number or a percent string.\r
+ * @name CKEDITOR.config.filebrowserWindowWidth\r
+ * @type Number|String\r
+ * @default '80%'\r
+ * @example\r
+ * config.filebrowserWindowWidth = 750;\r
+ * @example\r
+ * config.filebrowserWindowWidth = '50%';\r
+ */\r
+\r
+/**\r
+ * The height of the file browser popup window. It can be a number or a percent string.\r
+ * @name CKEDITOR.config.filebrowserWindowHeight\r
+ * @type Number|String\r
+ * @default '70%'\r
+ * @example\r
+ * config.filebrowserWindowHeight = 580;\r
+ * @example\r
+ * config.filebrowserWindowHeight = '50%';\r
+ */\r
Got questions, comments, patches, etc.? Contact Jason Woofenden