diff options
| author | Artur Signell <artur@vaadin.com> | 2012-08-13 18:34:33 +0300 |
|---|---|---|
| committer | Artur Signell <artur@vaadin.com> | 2012-08-13 19:18:33 +0300 |
| commit | e85d933b25cc3c5cc85eb7eb4b13b950fd8e1569 (patch) | |
| tree | 9ab6f13f7188cab44bbd979b1cf620f15328a03f /server/src/com/vaadin/ui/package.html | |
| parent | 14dd4d0b28c76eb994b181a4570f3adec53342e6 (diff) | |
| download | vaadin-framework-e85d933b25cc3c5cc85eb7eb4b13b950fd8e1569.tar.gz vaadin-framework-e85d933b25cc3c5cc85eb7eb4b13b950fd8e1569.zip | |
Moved server files to a server src folder (#9299)
Diffstat (limited to 'server/src/com/vaadin/ui/package.html')
| -rw-r--r-- | server/src/com/vaadin/ui/package.html | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/server/src/com/vaadin/ui/package.html b/server/src/com/vaadin/ui/package.html new file mode 100644 index 0000000000..6b19a28fe7 --- /dev/null +++ b/server/src/com/vaadin/ui/package.html @@ -0,0 +1,76 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> + +</head> + +<body bgcolor="white"> + +<!-- Package summary here --> + +<p>Provides interfaces and classes in Vaadin.</p> + +<h2>Package Specification</h2> + +<p><strong>Interface hierarchy</strong></p> + +<p>The general interface hierarchy looks like this:</p> + +<p style="text-align: center;"><img + src="doc-files/component_interfaces.gif" /></p> + +<p><i>Note that the above picture includes only the main +interfaces. This package includes several other lesser sub-interfaces +which are not significant in this scope. The interfaces not appearing +here are documented with the classes that define them.</i></p> + +<p>The {@link com.vaadin.ui.Component} interface is the top-level +interface which must be implemented by all user interface components in +Vaadin. It defines the common properties of the components and how the +framework will handle them. Most simple components, such as {@link +com.vaadin.ui.Button}, for example, do not need to implement the +lower-level interfaces described below. Notice that also the classes and +interfaces required by the component event framework are defined in +{@link com.vaadin.ui.Component}.</p> + +<p>The next level in the component hierarchy are the classes +implementing the {@link com.vaadin.ui.ComponentContainer} interface. It +adds the capacity to contain other components to {@link +com.vaadin.ui.Component} with a simple API.</p> + +<p>The third and last level is the {@link com.vaadin.ui.Layout}, +which adds the concept of location to the components contained in a +{@link com.vaadin.ui.ComponentContainer}. It can be used to create +containers which contents can be positioned.</p> + +<p><strong>Component class hierarchy</strong></p> + +<p>The actual component classes form a hierarchy like this:</p> + +<center><img src="doc-files/component_class_hierarchy.gif" /></center> +<br /> + +<center><i>Underlined classes are abstract.</i></center> + +<p>At the top level is {@link com.vaadin.ui.AbstractComponent} which +implements the {@link com.vaadin.ui.Component} interface. As the name +suggests it is abstract, but it does include a default implementation +for all methods defined in <code>Component</code> so that a component is +free to override only those functionalities it needs.</p> + +<p>As seen in the picture, <code>AbstractComponent</code> serves as +the superclass for several "real" components, but it also has a some +abstract extensions. {@link com.vaadin.ui.AbstractComponentContainer} +serves as the root class for all components (for example, panels and +windows) who can contain other components. {@link +com.vaadin.ui.AbstractField}, on the other hand, implements several +interfaces to provide a base class for components that are used for data +display and manipulation.</p> + + +<!-- Package spec here --> + +<!-- Put @see and @since tags down here. --> + +</body> +</html> |