diff options
| author | Artur Signell <artur@vaadin.com> | 2016-08-19 08:17:51 +0300 |
|---|---|---|
| committer | Artur Signell <artur@vaadin.com> | 2016-08-19 11:40:58 +0300 |
| commit | 2a4e2b12aa818c5d3bd28ee346fba11799cb6c68 (patch) | |
| tree | 93d3c501149d795aeef5f94b8eee3d79385ce37a | |
| parent | 9b2b19366c77f164dbb54d057373713a02447984 (diff) | |
| download | vaadin-framework-2a4e2b12aa818c5d3bd28ee346fba11799cb6c68.tar.gz vaadin-framework-2a4e2b12aa818c5d3bd28ee346fba11799cb6c68.zip | |
Remove package javadocs as they are all out of date
Change-Id: Ie3210997959923f70fbb73be4e9672827366d35a
8 files changed, 0 insertions, 282 deletions
diff --git a/server/src/main/javadoc/com/vaadin/annotations/package.html b/server/src/main/javadoc/com/vaadin/annotations/package.html deleted file mode 100644 index d789e9b5df..0000000000 --- a/server/src/main/javadoc/com/vaadin/annotations/package.html +++ /dev/null @@ -1,12 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> - -<body bgcolor="white"> - -<p>Contains annotations used in Vaadin. Note that some annotations -are also found in other packages e.g., {@link com.vaadin.ui.ClientWidget}.</p> - -</body> -</html> diff --git a/server/src/main/javadoc/com/vaadin/data/package.html b/server/src/main/javadoc/com/vaadin/data/package.html deleted file mode 100644 index ba576b6200..0000000000 --- a/server/src/main/javadoc/com/vaadin/data/package.html +++ /dev/null @@ -1,49 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> - -<body bgcolor="white"> - -<p>Contains interfaces for the data layer, mainly for binding typed -data and data collections to components, and for validating data.</p> - -<h2>Data binding</h2> - -<p>The package contains a three-tiered structure for typed data -objects and collections of them:</p> - -<ul> - <li>A {@link com.vaadin.data.Property Property} represents a - single, typed data value. - - <li>An {@link com.vaadin.data.Item Item} embodies a set of <i>Properties</i>. - A locally unique (inside the {@link com.vaadin.data.Item Item}) - Property identifier corresponds to each Property inside the Item.</li> - <li>A {@link com.vaadin.data.Container Container} contains a set - of Items, each corresponding to a locally unique Item identifier. Note - that Container imposes a few restrictions on the data stored in it, see - {@link com.vaadin.data.Container Container} for further information.</li> -</ul> - -<p>For more information on the data model, see the <a - href="http://vaadin.com/book/-/page/datamodel.html">Data model -chapter</a> in Book of Vaadin.</p> - -<h2>Buffering</h2> - -<p>A {@link com.vaadin.data.Buffered Buffered} implementor is able -to track and buffer changes and commit or discard them later.</p> - -<h2>Validation</h2> - -<p>{@link com.vaadin.data.Validator Validator} implementations are -used to validate data, typically the value of a {@link -com.vaadin.v7.ui.LegacyField LegacyField}. One or more {@link com.vaadin.data.Validator -Validators} can be added to a {@link com.vaadin.data.Validatable -Validatable} implementor and then used to validate the value of the -Validatable. </p> - -<!-- Put @see and @since tags down here. --> -</body> -</html> diff --git a/server/src/main/javadoc/com/vaadin/data/util/package.html b/server/src/main/javadoc/com/vaadin/data/util/package.html deleted file mode 100644 index 07e3acde9e..0000000000 --- a/server/src/main/javadoc/com/vaadin/data/util/package.html +++ /dev/null @@ -1,18 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> - -</head> - -<body bgcolor="white"> - -<p>Provides implementations of Property, Item and Container -interfaces, and utilities for the data layer.</p> - -<p>Various Property, Item and Container implementations are provided -in this package. Each implementation can have its own sets of -constraints on the data it encapsulates and on how the implementation -can be used. See the class javadocs for more information.</p> - -</body> -</html> diff --git a/server/src/main/javadoc/com/vaadin/data/validator/package.html b/server/src/main/javadoc/com/vaadin/data/validator/package.html deleted file mode 100644 index c991bfc82a..0000000000 --- a/server/src/main/javadoc/com/vaadin/data/validator/package.html +++ /dev/null @@ -1,23 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> - -</head> - -<body bgcolor="white"> - -<!-- Package summary here --> - -<p>Provides various {@link com.vaadin.data.Validator} -implementations.</p> - -<p>{@link com.vaadin.data.validator.AbstractValidator -AbstractValidator} provides an abstract implementation of the {@link -com.vaadin.data.Validator} interface and can be extended for custom -validation needs. {@link -com.vaadin.data.validator.AbstractStringValidator -AbstractStringValidator} can also be extended if the value is a String.</p> - - -</body> -</html> diff --git a/server/src/main/javadoc/com/vaadin/event/package.html b/server/src/main/javadoc/com/vaadin/event/package.html deleted file mode 100644 index 2e7e17b892..0000000000 --- a/server/src/main/javadoc/com/vaadin/event/package.html +++ /dev/null @@ -1,58 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> - -<body bgcolor="white"> - -<!-- Package summary here --> - -<p>Provides classes and interfaces for the inheritable event -model. The model supports inheritable events and a flexible way of -registering and unregistering event listeners. It's a fundamental building -block of Vaadin, and as it is included in -{@link com.vaadin.ui.AbstractComponent}, all UI components -automatically support it.</p> - -<h2>Package Specification</h2> - -<p>The core of the event model is the inheritable event class -hierarchy, and the {@link com.vaadin.event.EventRouter EventRouter} -which provide a simple, ubiquitous mechanism to transport events to all -interested parties.</p> - -<p>The power of the event inheritance arises from the possibility of -receiving not only the events of the registered type, <i>but also the -ones which are inherited from it</i>. For example, let's assume that there -are the events <code>GeneralEvent</code> and <code>SpecializedEvent</code> -so that the latter inherits the former. Furthermore we have an object -<code>A</code> which registers to receive <code>GeneralEvent</code> type -events from the object <code>B</code>. <code>A</code> would of course -receive all <code>GeneralEvent</code>s generated by <code>B</code>, but in -addition to this, <code>A</code> would also receive all -<code>SpecializedEvent</code>s generated by <code>B</code>. However, if -<code>B</code> generates some other events that do not have -<code>GeneralEvent</code> as an ancestor, <code>A</code> would not receive -them unless it registers to listen for them, too.</p> - -<p>The interface to attaching and detaching listeners to and from an object -works with methods. One specifies the event that should trigger the listener, -the trigger method that should be called when a suitable event occurs and the -object owning the method. From these a new listener is constructed and added -to the event router of the specified component.</p> - -<p>The interface is defined in -{@link com.vaadin.event.MethodEventSource MethodEventSource}, and a -straightforward implementation of it is defined in -{@link com.vaadin.event.EventRouter EventRouter} which also includes -a method to actually fire the events.</p> - -<p>All fired events are passed to all registered listeners, which are of -type {@link com.vaadin.event.ListenerMethod ListenerMethod}. The -listener then checks if the event type matches with the specified event -type and calls the specified trigger method if it does.</p> - -<!-- Put @see and @since tags down here. --> - -</body> -</html> diff --git a/server/src/main/javadoc/com/vaadin/package.html b/server/src/main/javadoc/com/vaadin/package.html deleted file mode 100644 index 097fd94aca..0000000000 --- a/server/src/main/javadoc/com/vaadin/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> - -<body bgcolor="white"> - - <p>The Vaadin base package. Contains the Application class, the - starting point of any application that uses Vaadin.</p> - - <p>Contains all Vaadin core classes. A Vaadin application is based - on the {@link com.vaadin.Application} class and deployed as a servlet - using {@link com.vaadin.server.ApplicationServlet} or {@link - com.vaadin.server.GAEApplicationServlet} (for Google App Engine).</p> - - <p>Vaadin applications can also be deployed as portlets using - {@link com.vaadin.server.ApplicationPortlet2} (JSR-286).</p> - - <p>All classes in Vaadin are serializable unless otherwise noted. - This allows Vaadin applications to run in cluster and cloud - environments.</p> - - -</body> -</html> diff --git a/server/src/main/javadoc/com/vaadin/server/package.html b/server/src/main/javadoc/com/vaadin/server/package.html deleted file mode 100644 index 83514a0de5..0000000000 --- a/server/src/main/javadoc/com/vaadin/server/package.html +++ /dev/null @@ -1,21 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> - -</head> - -<body bgcolor="white"> - -<!-- Package summary here --> - -<p>Provides classes and interfaces that wrap the terminal-side functionalities -for the server-side application. (FIXME: This could be a little more descriptive and wordy.)</p> - -<h2>Package Specification</h2> - -<!-- Package spec here --> - -<!-- Put @see and @since tags down here. --> - -</body> -</html> diff --git a/server/src/main/javadoc/com/vaadin/ui/package.html b/server/src/main/javadoc/com/vaadin/ui/package.html deleted file mode 100644 index 6b19a28fe7..0000000000 --- a/server/src/main/javadoc/com/vaadin/ui/package.html +++ /dev/null @@ -1,76 +0,0 @@ -<!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> |