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

Class BaseSingletonDOMElementFactory<T,W extends com.google.gwt.user.client.ui.Widget,E extends BaseDOMElement<T,W>>

java.lang.Object

org.uberfire.ext.wires.core.grids.client.widget.dom.single.impl.BaseSingletonDOMElementFactory<T,W,E>

Type Parameters:

T - The data-type of the cell

W - The Widget to be wrapped by the DOMElement.

E - The DOMElement type that this Factory generates.

All Implemented Interfaces:

DOMElementFactory<W,E>, HasDOMElementResources, HasSingletonDOMElementResource, SingletonDOMElementFactory<W,E>

Direct Known Subclasses:

ListBoxSingletonDOMElementFactory, TextBoxSingletonDOMElementFactory

public abstract class BaseSingletonDOMElementFactory<T,W extends com.google.gwt.user.client.ui.Widget,E extends BaseDOMElement<T,W>>
extends Object
implements SingletonDOMElementFactory<W,E>

Base Factory for single-instance DOMElements, i.e. there can only be one instance "on screen" at any given time, for example to handle "in cell" editing; when a DOMElement is required to "edit" the cell but not when the cell is rendered ordinarily. This implementation keeps a single DOMElement that is detached from the GWT container when not needed.

Field Summary

Fields

Modifier and Type	Field and Description
protected E	e
protected GridLayer	gridLayer
protected GridLienzoPanel	gridPanel
protected GridWidget	gridWidget
protected W	widget

Constructor Summary

Constructors

Constructor and Description
BaseSingletonDOMElementFactory(GridLienzoPanel gridPanel, GridLayer gridLayer, GridWidget gridWidget)

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.
protected abstract E	createDomElementInternal(W widget, GridLayer gridLayer, GridWidget gridWidget)
protected KeyDownHandlerCommon	destroyOrFlushKeyDownHandler()
void	destroyResources() Destroys all additional resources created during initialisation.
void	flush() Flushes the content of a DOMElement to the underlying model.
protected abstract T	getValue()
void	registerHandlers(W widget, E widgetDomElement) Register handlers for the widget.

Methods inherited from class java.lang.Object

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

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

createWidget

Field Detail

gridPanel

protected final GridLienzoPanel gridPanel

gridLayer

protected final GridLayer gridLayer

gridWidget

protected final GridWidget gridWidget

widget

protected W extends com.google.gwt.user.client.ui.Widget widget

e

protected E extends BaseDOMElement<T,W> e

Constructor Detail

BaseSingletonDOMElementFactory

public BaseSingletonDOMElementFactory(GridLienzoPanel gridPanel,
                                      GridLayer gridLayer,
                                      GridWidget gridWidget)

Method Detail

attachDomElement

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

Description copied from interface: DOMElementFactory

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

Specified by:

attachDomElement in interface DOMElementFactory<W extends com.google.gwt.user.client.ui.Widget,E extends BaseDOMElement<T,W>>

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.

createDomElement

public E createDomElement(GridLayer gridLayer,
                          GridWidget gridWidget)

Description copied from interface: DOMElementFactory

Creates a DOMElement.

Specified by:

createDomElement in interface DOMElementFactory<W extends com.google.gwt.user.client.ui.Widget,E extends BaseDOMElement<T,W>>

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

public void registerHandlers(W widget,
                             E widgetDomElement)

Description copied from interface: DOMElementFactory

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

Specified by:

registerHandlers in interface DOMElementFactory<W extends com.google.gwt.user.client.ui.Widget,E extends BaseDOMElement<T,W>>

destroyResources

public void destroyResources()

Description copied from interface: HasDOMElementResources

Destroys all additional resources created during initialisation. This is invoked at the end of the render phase if the column is not visible.

Specified by:

destroyResources in interface HasDOMElementResources

flush

public void flush()

Description copied from interface: HasSingletonDOMElementResource

Flushes the content of a DOMElement to the underlying model. Releasing and removing the DOMElement.

Specified by:

flush in interface HasSingletonDOMElementResource

destroyOrFlushKeyDownHandler

protected KeyDownHandlerCommon destroyOrFlushKeyDownHandler()

getValue

protected abstract T getValue()

createDomElementInternal

protected abstract E createDomElementInternal(W widget,
                                              GridLayer gridLayer,
                                              GridWidget gridWidget)