From a1b265c318dbda4a213cec930785b81e4c0f7d2b Mon Sep 17 00:00:00 2001
From: elmot <elmot@vaadin.com>
Date: Fri, 25 Sep 2015 16:40:44 +0300
Subject: Framework documentation IN

Change-Id: I767477c1fc3745f9e1f58075fe30c9ac8da63581
---
 .../components/components-customfield.asciidoc     | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 documentation/components/components-customfield.asciidoc

(limited to 'documentation/components/components-customfield.asciidoc')

diff --git a/documentation/components/components-customfield.asciidoc b/documentation/components/components-customfield.asciidoc
new file mode 100644
index 0000000000..f57eb2debf
--- /dev/null
+++ b/documentation/components/components-customfield.asciidoc
@@ -0,0 +1,33 @@
+---
+title: Composite Fields with CustomField
+order: 32
+layout: page
+---
+
+[[components.customfield]]
+= Composite Fields with [classname]#CustomField#
+
+The [classname]#CustomField# is a way to create composite components like with
+[classname]#CustomComponent#, except that it implements the
+[interfacename]#Field# interface and inherit [classname]#AbstractField#,
+described in
+<<dummy/../../../framework/components/components-fields#components.fields,"Field
+Components">>. A field allows editing a property value in the Vaadin data model,
+and can be bound to data with field groups, as described in
+<<dummy/../../../framework/datamodel/datamodel-itembinding#datamodel.itembinding,"Creating
+Forms by Binding Fields to Items">>. The field values are buffered and can be
+validated with validators.
+
+A composite field class must implement the [methodname]#getType()# and
+[methodname]#initContent()# methods. The latter should return the content
+composite of the field. It is typically a layout component, but can be any
+component.
+
+It is also possible to override [methodname]#validate()#,
+[methodname]#setInternalValue()#, [methodname]#commit()#,
+[methodname]#setPropertyDataSource#, [methodname]#isEmpty()# and other methods
+to implement different functionalities in the field. Methods overriding
+[methodname]#setInternalValue()# should call the superclass method.
+
+
+
-- 
cgit v1.2.3

