Package org.millstone.base.ui

Provides interfaces and classes in the the MillStone UI component library.

See:
Description

Interface Summary

Button.ClickListener	Button click listener
Component	The top-level component interface which must be implemented by all MillStone UI components.
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.
Layout	Extension to the ComponentContainer interface which adds the layouting control to the elements in the 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 unsuccessfull.
Upload.FinishedListener	Receives events when the uploads are ready.
Upload.Receiver	Interface that must be implemented by the upload receivers.
Upload.SucceededListener	Receives events when the uploads are successfully finished.

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.
Button	A generic button component.
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.
Embedded	Component for embedding external objects.
Form	Form component provides easy way of creating and managing sets fields.
FrameWindow	An application frame window component.
GridLayout	A container that consists of components with certain coordinates on a grid.
Label	Label component for showing non-editable short texts.
Link	Link component.
OrderedLayout	Ordered layout.
Panel	Panel - a simple single component container.
Select	A class representing a selection of items the user has selected in a UI.
Table	Table component 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.
Upload	Component for client file uploading.
Window	Application window component.

Exception Summary

Package org.millstone.base.ui Description

Provides interfaces and classes in the the MillStone UI component library.

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 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 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.