de.intarsys.tools.ui

Class UIComponent<M,C,T>

java.lang.Object

de.intarsys.tools.ui.UIComponent<M,C,T>

Type Parameters:

M - The model object

C - The toolkit container class

T - The toolkit component class

All Implemented Interfaces:

IDisposable, INotificationSupport, IElementConfigurable, IComponentProvider<C,T>, IUIComponent<M,C,T>

Direct Known Subclasses:

UIWizard

public abstract class UIComponent<M,C,T>
extends Object
implements IUIComponent<M,C,T>, IElementConfigurable

Abstraction of an user interface component.

The UIComponent spans a hierarchical tree. Each UIComponent maps to a real toolkit interface component that gets realized upon calling "createComponent".

A UIComponent is associated with a model object via an IValueHolder.

Constructor Summary

Constructors

Constructor and Description
UIComponent()
UIComponent(IUIComponent<?,C,T> parent)

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotificationListener(EventType type, INotificationListener listener) Add listener to the collection of objects to be informed when the receiver triggers an event of type name.
void	configure(IElement element)
void	createComponent(C parent) Create the associated toolkit component.
void	dispose() Dispose all of the objects resources.
T	getComponent() The associated toolkit component.
IElement	getConfiguration()
IUIComponent	getParent()
M	getValue()
IValueHolder<M>	getValueHolder()
boolean	isDisposed() true if this object is already disposed.
void	removeNotificationListener(EventType type, INotificationListener listener) Remove listener from the collection of objects to be informed about events of type name.
M	setValue(M value)
void	setValueHolder(IValueHolder<M> pValueHolder)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIComponent

public UIComponent()

UIComponent

public UIComponent(IUIComponent<?,C,T> parent)

Method Detail

addNotificationListener

public void addNotificationListener(EventType type,
                           INotificationListener listener)

Description copied from interface: INotificationSupport

Add listener to the collection of objects to be informed when the receiver triggers an event of type name.

Specified by:

addNotificationListener in interface INotificationSupport

Parameters:

type - The event type we are interested in.

listener - The object to be informed about an event occurrence

configure

public void configure(IElement element)
               throws ConfigurationException

Specified by:

configure in interface IElementConfigurable

Throws:

ConfigurationException

createComponent

public final void createComponent(C parent)

Description copied from interface: IComponentProvider

Create the associated toolkit component. This is a factory method called by a container to create a concrete UI component. After the execution, the new component is expected to be correctly associated with the parent component.

Specified by:

createComponent in interface IComponentProvider<C,T>

dispose

public void dispose()

Description copied from interface: IDisposable

Dispose all of the objects resources. This method should be safe to be called in any object state, especially when the object is in an invalid/error state and when the object is already disposed.

Specified by:

dispose in interface IDisposable

getComponent

public final T getComponent()

Description copied from interface: IComponentProvider

The associated toolkit component. This is not valid until after a call to createComponent.

Specified by:

getComponent in interface IComponentProvider<C,T>

Returns:

The associated toolkit component.

getConfiguration

public IElement getConfiguration()

getParent

public IUIComponent getParent()

getValue

public M getValue()

Specified by:

getValue in interface IUIComponent<M,C,T>

getValueHolder

public IValueHolder<M> getValueHolder()

Specified by:

getValueHolder in interface IUIComponent<M,C,T>

isDisposed

public boolean isDisposed()

Description copied from interface: IDisposable

true if this object is already disposed.

Specified by:

isDisposed in interface IDisposable

Returns:

removeNotificationListener

public void removeNotificationListener(EventType type,
                              INotificationListener listener)

Description copied from interface: INotificationSupport

Remove listener from the collection of objects to be informed about events of type name.

Specified by:

removeNotificationListener in interface INotificationSupport

Parameters:

type - The event type we are no longer interested in.

listener - The object registered for the event till now.

setValue

public M setValue(M value)

Specified by:

setValue in interface IUIComponent<M,C,T>

setValueHolder

public void setValueHolder(IValueHolder<M> pValueHolder)