Ticket #7991: 7991_apidocs.patch

_source/plugins/dialog/dialogDefinition.js

@@ -500 +500 @@
  * @example
  */
 
+// ----- labeled element ------
+
+/**
+ * The definition of labeled user interface element (textarea, textInput etc).
+ * <div class="notapi">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.</div>
+ * @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 ',
+ *      <strong>        labelLayout : 'horizontal',</strong>
+ * }
+ */
+
+/**
+ * (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',
+ *      <strong>        widths : [100, 200],</strong>
+ * }
+ */
+
+/**
+ *  Specify the inline style of the uiElement label.
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.labelStyle
+ * @type String
+ * @field
+ * @example
+ * {
+ *              type : 'text',
+ *              label : 'My Label ',
+ *      <strong>        labelStyle : 'color: red',</strong>
+ * }
+ */
+
+
+/**
+ *  Specify the inline style of the input element.
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.inputStyle
+ * @type String
+ * @field
+ * @example
+ * {
+ *              type : 'text',
+ *              label : 'My Label ',
+ *      <strong>        inputStyle : 'text-align:center',</strong>
+ * }
+ */
+
+/**
+ *  Specify the inline style of the input element container .
+ * @name CKEDITOR.dialog.definition.labeledElement.prototype.controlStyle
+ * @type String
+ * @field
+ * @example
+ * {
+ *              type : 'text',
+ *              label : 'My Label ',
+ *      <strong>        controlStyle : 'width:3em',</strong>
+ * }
+ */
+
+
 // ----- button ------
 
 /**
@@ -613 +710 @@
  * </div>
  * 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
@@ -648 +745 @@
  */
 
 /**
- * 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
@@ -828 +917 @@
  * </div>
  * 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
@@ -873 +962 @@
  * @example
  */
 
-/**
- * The label of the UI element.
- * @name CKEDITOR.dialog.definition.radio.prototype.label
- * @type String
- * @field
- * @example
- */
-
 // ----- selectElement ------
 
 /**
@@ -892 +973 @@
  * </div>
  * 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
@@ -953 +1034 @@
  * @example
  */
 
-/**
- * The label of the UI element.
- * @name CKEDITOR.dialog.definition.select.prototype.label
- * @type String
- * @field
- * @example
- */
-
 // ----- textInput -----
 
 /**
@@ -972 +1045 @@
  * </div>
  * 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
@@ -1025 +1098 @@
  * @example
  */
 
-/**
- * The label of the UI element.
- * @name CKEDITOR.dialog.definition.textInput.prototype.label
- * @type String
- * @field
- * @example
- */
-
 // ----- textarea ------
 
 /**
@@ -1044 +1109 @@
  * </div>
  * 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
@@ -1097 +1162 @@
  * @field
  * @example
  */
-
-/**
- * The label of the UI element.
- * @name CKEDITOR.dialog.definition.textarea.prototype.label
- * @type String
- * @field
- * @example
- */