vanilla ckeditor-3.6.1

[ckeditor.git] / _source / plugins / dialog / dialogDefinition.js

diff --git a/_source/plugins/dialog/dialogDefinition.js b/_source/plugins/dialog/dialogDefinition.js
index 67e890a..a3db7f8 100644 (file)
--- 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
  */\r
 \r
 /**\r
+ * Horizontal alignment (in container) of the UI element.\r
+ * @name CKEDITOR.dialog.definition.uiElement.prototype.align\r
+ * @field\r
+ * @type String\r
+ * @example\r
+ */\r
+\r
+/**\r
  * Function to execute the first time the UI element is displayed.\r
  * @name CKEDITOR.dialog.definition.uiElement.prototype.onLoad\r
  * @field\r
@@ -492,6 +500,105 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * @example\r
  */\r
 \r
+// ----- labeled element ------\r
+\r
+/**\r
+ * The definition of labeled user interface element (textarea, textInput etc).\r
+ * <div class="notapi">This class is not really part of the API. It just illustrates the properties\r
+ * that developers can use to define and create dialog UI elements.</div>\r
+ * @name CKEDITOR.dialog.definition.labeledElement\r
+ * @extends CKEDITOR.dialog.definition.uiElement\r
+ * @constructor\r
+ * @see CKEDITOR.ui.dialog.labeledElement\r
+ * @example\r
+ * // There is no constructor for this class, the user just has to define an\r
+ * // object with the appropriate properties.\r
+ */\r
+\r
+/**\r
+ * The label of the UI element.\r
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.label\r
+ * @type String\r
+ * @field\r
+ * @example\r
+ * {\r
+ *             type : 'text',\r
+ *             label : 'My Label '\r
+ * }\r
+ */\r
+\r
+/**\r
+ * (Optional) Specify the layout of the label. Set to 'horizontal' for horizontal layout.\r
+ * The default layout is vertical.\r
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.labelLayout\r
+ * @type String\r
+ * @field\r
+ * @example\r
+ * {\r
+ *             type : 'text',\r
+ *             label : 'My Label ',\r
+ *     <strong>        labelLayout : 'horizontal',</strong>\r
+ * }\r
+ */\r
+\r
+/**\r
+ * (Optional) Applies only to horizontal layouts: a two elements array of lengths to specify the widths of the\r
+*      label and the content element. See also {@link CKEDITOR.dialog.definition.labeledElement#labelLayout}.\r
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.widths\r
+ * @type Array\r
+ * @field\r
+ * @example\r
+ * {\r
+ *             type : 'text',\r
+ *             label : 'My Label ',\r
+ *             labelLayout : 'horizontal',\r
+ *     <strong>        widths : [100, 200],</strong>\r
+ * }\r
+ */\r
+\r
+/**\r
+ *  Specify the inline style of the uiElement label.\r
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.labelStyle\r
+ * @type String\r
+ * @field\r
+ * @example\r
+ * {\r
+ *             type : 'text',\r
+ *             label : 'My Label ',\r
+ *     <strong>        labelStyle : 'color: red',</strong>\r
+ * }\r
+ */\r
+\r
+\r
+/**\r
+ *  Specify the inline style of the input element.\r
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.inputStyle\r
+ * @type String\r
+ * @since 3.6.1\r
+ * @field\r
+ * @example\r
+ * {\r
+ *             type : 'text',\r
+ *             label : 'My Label ',\r
+ *     <strong>        inputStyle : 'text-align:center',</strong>\r
+ * }\r
+ */\r
+\r
+/**\r
+ *  Specify the inline style of the input element container .\r
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.controlStyle\r
+ * @type String\r
+ * @since 3.6.1\r
+ * @field\r
+ * @example\r
+ * {\r
+ *             type : 'text',\r
+ *             label : 'My Label ',\r
+ *     <strong>        controlStyle : 'width:3em',</strong>\r
+ * }\r
+ */\r
+\r
+\r
 // ----- button ------\r
 \r
 /**\r
@@ -605,7 +712,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * </div>\r
  * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}.\r
  * @name CKEDITOR.dialog.definition.file\r
- * @extends CKEDITOR.dialog.definition.uiElement\r
+ * @extends CKEDITOR.dialog.definition.labeledElement\r
  * @constructor\r
  * @example\r
  * // There is no constructor for this class, the user just has to define an\r
@@ -640,14 +747,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  */\r
 \r
 /**\r
- * The label of the UI element.\r
- * @name CKEDITOR.dialog.definition.file.prototype.label\r
- * @type String\r
- * @field\r
- * @example\r
- */\r
-\r
-/**\r
  * (Optional) The action attribute of the form element associated with this file upload input.\r
  * If empty, CKEditor will use path to server connector for currently opened folder.\r
  * @name CKEDITOR.dialog.definition.file.prototype.action\r
@@ -820,7 +919,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * </div>\r
  * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}.\r
  * @name CKEDITOR.dialog.definition.radio\r
- * @extends CKEDITOR.dialog.definition.uiElement\r
+ * @extends CKEDITOR.dialog.definition.labeledElement\r
  * @constructor\r
  * @example\r
  * // There is no constructor for this class, the user just has to define an\r
@@ -865,14 +964,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * @example\r
  */\r
 \r
-/**\r
- * The label of the UI element.\r
- * @name CKEDITOR.dialog.definition.radio.prototype.label\r
- * @type String\r
- * @field\r
- * @example\r
- */\r
-\r
 // ----- selectElement ------\r
 \r
 /**\r
@@ -884,7 +975,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * </div>\r
  * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}.\r
  * @name CKEDITOR.dialog.definition.select\r
- * @extends CKEDITOR.dialog.definition.uiElement\r
+ * @extends CKEDITOR.dialog.definition.labeledElement\r
  * @constructor\r
  * @example\r
  * // There is no constructor for this class, the user just has to define an\r
@@ -945,14 +1036,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * @example\r
  */\r
 \r
-/**\r
- * The label of the UI element.\r
- * @name CKEDITOR.dialog.definition.select.prototype.label\r
- * @type String\r
- * @field\r
- * @example\r
- */\r
-\r
 // ----- textInput -----\r
 \r
 /**\r
@@ -964,7 +1047,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * </div>\r
  * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}.\r
  * @name CKEDITOR.dialog.definition.textInput\r
- * @extends CKEDITOR.dialog.definition.uiElement\r
+ * @extends CKEDITOR.dialog.definition.labeledElement\r
  * @constructor\r
  * @example\r
  * // There is no constructor for this class, the user just has to define an\r
@@ -1017,14 +1100,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * @example\r
  */\r
 \r
-/**\r
- * The label of the UI element.\r
- * @name CKEDITOR.dialog.definition.textInput.prototype.label\r
- * @type String\r
- * @field\r
- * @example\r
- */\r
-\r
 // ----- textarea ------\r
 \r
 /**\r
@@ -1036,7 +1111,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * </div>\r
  * For a complete example of dialog definition, please check {@link CKEDITOR.dialog.add}.\r
  * @name CKEDITOR.dialog.definition.textarea\r
- * @extends CKEDITOR.dialog.definition.uiElement\r
+ * @extends CKEDITOR.dialog.definition.labeledElement\r
  * @constructor\r
  * @example\r
  * // There is no constructor for this class, the user just has to define an\r
@@ -1089,11 +1164,3 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * @field\r
  * @example\r
  */\r
-\r
-/**\r
- * The label of the UI element.\r
- * @name CKEDITOR.dialog.definition.textarea.prototype.label\r
- * @type String\r
- * @field\r
- * @example\r
- */\r