X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;ds=inline;f=_source%2Fplugins%2Fdialog%2FdialogDefinition.js;h=9d9638016f8c9e3e2a3f1e1b1042dec6b78b6ab0;hb=3fe9cac293e090ea459a3ee10d78cbe9e1dd0e03;hp=67e890a83779c396d990ba956200672d4bc91cc2;hpb=1056598c95187351dc58f4991d331e2258d038b5;p=ckeditor.git
diff --git a/_source/plugins/dialog/dialogDefinition.js b/_source/plugins/dialog/dialogDefinition.js
index 67e890a..9d96380 100644
--- a/_source/plugins/dialog/dialogDefinition.js
+++ b/_source/plugins/dialog/dialogDefinition.js
@@ -1,5 +1,5 @@
/*
-Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
+Copyright (c) 2003-2013, CKSource - Frederico Knabben. All rights reserved.
For licensing, see LICENSE.html or http://ckeditor.com/license
*/
@@ -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
@@ -492,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 ------
/**
@@ -605,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
@@ -640,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
@@ -820,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
@@ -865,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 ------
/**
@@ -884,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
@@ -945,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 -----
/**
@@ -964,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
@@ -1017,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 ------
/**
@@ -1036,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
@@ -1089,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
- */