diff options
author | Marko Gronroos <magi@vaadin.com> | 2016-07-19 19:12:09 +0300 |
---|---|---|
committer | Artur Signell <artur@vaadin.com> | 2016-08-05 10:19:44 +0300 |
commit | 44a94bb28605bec406f415ef66fc332c265f7c9a (patch) | |
tree | dd392c41bdcddf53fe08289d01ea6f1c7617c5cd /documentation/components | |
parent | f548cfa87625c970be4f10efe18a10763495a51a (diff) | |
download | vaadin-framework-44a94bb28605bec406f415ef66fc332c265f7c9a.tar.gz vaadin-framework-44a94bb28605bec406f415ef66fc332c265f7c9a.zip |
Revised client-side arch, Java Servlet, new project, view navigation, and basic UI schematic diagrams (#19897). Mostly disabled and rearranged Table section, etc.
Change-Id: Iedcd7bfc04c53b7d1cdf621261234688d21a52f3
Diffstat (limited to 'documentation/components')
4 files changed, 31 insertions, 15 deletions
diff --git a/documentation/components/chapter-components.asciidoc b/documentation/components/chapter-components.asciidoc index 36e0287e30..b1a0c6cf9d 100644 --- a/documentation/components/chapter-components.asciidoc +++ b/documentation/components/chapter-components.asciidoc @@ -44,14 +44,14 @@ include::components-optiongroup.asciidoc[leveloffset=+2] include::components-twincolselect.asciidoc[leveloffset=+2] +include::components-grid.asciidoc[leveloffset=+2] + include::components-table.asciidoc[leveloffset=+2] include::components-tree.asciidoc[leveloffset=+2] include::components-treetable.asciidoc[leveloffset=+2] -include::components-grid.asciidoc[leveloffset=+2] - include::components-menubar.asciidoc[leveloffset=+2] include::components-upload.asciidoc[leveloffset=+2] diff --git a/documentation/components/components-calendar.asciidoc b/documentation/components/components-calendar.asciidoc index 6b56483882..20926523cb 100644 --- a/documentation/components/components-calendar.asciidoc +++ b/documentation/components/components-calendar.asciidoc @@ -17,7 +17,7 @@ events. The main features of the calendar include: * Monthly, weekly, and daily views * Two types of events: all-day events and events with a time range -* Add events directly, from a [classname]#Container#, or with an event provider +* Add events directly or with an event provider * Control the range of the visible dates * Selecting and editing date or time range by dragging * Drag and drop events to calendar @@ -33,8 +33,7 @@ ifdef::web[handlers, as described in <<components.calendar.customizing>>.] ifndef::web[handlers.] The data source of a calendar can be practically anything, as its events are -queried dynamically by the component. You can bind the calendar to a Vaadin -container, or to any other data source by implementing an __event provider__. +queried dynamically by the component. You can bind the calendar to any data source by implementing an __event provider__. The [classname]#Calendar# has undefined size by default and you usually want to give it a fixed or relative size, for example as follows. @@ -103,7 +102,6 @@ All occurrences in a calendar are represented as __events__. You have three ways to manage the calendar events: * Add events directly to the [classname]#Calendar# object using the [methodname]#addEvent()# -* Use a [interfacename]#Container# as a data source * Use the __event provider__ mechanism You can add events with [methodname]#addEvent()# and remove them with the @@ -125,12 +123,13 @@ are queried by the [classname]#Calendar# from the provider that just has to implement the [interfacename]#CalendarEventProvider# interface. It is up to the event provider that [classname]#Calendar# gets the correct events. +ifdef::vaadin7[] You can bind any Vaadin [classname]#Container# to a calendar, in which case a [classname]#ContainerEventProvider# is used transparently. The container must be ordered by start date and time of the events. See <<dummy/../../../framework/datamodel/datamodel-container#datamodel.container,"Collecting Items in Containers">> for basic information about containers. - +endif::vaadin7[] [[components.calendar.events.details]] === Event Types @@ -184,8 +183,7 @@ BasicEvent implement some optional event interfaces provided by the calendar package, there is no need to refresh the calendar. Just create events, set their properties and add them to the Event Provider. - - +ifdef::vaadin7[] [[components.calendar.container]] == Getting Events from a Container @@ -311,8 +309,8 @@ BasicEvent event = new BasicEvent("The Event", "Single Event", new GregorianCalendar(2012,1,15,14,00).getTime()); calendar.addEvent(event); ---- - endif::web[] +endif::vaadin7[] ifdef::web[] diff --git a/documentation/components/components-fields.asciidoc b/documentation/components/components-fields.asciidoc index 85afaafe56..173544dfe7 100644 --- a/documentation/components/components-fields.asciidoc +++ b/documentation/components/components-fields.asciidoc @@ -24,13 +24,19 @@ addition to the component features inherited from [classname]#AbstractComponent#, it implements the features defined in the [classname]#HasValue# and [classname]#Component.Focusable# interfaces. -The description of the field interfaces and base classes is broken down in the -following sections. - [[figure.components.fields.hasvalue]] .Field components having values image::img/field-interface-v8-hi.png[width=60%, scaledwidth=100%] +///////////////////////////////////////////////////////////////////////////// +// Disabled because everything has changed in Vaadin 8. +// Revise +///////////////////////////////////////////////////////////////////////////// +ifdef::disabled[] + +The description of the field interfaces and base classes is broken down in the +following sections. + [[components.fields.field]] == The [classname]#Field# Interface @@ -337,4 +343,6 @@ Forms by Binding Fields to Items">>, calling [methodname]#commit()# for the group runs the validation for all the fields in the group, and if successful, writes the input values to the data source. +endif::disabled[] + (((range="endofrange", startref="term.components.fields"))) diff --git a/documentation/components/components-table.asciidoc b/documentation/components/components-table.asciidoc index d1839a8ac0..25abb2263c 100644 --- a/documentation/components/components-table.asciidoc +++ b/documentation/components/components-table.asciidoc @@ -14,6 +14,13 @@ endif::web[] ((("[classname]#Table#", id="term.components.table", range="startofrange"))) +[NOTE] +==== +[classname]#Table# is largely obsolete and has been replaced by the newer [classname]#Grid# component. +Nevertheless, it still has some features, such as drag and drop, which have no counterpart in Grid. +Table also still uses the old data API. +Hence, only a short introduction is given below; see the online Vaadin Docs for more details. +==== The [classname]#Table# component is intended for presenting tabular data organized in rows and columns. The [classname]#Table# is one of the most @@ -21,6 +28,9 @@ versatile components in Vaadin. Table cells can include text or arbitrary UI components. You can easily implement editing of the table data, for example clicking on a cell could change it to a text field for editing. +.Basic Table Example +image::img/table-example1.png[width=35%, scaledwidth=50%] + The data contained in a [classname]#Table# is managed using the Vaadin data model (see <<dummy/../../../framework/datamodel/datamodel-overview.asciidoc#datamodel.overview,"Binding Components to Data">>), through the [classname]#Container# interface of the [classname]#Table#. This makes it possible to bind a table directly to a data source, such as a database query. Only the visible part of the table is loaded @@ -72,8 +82,7 @@ rows are given simply as object arrays, in the same order in which the properties were added. The objects must be of the correct class, as defined in the [methodname]#addContainerProperty()# calls. -.Basic Table Example -image::img/table-example1.png[width=35%, scaledwidth=50%] +ifdef::vaadin7[] Scalability of the [classname]#Table# is largely dictated by the container. The default [classname]#IndexedContainer# is relatively heavy and can cause @@ -1152,5 +1161,6 @@ image::img/table-cellstylegenerator1.png[width=50%, scaledwidth=80%] endif::web[] +endif::vaadin7[] (((range="endofrange", startref="term.components.table"))) |