T - the type of the items supported by the list@Tag(value="vaadin-virtual-list") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="22.0.22") @NpmPackage(value="@vaadin/virtual-list",version="22.0.22") @NpmPackage(value="@vaadin/vaadin-virtual-list",version="22.0.22") @JsModule(value="@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule(value="@vaadin/polymer-legacy-adapter/template-renderer.js") @JsModule(value="@vaadin/virtual-list/vaadin-virtual-list.js") @JsModule(value="./flow-component-renderer.js") @JsModule(value="./virtualListConnector.js") public class VirtualList<T> extends Component implements HasDataProvider<T>, HasStyle, HasSize, Focusable<VirtualList<T>>
<vaadin-virtual-list> web component.
It supports DataProviders to load data asynchronously and
Renderers to render the markup for each item.
BlurNotifier.BlurEvent<C extends Component>FocusNotifier.FocusEvent<C extends Component>| Constructor and Description |
|---|
VirtualList()
Creates an empty list.
|
| Modifier and Type | Method and Description |
|---|---|
DataCommunicator<T> |
getDataCommunicator()
Returns the data communicator of this list.
|
DataProvider<T,?> |
getDataProvider()
Returns the data provider of this list.
|
T |
getPlaceholderItem()
Gets the placeholder item of this list, or
null if none has
been set. |
void |
onEnabledStateChanged(boolean enabled)
Handle component enable state when the enabled state changes.
|
void |
setDataProvider(DataProvider<T,?> dataProvider)
Sets the data provider for this listing.
|
void |
setPlaceholderItem(T placeholderItem)
Sets an item to be shown as placeholder in the list while the real data
in being fetched from the server.
|
void |
setRenderer(Renderer<T> renderer)
Sets a renderer for the items in the list.
|
void |
setRenderer(ValueProvider<T,String> valueProvider)
Sets a renderer for the items in the list, by using a
ValueProvider. |
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, set, setElement, setId, setVisibleclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetItemsaddClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNamegetCssSize, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFulladdFocusShortcut, blur, focus, getTabIndex, setTabIndexaddBlurListeneraddFocusListenerisEnabled, setEnabledgetElementaddAttachListeneraddDetachListenerpublic void setDataProvider(DataProvider<T,?> dataProvider)
HasDataProvidersetDataProvider in interface HasDataProvider<T>dataProvider - the data provider, not nullpublic DataProvider<T,?> getDataProvider()
nullpublic DataCommunicator<T> getDataCommunicator()
nullpublic void setRenderer(ValueProvider<T,String> valueProvider)
ValueProvider. The String returned by the provider is used to
render each item.valueProvider - a provider for the label string for each item in the list, not
nullpublic void setRenderer(Renderer<T> renderer)
When set, a same renderer is used for the placeholder item. See
setPlaceholderItem(Object) for details.
renderer - a renderer for the items in the list, not nullpublic void setPlaceholderItem(T placeholderItem)
Setting a placeholder item improves the user experience of the list while
scrolling, since the placeholder uses the same renderer set with
setRenderer(Renderer), maintaining the same height for
placeholders and actual items.
When no placeholder item is set (or when set to null), an
empty placeholder element is created with 100px of width and
18px of height.
Note: when using ComponentRenderers, the component used for the
placeholder is statically stamped in the list. It can not be modified,
nor receives any events.
placeholderItem - the item used as placeholder in the list, while the real data
is being fetched from the serverpublic T getPlaceholderItem()
null if none has
been set.public void onEnabledStateChanged(boolean enabled)
ComponentBy default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.
onEnabledStateChanged in class Componentenabled - the new enabled state of the componentCopyright © 2023. All rights reserved.