org.uberfire.ext.wires.core.grids.client.widget.dom

Interface DOMElementFactory<W,E>

Type Parameters:

W - The Widget to be wrapped by the DOMElement.

E - The DOMElement type that this Factory generates.

All Superinterfaces:

HasDOMElementResources

All Known Subinterfaces:

MultipleDOMElementFactory<W,E>, SingletonDOMElementFactory<W,E>

All Known Implementing Classes:

BaseDOMElementFactory, BaseSingletonDOMElementFactory, CheckBoxDOMElementFactory, ListBoxSingletonDOMElementFactory, TextBoxDOMElementFactory, TextBoxSingletonDOMElementFactory

public interface DOMElementFactory<W,E>
extends HasDOMElementResources

Definition of a Factor that can create DOMElements for GWT Widget based cell content. DOMElements are transient in nature and only exist when required, such as when a column and row is visible or when a cell is being edited.

Method Summary

Modifier and Type	Method and Description
void	attachDomElement(GridBodyCellRenderContext context, Consumer<E> onCreation, Consumer<E> onDisplay) Initialises a DOMElement for a cell and attach it to the GWT container.
E	createDomElement(GridLayer gridLayer, GridWidget gridWidget) Creates a DOMElement.
W	createWidget() Creates a Widget to be wrapped by the DOMElement
void	registerHandlers(W widget, E widgetDomElement) Register handlers for the widget.

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.widget.dom.HasDOMElementResources

destroyResources

Method Detail

createWidget

W createWidget()

Creates a Widget to be wrapped by the DOMElement

Returns:

createDomElement

E createDomElement(GridLayer gridLayer,
                   GridWidget gridWidget)

Creates a DOMElement.

Parameters:

gridLayer - The Lienzo layer on which the Grid Widget is attached. DOMElements may need to redraw the Layer when their state changes.

gridWidget - The GridWidget to which this DOMElement is to be associated.

Returns:

registerHandlers

void registerHandlers(W widget,
                      E widgetDomElement)

Register handlers for the widget. The set of handlers may differ per each Factory. Common handlers registered in this method are KeyDownHandler, BlurHandler, ... .

Parameters:

widget -

widgetDomElement -

attachDomElement

void attachDomElement(GridBodyCellRenderContext context,
                      Consumer<E> onCreation,
                      Consumer<E> onDisplay)

Initialises a DOMElement for a cell and attach it to the GWT container.

Parameters:

context - The render context of the cell.

onCreation - A callback that is invoked after the cell has been initialised, allowing content etc to be pre-set

onDisplay - A callback that is invoked after the cell has been attached to the DOM and displayed.