We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.ironlist.
Class IronList<T>
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.ironlist.IronList<T>
-
Type Parameters:
T- the type of the items supported by the listAll Implemented Interfaces:
AttachNotifier, BlurNotifier<IronList<T>>, DetachNotifier, Focusable<IronList<T>>, FocusNotifier<IronList<T>>, HasElement, HasEnabled, HasSize, HasStyle, HasDataProvider<T>, HasItems<T>, Serializable
@Tag(value="iron-list") @NpmPackage(value="@polymer/iron-list", version="3.1.0") @JsModule(value="@polymer/iron-list/iron-list.js") @JsModule(value="./flow-component-renderer.js") @JsModule(value="./ironListConnector.js") @JsModule(value="./ironListStyles.js") public class IronList<T> extends Component implements HasDataProvider<T>, HasStyle, HasSize, Focusable<IronList<T>>Component that encapsulates the functionality of the
<iron-list>webcomponent.It supports
DataProviders to load data asynchronously andTemplateRenderers to render the markup for each item.For this component to work properly, it needs to have a well defined
height. It can be an absolute height, like100px, or a relative height inside a container with well defined height.For list rendered in grid layout (setting
setGridLayout(boolean)withtrue), thewidthof the component also needs to be well defined.Author:
Vaadin Ltd.
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>
-
-
Constructor Summary
Constructors Constructor and Description IronList()Creates an empty list.
-
Method Summary
All Methods 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.
TgetPlaceholderItem()Gets the placeholder item of this list, or
nullif none has been set.booleanisGridLayout()Gets whether this list is rendered in a grid layout instead of a linear list.
voidonEnabledStateChanged(boolean enabled)Handle component enable state when the enabled state changes.
voidsetDataProvider(DataProvider<T,?> dataProvider)Sets the data provider for this listing.
voidsetGridLayout(boolean gridLayout)Sets this list to be rendered as a grid.
voidsetPlaceholderItem(T placeholderItem)Sets an item to be shown as placeholder in the list while the real data in being fetched from the server.
voidsetRenderer(Renderer<T> renderer)Sets a renderer for the items in the list, by using a
TemplateRenderer.voidsetRenderer(ValueProvider<T,String> valueProvider)Sets a renderer for the items in the list, by using a
ValueProvider.-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.data.binder.HasDataProvider
setItems
-
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
Methods inherited from interface com.vaadin.flow.component.HasSize
getCssSize, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
-
Methods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndex
-
Methods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListener
-
Methods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListener
-
Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
Method Detail
-
setDataProvider
public void setDataProvider(DataProvider<T,?> dataProvider)Description copied from interface:
HasDataProviderSets the data provider for this listing. The data provider is queried for displayed items as needed.
Specified by:
setDataProviderin interfaceHasDataProvider<T>Parameters:
dataProvider- the data provider, not null
-
getDataProvider
public DataProvider<T,?> getDataProvider()Returns the data provider of this list.
Returns:
the data provider of this list, not
null
-
getDataCommunicator
public DataCommunicator<T> getDataCommunicator()Returns the data communicator of this list.
Returns:
the data communicator, not
null
-
setRenderer
public void setRenderer(ValueProvider<T,String> valueProvider)Sets a renderer for the items in the list, by using a
ValueProvider. The String returned by the provider is used to render each item.Parameters:
valueProvider- a provider for the label string for each item in the list, notnull
-
setRenderer
public void setRenderer(Renderer<T> renderer)Sets a renderer for the items in the list, by using a
TemplateRenderer. The template returned by the renderer is used to render each item.When set, a same renderer is used for the placeholder item. See
setPlaceholderItem(Object)for details.Parameters:
renderer- a renderer for the items in the list, notnull
-
setPlaceholderItem
public 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.
Setting a placeholder item improves the user experience of the list while scrolling, since the placeholder uses the same renderer set with
#setRenderer(TemplateRenderer), 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 with100pxof width and18pxof height.Note: when using
ComponentTemplateRenderers, the component used for the placeholder is statically stamped in the list. It can not be modified, nor receives any events.Parameters:
placeholderItem- the item used as placeholder in the list, while the real data is being fetched from the server
-
getPlaceholderItem
public T getPlaceholderItem()Gets the placeholder item of this list, or
nullif none has been set.Returns:
the placeholder item
-
isGridLayout
public boolean isGridLayout()Gets whether this list is rendered in a grid layout instead of a linear list.
Returns:
trueif the list renders itself as a grid,falseotherwise
-
setGridLayout
public void setGridLayout(boolean gridLayout)Sets this list to be rendered as a grid. Note that for the grid layout to work properly, the component needs to have a well defined
widthandheight.Parameters:
gridLayout-trueto make the list renders itself as a grid,falseto make it render as a linear list
-
onEnabledStateChanged
public void onEnabledStateChanged(boolean enabled)Description copied from class:
ComponentHandle component enable state when the enabled state changes.
By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.
Overrides:
onEnabledStateChangedin classComponentParameters:
enabled- the new enabled state of the component
-
-