Class CKEDITOR.dialog.definition.fileButton

Extends CKEDITOR.dialog.definition.uiElement.
Defined in: plugins/dialog/dialogDefinition.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.dialog.definition.fileButton() The definition of a button for submitting the file in a file upload input.

Field Summary
Field Attributes	Field Name and Description
	filebrowser The instruction for CKEditor how to deal with file upload.
	for An array that contains pageId and elementId of the file upload input element for which this button is created.
	label The label of the UI element.
	validate (Optional) The validation function.

Fields borrowed from class CKEDITOR.dialog.definition.uiElement:: align, className, commit, id, onHide, onLoad, onShow, setup, style, title, type

Class Detail

CKEDITOR.dialog.definition.fileButton()

Since: 3.0

The definition of a button for submitting the file in a file upload input.

This class is not really part of the API. It just illustrates the properties that developers can use to define and create a button for submitting the file in a file upload input.

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.fileButton object and can be accessed with CKEDITOR.dialog#getContentElement.

For a complete example of dialog definition, please check CKEDITOR.dialog.add.

// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

// Example:
{
	type : 'file',
	id : 'upload',
	label : 'Select file from your computer',
	size : 38
},
{
	type : 'fileButton',
	id : 'fileId',
	label : 'Upload file',
	'for' : [ 'tab1', 'upload' ]
	filebrowser : {
		onSelect : function( fileUrl, data ) {
			alert( 'Successfully uploaded: ' + fileUrl );
		}
	}
}

Field Detail

{String|Object} filebrowser

Since: 3.0

The instruction for CKEditor how to deal with file upload. By default, the file and fileButton elements will not work "as expected" if this attribute is not set.

// Update field with id 'txtUrl' in the 'tab1' tab when file is uploaded.
filebrowser : 'tab1:txtUrl'

// Call custom onSelect function when file is successfully uploaded.
filebrowser : {
	onSelect : function( fileUrl, data ) {
		alert( 'Successfully uploaded: ' + fileUrl );
	}
}

{String} for

Since: 3.0

An array that contains pageId and elementId of the file upload input element for which this button is created.

[ pageId, elementId ]

{String} label

Since: 3.0

The label of the UI element.

{Function} validate

Since: 3.0

(Optional) The validation function.

CKEditor 3 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.dialog.definition.fileButton