8
0
Просмотр исходного кода

Improved documentation of the EditableUI component.

Aleksander Nowodzinski 9 лет назад
Родитель
Сommit
4206745671

+ 11 - 3
packages/ckeditor5-ui/src/editableui/editableui.js

@@ -8,16 +8,24 @@
 import Controller from '../controller.js';
 
 /**
+ * The EditableUI controller class. It glues the engine editable
+ * {@link engine.view.RootEditableElement} with the UI.
+ *
+ *		// An instance of EditableUI.
+ *		new EditableUI( editor, editable, new EditableUIView() );
+ *
+ * See {@link ui.editableUI.EditableUIView}.
+ *
  * @memberOf ui.editableUI
  * @extends ui.Controller
  */
 export default class EditableUI extends Controller {
 	/**
-	 * Creates a new instance of the Editable class.
+	 * Creates an instance of {@link ui.editableUI.EditableUI} class.
 	 *
 	 * @param {ckeditor5.Editor} editor The editor instance.
-	 * @param {engine.view.RootEditableElement} editable The editable element.
-	 * @param {ui.View} [view] EditableUI View instance.
+	 * @param {engine.view.RootEditableElement} editable The editable element in the engine.
+	 * @param {ui.View} [view] An instance of EditableUIView instance.
 	 */
 	constructor( editor, editable, view ) {
 		super( editable, view );

+ 35 - 1
packages/ckeditor5-ui/src/editableui/editableuiview.js

@@ -9,6 +9,10 @@ import View from '../view.js';
 import Template from '../template.js';
 
 /**
+ * The EditableUIView class.
+ *
+ * See {@link ui.editableUI.EditableUI}.
+ *
  * @memberOf ui.editableUI
  * @extends ui.View
  */
@@ -16,7 +20,6 @@ export default class EditableUIView extends View {
 	/**
 	 * Creates an instance of the EditableUIView class.
 	 *
-	 * @param {utils.Observable} model (View)Model of this View.
 	 * @param {utils.Locale} [locale] The {@link ckeditor5.Editor#locale editor's locale} instance.
 	 * @param {HTMLElement} [editableElement] The editable element. If not specified, this view
 	 * should create it. Otherwise, the existing element should be used.
@@ -47,6 +50,12 @@ export default class EditableUIView extends View {
 		 * @readonly
 		 * @member {HTMLElement} ui.editableUI.EditableUIView#editableElement
 		 */
+
+		/**
+		 * Model of this EditableUIView.
+		 *
+		 * @member {ui.editableUI.EditableUIViewModel} ui.editableUI.EditableUIView#model
+		 */
 	}
 
 	/**
@@ -69,3 +78,28 @@ export default class EditableUIView extends View {
 		this.editableElement.contentEditable = false;
 	}
 }
+
+/**
+ * The EditableUIView {@link ui.Model} interface.
+ *
+ * @memberOf ui.editableUI
+ * @interface ui.editableUI.EditableUIViewModel
+ */
+
+/**
+ * Controls whether the editable is writable or not.
+ *
+ * @member {String} ui.editableUI.EditableUIViewModel#isReadOnly
+ */
+
+/**
+ * Controls whether the editable is focused, i.e. the user is typing in it.
+ *
+ * @member {String} ui.editableUI.EditableUIViewModel#isFocused
+ */
+
+/**
+ * The name of the EditableUIView.
+ *
+ * @member {String} ui.editableUI.EditableUIViewModel#name
+ */

+ 3 - 2
packages/ckeditor5-ui/src/editableui/inline/inlineeditableuiview.js

@@ -9,7 +9,9 @@ import EditableUIView from '../../editableui/editableuiview.js';
 import Template from '../../template.js';
 
 /**
- * The class implementing an inline {@link ui.editableUI.EditableUIView}.
+ * The InlineEditableUIView class implementing an inline {@link ui.editableUI.EditableUIView}.
+ *
+ * See {@link ui.editableUI.EditableUI}, {@link ui.editableUI.EditableUIView}.
  *
  * @memberOf ui.editableUI.inline
  * @extends ui.editableUI.EditableUIView
@@ -18,7 +20,6 @@ export default class InlineEditableUIView extends EditableUIView {
 	/**
 	 * Creates an instance of the InlineEditableUIView class.
 	 *
-	 * @param {utils.Observable} model (View)Model of this view.
 	 * @param {utils.Locale} [locale] The {@link ckeditor5.Editor#locale editor's locale} instance.
 	 * @param {HTMLElement} [editableElement] The editable element. If not specified, the {@link EditableUIView}
 	 * should create it. Otherwise, the existing element should be used.