Package com.itmill.toolkit.ui

Provides interfaces and classes in the IT Mill Toolkit.

See:
Description

Interface Summary

AbstractComponent.ComponentErrorEvent
AbstractComponent.ComponentErrorHandler
AbstractSelect.Filtering	Interface for option filtering, used to filter options based on user entered value.
AbstractSelect.NewItemHandler
Button.ClickListener	Button click listener
Component	The top-level component interface which must be implemented by all UI components that use IT Mill Toolkit.
Component.ErrorListener	Listener interface for receiving Component.Errorss.
Component.Focusable	Interface implemented by components which can obtain input focus.
Component.Listener	Listener interface for receiving Component.Events.
ComponentContainer	Extension to the Component interface which adds to it the capacity to contain other components.
ComponentContainer.ComponentAttachListener	Component attach listener interface.
ComponentContainer.ComponentDetachListener	Component detach listener interface.
Field
FieldFactory	Factory for creating new Field-instances based on type, datasource and/or context.
Layout	Extension to the ComponentContainer interface which adds the layouting control to the elements in the container.
Layout.AlignmentHandler	TODO make javadocs, remove from implementing classes
Layout.SpacingHandler	This type of layout can set spacing between its components on of off.
LoginForm.LoginListener	Login listener is a class capable to listen LoginEvents sent from LoginBox
Table.CellStyleGenerator	Allow to define specific style on cells (and rows) contents.
Table.ColumnGenerator	Used to create "generated columns"; columns that exist only in the Table, not in the underlying Container.
TabSheet.SelectedTabChangeListener	Selected Tab Change Event listener
Tree.CollapseListener	Collapse event listener.
Tree.ExpandListener	Expand event listener.
Upload.FailedListener	Receives events when the uploads are finished, but unsuccessful.
Upload.FinishedListener	Receives the events when the uploads are ready.
Upload.ProgressListener	ProgressListener receives events to track progress of upload.
Upload.Receiver	Interface that must be implemented by the upload receivers to provide the Upload component an output stream to write the uploaded data.
Upload.StartedListener	Receives the events when the upload starts.
Upload.SucceededListener	Receives events when the uploads are successfully finished.
Window.CloseListener

Class Summary

AbstractComponent	An abstract class that defines default implementation for the Component interface.
AbstractComponentContainer	Extension to AbstractComponent that defines the default implementation for the methods in ComponentContainer.
AbstractField	Abstract field component for implementing buffered property editors.
AbstractLayout	An abstract class that defines default implementation for the Layout interface.
AbstractSelect	A class representing a selection of items the user has selected in a UI.
Accordion
BaseFieldFactory	Default implementation of the the following Field types are used by default: Boolean: Button(switchMode:true).
Button	A generic button component.
CheckBox
ComboBox	A filtering dropdown single-select.
Component.ErrorEvent	Class of all component originated ErrorEvents.
Component.Event	Superclass of all component originated Events.
ComponentContainer.ComponentAttachEvent	Component attach event sent when a component is attached to container.
ComponentContainer.ComponentDetachEvent	Component detach event sent when a component is detached from container.
CustomComponent	Custom component provides simple implementation of Component interface for creation of new UI components by composition of existing components.
CustomLayout	A container component with freely designed layout and style.
DateField	A date editor component that can be bound to any bindable Property. that is compatible with java.util.Date.
Embedded	Component for embedding external objects.
ExpandLayout	A layout that will give one of it's components as much space as possible, while still showing the other components in the layout.
Field.ValueChangeEvent	An Event object specifying the Field whose value has been changed.
Form	Form component provides easy way of creating and managing sets fields.
FormLayout
GridLayout	A container that consists of components with certain coordinates (cell position) on a grid.
InlineDateField	A date entry component, which displays the actual date selector inline.
Label	Label component for showing non-editable short texts.
Link	Link is used to create external or internal URL links.
ListSelect	This is a simple list select without, for instance, support for new items, lazyloading, and other advanced features.
LoginForm	LoginForm is a Toolkit component to handle common problem among Ajax applications: browsers password managers don't fill dynamically created forms like all those UI elements created by IT Mill Toolkit.
NativeSelect	This is a simple drop-down select without, for instance, support for multiselect, new items, lazyloading, and other advanced features.
OptionGroup	Configures select to be used as an option group.
OrderedLayout	Ordered layout.
Panel	Panel - a simple single component container.
PopupDateField	A date entry component, which displays the actual date selector as a popup.
ProgressIndicator	ProgressIndicator is component that shows user state of a process (like long computing or file upload) ProgressIndicator has two mainmodes.
RichTextArea	TODO dont' allow getting into bad state TODO implement Sizeable interface
Select	A class representing a selection of items the user has selected in a UI.
Slider	TODO comment Example code: class MyPlayer extends CustomComponent implements ValueChangeListener { Label volumeIndicator = new Label(); Slider slider; public MyPlayer() { OrderedLayout ol = new OrderedLayout(); setCompositionRoot(ol); slider = new Slider("Volume", 0, 100); slider.setImmediate(true); ol.addComponent(slider); ol.addComponent(volumeIndicator); volumeIndicator.setValue(new Double(50)); slider.addListener(this); } public void setVolume(double d) { volumeIndicator.setValue("Current volume : " + d); } public void valueChange(ValueChangeEvent event) { Double d = (Double) event.getProperty().getValue(); setVolume(d.doubleValue()); } }
SplitPanel	SplitPanel.
Table	TableComponent is used for representing data or components in pageable and selectable table.
TabSheet	Tabsheet component.
TextField	A text editor component that can be bound to any bindable Property.
Tree	MenuTree component.
TwinColSelect	Multiselect component with two lists: left side for available items and right side for selected items.
Upload	Component for uploading files from client to server.
Window	Application window component.
Window.Notification	A notification message, used to display temporary messages to the user - for example "Document saved", or "Save failed".

Exception Summary

Package com.itmill.toolkit.ui Description

Provides interfaces and classes in the IT Mill Toolkit.

Package Specification

Interface hierarchy

The general interface hierarchy looks like this:

Note that the above picture includes only the main interfaces. This 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.

The {@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 Component.

The next level in the component hierarchy are the classes implementing the ComponentContainer interface. It adds the capacity to contain other components to Component with a simple API.

The third and last level is the Layout, which adds the concept of location to the components contained in a ComponentContainer. It can be used to create containers whose contents can be positioned arbitrarily.

Component class hierarchy

The actual component classes form a hierarchy like this:

Underlined classes are abstract.

At the top level is AbstractComponent which implements the Component interface. As the name suggests it is abstract, but it does include a default implementation for all methods defined in Component so that a component is free to override only those functionalities it needs.

As seen in the picture, AbstractComponent serves as the superclass for several "real" components, but it also has a some abstract extensions. AbstractComponentContainer serves as the root class for all components (for example, panels and windows) who can contain other components. AbstractField, on the other hand, implements several interfaces to provide a base class for components that are used for data display and manipulation.