org.jowidgets.common.widgets.factory

Interface IGenericWidgetFactory

public interface IGenericWidgetFactory

Method Summary

Methods

Modifier and Type	Method and Description
<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void	addWidgetDecorator(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass, IDecorator<? extends WIDGET_TYPE> decorator) Adds a widget decorator The decorators IDecorator.decorate(Object) will be invoked for each created widget and the decorated widget will be returned
<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void	addWidgetFactoryDecorator(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass, IDecorator<? extends IWidgetFactory<WIDGET_TYPE,? extends DESCRIPTOR_TYPE>> decorator) Adds a widget factory decorator The decorators IDecorator.decorate(Object) will be invoked for the factory with the given type and the decorated factory will be used to create widgets with the given type
void	addWidgetFactoryListener(IWidgetFactoryListener listener) Adds a widget factory listener
<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> WIDGET_TYPE	create(DESCRIPTOR_TYPE descriptor) Creates a root widget (with no parent) for a given descriptor
<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> WIDGET_TYPE	create(java.lang.Object parentUiReference, DESCRIPTOR_TYPE descriptor) Creates a widget for a given descriptor
<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> IWidgetFactory<WIDGET_TYPE,DESCRIPTOR_TYPE>	getFactory(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass) Gets a factory for a specific descriptor type
<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void	register(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass, IWidgetFactory<WIDGET_TYPE,? extends DESCRIPTOR_TYPE> widgetFactory) Registers a factory for a given descriptor type The widget for the type must not already be registered
void	removeWidgetFactoryListener(IWidgetFactoryListener listener) Removes a widget factory listener
<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void	unRegister(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass) Unregisters a factory for a given descriptor type

Method Detail

create

<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> WIDGET_TYPE create(DESCRIPTOR_TYPE descriptor)

Creates a root widget (with no parent) for a given descriptor

Parameters:

descriptor - The descriptor of the widget

Returns:

A new widget, never null

create

<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> WIDGET_TYPE create(java.lang.Object parentUiReference,
                                                                                                            DESCRIPTOR_TYPE descriptor)

Creates a widget for a given descriptor

Parameters:

parentUiReference - The native ui reference of the parent widget

descriptor - The descriptor of the widget

Returns:

A new widget, never null

getFactory

<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> IWidgetFactory<WIDGET_TYPE,DESCRIPTOR_TYPE> getFactory(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass)

Gets a factory for a specific descriptor type

Parameters:

descriptorClass - The type to get the factory for

Returns:

The factory for the given type if registered, null otherwise

register

<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void register(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass,
                                                                                                       IWidgetFactory<WIDGET_TYPE,? extends DESCRIPTOR_TYPE> widgetFactory)

Registers a factory for a given descriptor type The widget for the type must not already be registered

Parameters:

descriptorClass - The type to register the factory for

widgetFactory - The widget factory to register

Throws:

java.lang.IllegalArgumentException - if already a widget is registered for the given type, use unRegister(Class) explicitly in the case that widget should be replaced

unRegister

<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void unRegister(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass)

Unregisters a factory for a given descriptor type

Parameters:

descriptorClass - The type to unregister the factory for

addWidgetDecorator

<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void addWidgetDecorator(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass,
                                                                                                                 IDecorator<? extends WIDGET_TYPE> decorator)

Adds a widget decorator The decorators IDecorator.decorate(Object) will be invoked for each created widget and the decorated widget will be returned

Parameters:

descriptorClass - The type to add the decorator for

decorator - The decorator to add

addWidgetFactoryDecorator

<WIDGET_TYPE extends IWidgetCommon,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> void addWidgetFactoryDecorator(java.lang.Class<? extends DESCRIPTOR_TYPE> descriptorClass,
                                                                                                                        IDecorator<? extends IWidgetFactory<WIDGET_TYPE,? extends DESCRIPTOR_TYPE>> decorator)

Adds a widget factory decorator The decorators IDecorator.decorate(Object) will be invoked for the factory with the given type and the decorated factory will be used to create widgets with the given type

Parameters:

descriptorClass - The type to add the decorator for

decorator - The decorator to add

addWidgetFactoryListener

void addWidgetFactoryListener(IWidgetFactoryListener listener)

Adds a widget factory listener

Parameters:

listener - The listener to add

removeWidgetFactoryListener

void removeWidgetFactoryListener(IWidgetFactoryListener listener)

Removes a widget factory listener

Parameters:

listener - The listener to remove