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

Class BaseDOMElementFactory<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.multiple.impl.BaseDOMElementFactory<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, HasMultipleDOMElementResources, MultipleDOMElementFactory<W,E>

Direct Known Subclasses:

CheckBoxDOMElementFactory, TextBoxDOMElementFactory

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

Base Factory for multi-instance DOMElements, i.e. there can be more than one "on screen" at any given time. This implementation keeps track of a List of DOMElements used during a render phase. DOMElements are re-used for subsequent render phases, freeing unused DOMElements at the end of the render phase. When a column is not rendered all DOMElements are destroyed.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<E>	domElements
protected GridLayer	gridLayer
protected GridWidget	gridWidget

Constructor Summary

Constructors

Constructor and Description
BaseDOMElementFactory(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.
void	destroyResources() Destroys all additional resources created during initialisation.
void	freeUnusedResources() Destroys additional resources that are not required.
void	initialiseResources() Initialises additional resources.

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

createDomElement, createWidget, registerHandlers

Field Detail

gridLayer

protected final GridLayer gridLayer

gridWidget

protected final GridWidget gridWidget

domElements

protected final List<E extends BaseDOMElement<T,W>> domElements

Constructor Detail

BaseDOMElementFactory

public BaseDOMElementFactory(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.

initialiseResources

public void initialiseResources()

Description copied from interface: HasMultipleDOMElementResources

Initialises additional resources. This is invoked at the start of the render phase if a column is visible.

Specified by:

initialiseResources in interface HasMultipleDOMElementResources

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

freeUnusedResources

public void freeUnusedResources()

Description copied from interface: HasMultipleDOMElementResources

Destroys additional resources that are not required. This is invoked at the end of the render phase on columns that are partially visible. Some of the resources acquired in initialisation may not have been used for rendering and can be released.

Specified by:

freeUnusedResources in interface HasMultipleDOMElementResources