X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=_source%2Fplugins%2Fdialog%2FdialogDefinition.js;h=a3db7f8941bd224e8b96d23fe60240882e708550;hb=f0610347140239143439a511ee2bd48cb784f470;hp=d0f04c2248ba2340dea266b723a16234b0f10b0b;hpb=4e90e78dc97789709ee7404359a5517540c27553;p=ckeditor.git diff --git a/_source/plugins/dialog/dialogDefinition.js b/_source/plugins/dialog/dialogDefinition.js index d0f04c2..a3db7f8 100644 --- a/_source/plugins/dialog/dialogDefinition.js +++ b/_source/plugins/dialog/dialogDefinition.js @@ -264,6 +264,14 @@ For licensing, see LICENSE.html or http://ckeditor.com/license */ /** + * Horizontal alignment (in container) of the UI element. + * @name CKEDITOR.dialog.definition.uiElement.prototype.align + * @field + * @type String + * @example + */ + +/** * Function to execute the first time the UI element is displayed. * @name CKEDITOR.dialog.definition.uiElement.prototype.onLoad * @field @@ -287,6 +295,24 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * @example */ +/** + * Function to execute whenever the UI element's parent dialog's {@link CKEDITOR.dialog.definition.setupContent} method is executed. + * It usually takes care of the respective UI element as a standalone element. + * @name CKEDITOR.dialog.definition.uiElement.prototype.setup + * @field + * @type Function + * @example + */ + +/** + * Function to execute whenever the UI element's parent dialog's {@link CKEDITOR.dialog.definition.commitContent} method is executed. + * It usually takes care of the respective UI element as a standalone element. + * @name CKEDITOR.dialog.definition.uiElement.prototype.commit + * @field + * @type Function + * @example + */ + // ----- hbox ----- /** @@ -474,6 +500,105 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * @example */ +// ----- labeled element ------ + +/** + * The definition of labeled user interface element (textarea, textInput etc). + *
This class is not really part of the API. It just illustrates the properties + * that developers can use to define and create dialog UI elements.
+ * @name CKEDITOR.dialog.definition.labeledElement + * @extends CKEDITOR.dialog.definition.uiElement + * @constructor + * @see CKEDITOR.ui.dialog.labeledElement + * @example + * // There is no constructor for this class, the user just has to define an + * // object with the appropriate properties. + */ + +/** + * The label of the UI element. + * @name CKEDITOR.dialog.definition.labeledElement.prototype.label + * @type String + * @field + * @example + * { + * type : 'text', + * label : 'My Label ' + * } + */ + +/** + * (Optional) Specify the layout of the label. Set to 'horizontal' for horizontal layout. + * The default layout is vertical. + * @name CKEDITOR.dialog.definition.labeledElement.prototype.labelLayout + * @type String + * @field + * @example + * { + * type : 'text', + * label : 'My Label ', + * labelLayout : 'horizontal', + * } + */ + +/** + * (Optional) Applies only to horizontal layouts: a two elements array of lengths to specify the widths of the +* label and the content element. See also {@link CKEDITOR.dialog.definition.labeledElement#labelLayout}. + * @name CKEDITOR.dialog.definition.labeledElement.prototype.widths + * @type Array + * @field + * @example + * { + * type : 'text', + * label : 'My Label ', + * labelLayout : 'horizontal', + * widths : [100, 200], + * } + */ + +/** + * Specify the inline style of the uiElement label. + * @name CKEDITOR.dialog.definition.labeledElement.prototype.labelStyle + * @type String + * @field + * @example + * { + * type : 'text', + * label : 'My Label ', + * labelStyle : 'color: red', + * } + */ + + +/** + * Specify the inline style of the input element. + * @name CKEDITOR.dialog.definition.labeledElement.prototype.inputStyle + * @type String + * @since 3.6.1 + * @field + * @example + * { + * type : 'text', + * label : 'My Label ', + * inputStyle : 'text-align:center', + * } + */ + +/** + * Specify the inline style of the input element container . + * @name CKEDITOR.dialog.definition.labeledElement.prototype.controlStyle + * @type String + * @since 3.6.1 + * @field + * @example + * { + * type : 'text', + * label : 'My Label ', + * controlStyle : 'width:3em', + * } + */ + + // ----- button ------ /** @@ -587,7 +712,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}. * @name CKEDITOR.dialog.definition.file - * @extends CKEDITOR.dialog.definition.uiElement + * @extends CKEDITOR.dialog.definition.labeledElement * @constructor * @example * // There is no constructor for this class, the user just has to define an @@ -622,14 +747,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license */ /** - * The label of the UI element. - * @name CKEDITOR.dialog.definition.file.prototype.label - * @type String - * @field - * @example - */ - -/** * (Optional) The action attribute of the form element associated with this file upload input. * If empty, CKEditor will use path to server connector for currently opened folder. * @name CKEDITOR.dialog.definition.file.prototype.action @@ -802,7 +919,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}. * @name CKEDITOR.dialog.definition.radio - * @extends CKEDITOR.dialog.definition.uiElement + * @extends CKEDITOR.dialog.definition.labeledElement * @constructor * @example * // There is no constructor for this class, the user just has to define an @@ -847,14 +964,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * @example */ -/** - * The label of the UI element. - * @name CKEDITOR.dialog.definition.radio.prototype.label - * @type String - * @field - * @example - */ - // ----- selectElement ------ /** @@ -866,7 +975,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}. * @name CKEDITOR.dialog.definition.select - * @extends CKEDITOR.dialog.definition.uiElement + * @extends CKEDITOR.dialog.definition.labeledElement * @constructor * @example * // There is no constructor for this class, the user just has to define an @@ -927,14 +1036,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * @example */ -/** - * The label of the UI element. - * @name CKEDITOR.dialog.definition.select.prototype.label - * @type String - * @field - * @example - */ - // ----- textInput ----- /** @@ -946,7 +1047,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}. * @name CKEDITOR.dialog.definition.textInput - * @extends CKEDITOR.dialog.definition.uiElement + * @extends CKEDITOR.dialog.definition.labeledElement * @constructor * @example * // There is no constructor for this class, the user just has to define an @@ -999,14 +1100,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * @example */ -/** - * The label of the UI element. - * @name CKEDITOR.dialog.definition.textInput.prototype.label - * @type String - * @field - * @example - */ - // ----- textarea ------ /** @@ -1018,7 +1111,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}. * @name CKEDITOR.dialog.definition.textarea - * @extends CKEDITOR.dialog.definition.uiElement + * @extends CKEDITOR.dialog.definition.labeledElement * @constructor * @example * // There is no constructor for this class, the user just has to define an @@ -1071,11 +1164,3 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * @field * @example */ - -/** - * The label of the UI element. - * @name CKEDITOR.dialog.definition.textarea.prototype.label - * @type String - * @field - * @example - */