aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoonas Lehtinen <joonas.lehtinen@itmill.com>2007-01-03 11:44:15 +0000
committerJoonas Lehtinen <joonas.lehtinen@itmill.com>2007-01-03 11:44:15 +0000
commitbbaef9ac6e26cf0a3d8a8746fc2943be50acc95a (patch)
tree7b88bf62f1dc1c932c74907d506e5656295951c3
parente7d4dcac774417b7bfa50ac858bc4021296bb7ef (diff)
downloadvaadin-framework-bbaef9ac6e26cf0a3d8a8746fc2943be50acc95a.tar.gz
vaadin-framework-bbaef9ac6e26cf0a3d8a8746fc2943be50acc95a.zip
javadoc updates
svn changeset:214/svn branch:toolkit
-rw-r--r--src/com/itmill/toolkit/data/package.html30
-rw-r--r--src/com/itmill/toolkit/data/util/package.html18
-rw-r--r--src/com/itmill/toolkit/event/package.html10
-rw-r--r--src/com/itmill/toolkit/package.html14
-rw-r--r--src/com/itmill/toolkit/ui/package.html22
5 files changed, 47 insertions, 47 deletions
diff --git a/src/com/itmill/toolkit/data/package.html b/src/com/itmill/toolkit/data/package.html
index 6a2ed18f37..2263ab459a 100644
--- a/src/com/itmill/toolkit/data/package.html
+++ b/src/com/itmill/toolkit/data/package.html
@@ -5,14 +5,14 @@
<body bgcolor="white">
-<p>Provides interfaces for the MillStone data layer which contains classes
+<p>Provides interfaces for the data layer which contains classes
for typed data values, data collections, and handlers. A
-{@link org.millstone.base.data.Property Property} is a simple typed data
-value; an {@link org.millstone.base.data.Item Item} is a collection of
+{@link com.itmill.toolkit.data.Property Property} is a simple typed data
+value; an {@link com.itmill.toolkit.data.Item Item} is a collection of
Properties, each corresponding to a unique identifier; a
-{@link org.millstone.base.data.Container Container} is a collection of
+{@link com.itmill.toolkit.data.Container Container} is a collection of
identified Items with special constraints; a
-{@link org.millstone.base.data.Buffered Buffered} class is able to track
+{@link com.itmill.toolkit.data.Buffered Buffered} class is able to track
its changes and to commit or discard them later.</p>
<h2>Package Specification</h2>
@@ -28,17 +28,17 @@ collections of them:</p>
<ul>
<li>The simplest of these is the
- {@link org.millstone.base.data.Property Property} which represents a
+ {@link com.itmill.toolkit.data.Property Property} which represents a
single typed data value. A Property may be read-only in which
case attempts to modify its contents will throw an exception.
<li>The second level of the data layer is represented by the
- {@link org.millstone.base.data.Item Item} which embodies a set of
+ {@link com.itmill.toolkit.data.Item Item} which embodies a set of
<i>Properties</i>. Each Property in an Item corresponds to a locally
unique(that is, inside the Item) identifier.
<li>The third level is called the
- {@link org.millstone.base.data.Container Container} which can be
+ {@link com.itmill.toolkit.data.Container Container} which can be
visualized as a set of Items, each corresponding to a locally unique
identifier. Note that the Container imposes a few restrictions on the
data stored in it, see further documentation in the
@@ -46,19 +46,19 @@ collections of them:</p>
</ul>
<p>In addition to these interfaces the package contains the
-{@link org.millstone.base.data.Buffered Buffered} interface, which defines
+{@link com.itmill.toolkit.data.Buffered Buffered} interface, which defines
the methods to make an object buffered, that is, track the changes to an
object and allow committing or discarding them at a later time.</p>
-<p>Provides interfaces for the MillStone validation framework. The framework
+<p>Provides interfaces for the validation framework. The framework
defines two interfaces; one for classes that need to support external
validation, and another one for the validators themselves.</p>
<h2>Validation</h2>
<p>The most important method defined by the
-{@link org.millstone.base.data.Validatable Validatable} interface is
-{@link org.millstone.base.data.Validatable#isValid() isValid()}. It
+{@link com.itmill.toolkit.data.Validatable Validatable} interface is
+{@link com.itmill.toolkit.data.Validatable#isValid() isValid()}. It
asks all registered validators to verify if the object's value is valid
or not. Note that it depends on the validators registered for a object which
values are valid and which are not. For example, a <code>null</code> value
@@ -67,18 +67,18 @@ can be valid value for one validator but invalid for another.<p>
<p>In addition to <code>isValid()</code>, <code>Validatable</code> defines
methods to add, remove and list validators of a validatable object.</p>
-<p>{@link org.millstone.base.data.Validator Validator} defines the
+<p>{@link com.itmill.toolkit.data.Validator Validator} defines the
interface for an external validator. These validators may be added to
any <code>Validatable</code> object, and their task is to check, when
requested, that the object which they are attached to contains a valid
value. The actual validation logic is hidden in the
-{@link org.millstone.base.data.Validator#validate(Object) validate(Object)}
+{@link com.itmill.toolkit.data.Validator#validate(Object) validate(Object)}
method.</p>
<p>In addition to <code>check(Object)</code>, <code>Validator</code> defines
the <code>InvalidValueException</code> which is used to signal that a
checked value is invalid, and the
-{@link org.millstone.base.data.Validator.Suggestive Suggestive}
+{@link com.itmill.toolkit.data.Validator.Suggestive Suggestive}
subinterface which includes functionality to suggest a valid value for
the validated object.</p><!-- Put @see and @since tags down here. -->
diff --git a/src/com/itmill/toolkit/data/util/package.html b/src/com/itmill/toolkit/data/util/package.html
index 499439a16c..3148c89d4a 100644
--- a/src/com/itmill/toolkit/data/util/package.html
+++ b/src/com/itmill/toolkit/data/util/package.html
@@ -6,24 +6,24 @@
<body bgcolor="white">
-<p>Provides various utility classes that implement the MillStone data layer
+<p>Provides various utility classes that implement the data layer
functionality.</p>
-<p>The first {@link org.millstone.base.data.Property Property} class,
-{@link org.millstone.base.data.util.ObjectProperty ObjectProperty}, provides
+<p>The first {@link com.itmill.toolkit.data.Property Property} class,
+{@link com.itmill.toolkit.data.util.ObjectProperty ObjectProperty}, provides
a simple class containing a typed data value. The second,
-{@link org.millstone.base.data.util.MethodProperty MethodProperty}, provides
+{@link com.itmill.toolkit.data.util.MethodProperty MethodProperty}, provides
a way to bind a field of an object to the Property interface using the
accessor methods for the field.</p>
-<p>The next level of the MillStone data layer, the
-{@link org.millstone.base.data.Item Item}, is implemented by
-{@link org.millstone.base.data.util.BeanItem BeanItem}, though it is only a
+<p>The next level of the data layer, the
+{@link com.itmill.toolkit.data.Item Item}, is implemented by
+{@link com.itmill.toolkit.data.util.BeanItem BeanItem}, though it is only a
simple wrapper to the former to provide the Item interface for any regular
Java Bean.</p>
-<p>The third level, the {@link org.millstone.base.data.Container Container},
-has several implementations in the {@link org.millstone.base.data.util}
+<p>The third level, the {@link com.itmill.toolkit.data.Container Container},
+has several implementations in the {@link com.itmill.toolkit.data.util}
package.</p>
<!-- <h2>Package Specification</h2> -->
diff --git a/src/com/itmill/toolkit/event/package.html b/src/com/itmill/toolkit/event/package.html
index bd1faf7e89..aed4f0f052 100644
--- a/src/com/itmill/toolkit/event/package.html
+++ b/src/com/itmill/toolkit/event/package.html
@@ -11,13 +11,13 @@
model. The model supports inheritable events and a flexible way of
registering and unregistering event listeners. It's a fundamental building
block of the MillStone framework, and as it is included in
-{@link org.millstone.base.ui.AbstractComponent}, all UI components
+{@link com.itmill.toolkit.ui.AbstractComponent}, all UI components
automatically support it.</p>
<h2>Package Specification</h2>
<p>The core of the MillStone event model is the inheritable event class
-hierarchy, and the {@link org.millstone.base.event.EventRouter EventRouter}
+hierarchy, and the {@link com.itmill.toolkit.event.EventRouter EventRouter}
which provide a simple, ubiquitous mechanism to transport events to all
interested parties.</p>
@@ -42,13 +42,13 @@ 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 org.millstone.base.event.MethodEventSource MethodEventSource}, and a
+{@link com.itmill.toolkit.event.MethodEventSource MethodEventSource}, and a
straightforward implementation of it is defined in
-{@link org.millstone.base.event.EventRouter EventRouter} which also includes
+{@link com.itmill.toolkit.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 org.millstone.base.event.ListenerMethod ListenerMethod}. The
+type {@link com.itmill.toolkit.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>
diff --git a/src/com/itmill/toolkit/package.html b/src/com/itmill/toolkit/package.html
index 2c956f151a..d731f0ce0f 100644
--- a/src/com/itmill/toolkit/package.html
+++ b/src/com/itmill/toolkit/package.html
@@ -14,19 +14,19 @@ The sub-packages from this point contain application components and utilities.
<b>The Millstone library base is composed of the following packages:</b>
<dl>
- <dt>org.millstone.base.data</dt>
+ <dt>com.itmill.toolkit.data</dt>
<dd>A library of interfaces for transparently binding UI components to datasources.</dd>
- <dt>org.millstone.base.data.util</dt>
+ <dt>com.itmill.toolkit.data.util</dt>
<dd>Basic implementations of data-intfaces and utidtties for working with data-bound components.</dd>
- <dt>org.millstone.base.data.vadtdator</dt>
+ <dt>com.itmill.toolkit.data.vadtdator</dt>
<dd>Classes providing data-vadtdation for Properties.</dd>
- <dt>org.millstone.base.event</dt>
+ <dt>com.itmill.toolkit.event</dt>
<dd>Interfaces defining how to send and recieve events.</dd>
- <dt>org.millstone.base.service</dt>
+ <dt>com.itmill.toolkit.service</dt>
<dd>Classes provding miscelaneous utidtty services.</dd>
- <dt>org.millstone.base.terminal</dt>
+ <dt>com.itmill.toolkit.terminal</dt>
<dd>Classes and interfaces for implementing the terminal specific adapters.</dd>
- <dt>org.millstone.base.ui</dt>
+ <dt>com.itmill.toolkit.ui</dt>
<dd>The Millstone UI components.</dd>
</dl>
diff --git a/src/com/itmill/toolkit/ui/package.html b/src/com/itmill/toolkit/ui/package.html
index de5cd3171c..aa30b19b61 100644
--- a/src/com/itmill/toolkit/ui/package.html
+++ b/src/com/itmill/toolkit/ui/package.html
@@ -23,22 +23,22 @@ package includes several other lesser subinterfaces 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 org.millstone.base.ui.Component} interface is the top-level
+<p>The {@link com.itmill.toolkit.ui.Component} interface is the top-level
interface which must be implemented by all UI components. It defines the
common properties of the components and how the framework will handle
-them. Most simple components (like {@link org.millstone.base.ui.Button} for
+them. Most simple components (like {@link com.itmill.toolkit.ui.Button} for
example} won't need to implement the lower level interfaces described
below. Note that the classes and interfaces required by the component event
-framework are defined in {@link org.millstone.base.ui.Component}.</p>
+framework are defined in {@link com.itmill.toolkit.ui.Component}.</p>
<p>The next level in the component hierarchy are the classes implementing
-the {@link org.millstone.base.ui.ComponentContainer} interface. It adds the
+the {@link com.itmill.toolkit.ui.ComponentContainer} interface. It adds the
capacity to contain other components to
-{@link org.millstone.base.ui.Component} with a simple API.</p>
+{@link com.itmill.toolkit.ui.Component} with a simple API.</p>
-<p>The third and last level is the {@link org.millstone.base.ui.Layout},
+<p>The third and last level is the {@link com.itmill.toolkit.ui.Layout},
which adds the concept of location to the components contained in a
-{@link org.millstone.base.ui.ComponentContainer}. It can be used to create
+{@link com.itmill.toolkit.ui.ComponentContainer}. It can be used to create
containers whose contents can be positioned arbitrarily.</p>
<p><strong>Component class hierarchy</strong></p>
@@ -49,17 +49,17 @@ containers whose contents can be positioned arbitrarily.</p>
<center><i>Underlined classes are abstract.</i></center>
-<p>At the top level is {@link org.millstone.base.ui.AbstractComponent}
-which implements the {@link org.millstone.base.ui.Component} interface. As
+<p>At the top level is {@link com.itmill.toolkit.ui.AbstractComponent}
+which implements the {@link com.itmill.toolkit.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 org.millstone.base.ui.AbstractComponentContainer} serves
+extensions. {@link com.itmill.toolkit.ui.AbstractComponentContainer} serves
as the root class for all components (for example, panels and windows) who
-can contain other components. {@link org.millstone.base.ui.AbstractField},
+can contain other components. {@link com.itmill.toolkit.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>