ListView (GXT 4.0.2)

java.lang.Object
- Widget
- - com.sencha.gxt.widget.core.client.Component
  - - com.sencha.gxt.widget.core.client.ListView<M,N>

Type Parameters:

M - the model type

N - the cell data type

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, RefreshEvent.HasRefreshHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId
```
public class ListView<M,N>
extends Component
implements RefreshEvent.HasRefreshHandlers
```
A ListView provides support for displaying a list of data. The list view gets its data from a ListStore. Each model in the store is rendered as an item in the list view. Any updates to the store are automatically pushed to the list view.

In GXT version 3, ModelKeyProviders and ValueProviders provide the interface between your data model, the list store and the list view. This enables a list view to work with data of any object type. The list view uses a value provider, passed to the constructor, to get the value to display for each model in the list view.

You can provide your own implementation of these interfaces, or you can use a Sencha supplied generator to create them for you automatically. A generator runs at compile time to create a Java class that is compiled to JavaScript. The Sencha supplied generator can create classes for interfaces that extend the PropertyAccess interface. The generator transparently creates the class at compile time and the GWT#create(Class) method returns an instance of that class at run time. The generated class is managed by GWT and GXT and you generally do not need to worry about what the class is called, where it is located, or other similar details.

To customize the appearance of the item in the list view, provide a cell implementation using ListView#setCell(Cell).

The following code snippet illustrates the creation of a simple list view with local data for test purposes. For more practical examples that show how to customize list views to display images or use other types of cells, see the ListView, Advanced ListView and DateCell ListView examples in the online Explorer demo.
```
   // Generate the key provider and value provider for the Data class
   DataProperties dp = GWT.create(DataProperties.class);

   // Create the store that the contains the data to display in the grid
   ListStore<Data> s = new ListStore<Test.Data>(dp.key());
   s.add(new Data("name1", "value1"));
   s.add(new Data("name2", "value2"));
   s.add(new Data("name3", "value3"));
   s.add(new Data("name4", "value4"));

   // Create the tree using the store and value provider for the name field
   ListView<Data, String> t = new ListView<Data, String>(s, dp.name());

   // Add the tree to a container
   RootPanel.get().add(t);
 
```
To use the Sencha supplied generator to create model key providers and value providers, extend the PropertyAccess interface, parameterized with the type of data you want to access (as shown below) and invoke the GWT.create method on its class member (as shown in the code snippet above). This creates an instance of the class that can be used to initialize the list view and list store. In the following code snippet we define a new interface called DataProperties that extends the PropertyAccess interface and is parameterized with Data, a Plain Old Java Object (POJO).
```
 public interface DataProperties extends PropertyAccess<Data> {
   @Path("name")
   ModelKeyProvider<Data> key();
   ValueProvider<Data, String> name();
   ValueProvider<Data, String> value();
 }

 public class Data {
   private String name;
   private String value;

   public Data(String name, String value) {
     super();
     this.name = name;
     this.value = value;
   }
   public String getName() {
     return name;
   }
   public String getValue() {
     return value;
   }
   public void setName(String name) {
     this.name = name;
   }
   public void setValue(String value) {
     this.value = value;
   }
 }
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListView.ListViewAppearance<M>
The appearance of a list view.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListView.ListViewAppearance<M>` The appearance of a list view.

Field Summary

Fields
Modifier and Type	Field and Description
`protected XElement`	`focusEl`
`protected FocusImpl`	`focusImpl`
`protected int`	`rowSelectorDepth`
`protected ListStore<M>`	`store`
`protected ValueProvider<? super M,N>`	`valueProvider`

Fields inherited from class com.sencha.gxt.widget.core.client.Component
adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors
Constructor and Description
`ListView(ListStore<M> store, ValueProvider<? super M,N> valueProvider)` Creates a new list view.
`ListView(ListStore<M> store, ValueProvider<? super M,N> valueProvider, <any> cell)` Creates a new list view.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addRefreshHandler(RefreshEvent.RefreshHandler handler)` Adds a `RefreshEvent.RefreshHandler` handler for `RefreshEvent` events.
`protected void`	`bufferRender(List<M> models, SafeHtmlBuilder sb)`
`protected boolean`	`cellConsumesEventType(<any> cell, String eventType)`
`Element`	`findElement(Element element)` Returns the matching element.
`int`	`findElementIndex(Element element)` Returns the element's index.
`void`	`focus()` Try to focus this widget.
`protected void`	`focusItem(int index)`
`ListView.ListViewAppearance<M>`	`getAppearance()`
`<any>`	`getCell()` Returns the view's cell.
`XElement`	`getElement(int index)` Returns the element at the given index.
`List<Element>`	`getElements()` Returns all of the child elements.
`int`	`getItemCount()` Returns the number of models in the view.
`SafeHtml`	`getLoadingIndicator()` Returns the view's loading indicator as html.
`QuickTip`	`getQuickTip()` Returns the view's quick tip instance.
`ListViewSelectionModel<M>`	`getSelectionModel()` Returns the view's selection model.
`boolean`	`getSelectOnOver()` Returns true if select on hover is enabled.
`ListStore<M>`	`getStore()` Returns the combo's store.
`protected N`	`getValue(M m)`
`protected void`	`handleEventForCell(Event event)`
`int`	`indexOf(Element element)` Returns the index of the element.
`boolean`	`isEnableQuickTips()` Returns true if quicktips are enabled.
`boolean`	`isTrackMouseOver()` Returns true if items are highlighted on mouse over.
`void`	`moveSelectedDown()` Moves the current selections down one level.
`void`	`moveSelectedUp()` Moves the current selections up one level.
`protected void`	`onAdd(List<M> models, int index)`
`protected void`	`onAfterFirstAttach()` Called immediately after the first time the widget becomes attached to the browser's document only the first time.
`protected void`	`onBeforeLoad()` Is called before a load when a #setLoader(Loader) and {@link #setLoadingIndicator(SafeHtml) or {@link #setLoadingIndicator(String)} are used the list will display the loading HTML.
`void`	`onBrowserEvent(Event event)`
`protected void`	`onFocus(Event event)`
`protected void`	`onHighlightRow(int index, boolean highLight)`
`protected void`	`onLoadError(LoadExceptionEvent<?> event)` Is called on loader exception.
`protected void`	`onLongPress(TouchData touchData)`
`protected void`	`onMouseDown(Event e)`
`protected void`	`onMouseOut(Event ce)`
`protected void`	`onMouseOver(Event ce)`
`protected void`	`onRemove(M data, int index)`
`protected void`	`onResize(int width, int height)` Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
`protected void`	`onSelectChange(M model, boolean select)`
`protected void`	`onTap(TouchData touch)`
`protected void`	`onUpdate(M model, int index)`
`void`	`refresh()` Refreshes the view by reloading the data from the store and re-rendering the template.
`void`	`refreshNode(int index)` Refreshes an individual node's data from the store.
`void`	`setAllowTextSelection(boolean enable)` Enables and disables text selection for the widget.
`void`	`setCell(<any> cell)` Optionally sets the view's cell.
`void`	`setEnableQuickTips(boolean enableQuickTip)` True to enable quicktips (defaults to true, pre-render).
`void`	`setLoader(Loader<?,?> loader)` Sets the loader.
`void`	`setLoadingIndicator(SafeHtml html)` Sets the loading indicator html to be displayed during a load request.
`void`	`setSelectionModel(ListViewSelectionModel<M> sm)` Sets the selection model.
`void`	`setSelectOnOver(boolean selectOnHover)` True to select the item when mousing over a element (defaults to false).
`void`	`setStore(ListStore<M> store)` Changes the data store bound to this view and refreshes it.
`void`	`setTrackMouseOver(boolean trackMouseOver)` True to highlight items when the mouse is over (defaults to true).
`protected void`	`updateIndexes(int startIndex, int endIndex)`

Methods inherited from class com.sencha.gxt.widget.core.client.Component
addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAttach, onBlur, onDetach, onDisable, onEnable, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - focusEl
```
protected XElement focusEl
```
  - focusImpl
```
protected final FocusImpl focusImpl
```
  - rowSelectorDepth
```
protected int rowSelectorDepth
```
  - store
```
protected ListStore<M> store
```
  - valueProvider
```
protected final ValueProvider<? super M,N> valueProvider
```
- Constructor Detail
  - ListView
```
public ListView(ListStore<M> store,
                ValueProvider<? super M,N> valueProvider)
```
    Creates a new list view.
    
    Parameters:
    
    store - the store
    
    valueProvider - the value provider
  - ListView
```
public ListView(ListStore<M> store,
                ValueProvider<? super M,N> valueProvider,
                <any> cell)
```
    Creates a new list view.
    
    Parameters:
    
    store - the store
    
    valueProvider - the value provider
    
    cell - the cell
- Method Detail
  - addRefreshHandler
```
public HandlerRegistration addRefreshHandler(RefreshEvent.RefreshHandler handler)
```
    Description copied from interface: RefreshEvent.HasRefreshHandlers
    
    Adds a RefreshEvent.RefreshHandler handler for RefreshEvent events.
    
    Specified by:
    
    addRefreshHandler in interface RefreshEvent.HasRefreshHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - findElement
```
public Element findElement(Element element)
```
    Returns the matching element.
    
    Parameters:
    
    element - the element or any child element
    
    Returns:
    
    the parent element
  - findElementIndex
```
public int findElementIndex(Element element)
```
    Returns the element's index.
    
    Parameters:
    
    element - the element or any child element
    
    Returns:
    
    the element index or -1 if no match
  - focus
```
public void focus()
```
    Description copied from class: Component
    
    Try to focus this widget.
    
    Overrides:
    
    focus in class Component
  - getAppearance
```
public ListView.ListViewAppearance<M> getAppearance()
```
  - getCell
```
public <any> getCell()
```
    Returns the view's cell.
    
    Returns:
    
    the cell, or null if none specified
  - getElement
```
public XElement getElement(int index)
```
    Returns the element at the given index.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the element
  - getElements
```
public List<Element> getElements()
```
    Returns all of the child elements.
    
    Returns:
    
    the elements
  - getItemCount
```
public int getItemCount()
```
    Returns the number of models in the view.
    
    Returns:
    
    the count
  - getLoadingIndicator
```
public SafeHtml getLoadingIndicator()
```
    Returns the view's loading indicator as html.
    
    Returns:
    
    the loading indicator html
  - getQuickTip
```
public QuickTip getQuickTip()
```
    Returns the view's quick tip instance.
    
    Returns:
    
    the quicktip instance or null if not enabled
  - getSelectionModel
```
public ListViewSelectionModel<M> getSelectionModel()
```
    Returns the view's selection model.
    
    Returns:
    
    the selection model
  - getSelectOnOver
```
public boolean getSelectOnOver()
```
    Returns true if select on hover is enabled.
    
    Returns:
    
    the select on hover state
  - getStore
```
public ListStore<M> getStore()
```
    Returns the combo's store.
    
    Returns:
    
    the store
  - indexOf
```
public int indexOf(Element element)
```
    Returns the index of the element.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    the index
  - isEnableQuickTips
```
public boolean isEnableQuickTips()
```
    Returns true if quicktips are enabled.
    
    Returns:
    
    true for enabled
  - isTrackMouseOver
```
public boolean isTrackMouseOver()
```
    Returns true if items are highlighted on mouse over.
    
    Returns:
    
    the track mouse state
  - moveSelectedDown
```
public void moveSelectedDown()
```
    Moves the current selections down one level.
  - moveSelectedUp
```
public void moveSelectedUp()
```
    Moves the current selections up one level.
  - onBrowserEvent
```
public void onBrowserEvent(Event event)
```
    Overrides:
    
    onBrowserEvent in class Component
  - refresh
```
public void refresh()
```
    Refreshes the view by reloading the data from the store and re-rendering the template.
  - refreshNode
```
public void refreshNode(int index)
```
    Refreshes an individual node's data from the store.
    
    Parameters:
    
    index - the items data index in the store
  - setAllowTextSelection
```
public void setAllowTextSelection(boolean enable)
```
    Description copied from class: Component
    
    Enables and disables text selection for the widget.
    
    Overrides:
    
    setAllowTextSelection in class Component
    
    Parameters:
    
    enable - true to enable, false to disable
  - setCell
```
public void setCell(<any> cell)
```
    Optionally sets the view's cell. If a cell is not provided, toString is called on the value returned by the view's value provider.
    
    Parameters:
    
    cell - the cell
  - setEnableQuickTips
```
public void setEnableQuickTips(boolean enableQuickTip)
```
    True to enable quicktips (defaults to true, pre-render).
    
    Parameters:
    
    enableQuickTip - true to enable quicktips
  - setLoader
```
public void setLoader(Loader<?,?> loader)
```
    Sets the loader. Used for interacting with before load and load exception events.
    - Used with setLoadingIndicator(SafeHtml) or #setLoadingIndicator(String).
    - onBeforeLoad() is called before a load and sets the loading HTML.
    - onLoadError(com.sencha.gxt.data.shared.loader.LoadExceptionEvent) is called on load exception.
    Parameters:
    
    loader - is the list loader
  - setLoadingIndicator
```
public void setLoadingIndicator(SafeHtml html)
```
    Sets the loading indicator html to be displayed during a load request.
    - The setLoader(Loader) has to be set for this use.
    - The css class name 'loading-indicator' can style the loading indicator html.
    Parameters:
    
    html - the loading html
  - setSelectionModel
```
public void setSelectionModel(ListViewSelectionModel<M> sm)
```
    Sets the selection model.
    
    Parameters:
    
    sm - the selection model
  - setSelectOnOver
```
public void setSelectOnOver(boolean selectOnHover)
```
    True to select the item when mousing over a element (defaults to false).
    
    Parameters:
    
    selectOnHover - true to select on mouse over
  - setStore
```
public void setStore(ListStore<M> store)
```
    Changes the data store bound to this view and refreshes it.
    
    Parameters:
    
    store - the store to bind this view
  - setTrackMouseOver
```
public void setTrackMouseOver(boolean trackMouseOver)
```
    True to highlight items when the mouse is over (defaults to true).
    
    Parameters:
    
    trackMouseOver - true to highlight rows on mouse over
  - bufferRender
```
protected void bufferRender(List<M> models,
                            SafeHtmlBuilder sb)
```
  - cellConsumesEventType
```
protected boolean cellConsumesEventType(<any> cell,
                                        String eventType)
```
  - focusItem
```
protected void focusItem(int index)
```
  - getValue
```
protected N getValue(M m)
```
  - handleEventForCell
```
protected void handleEventForCell(Event event)
```
  - onAdd
```
protected void onAdd(List<M> models,
                     int index)
```
  - onAfterFirstAttach
```
protected void onAfterFirstAttach()
```
    Description copied from class: Component
    
    Called immediately after the first time the widget becomes attached to the browser's document only the first time.
    
    Overrides:
    
    onAfterFirstAttach in class Component
  - onBeforeLoad
```
protected void onBeforeLoad()
```
    Is called before a load when a #setLoader(Loader) and {@link #setLoadingIndicator(SafeHtml) or {@link #setLoadingIndicator(String)} are used the list will display the loading HTML.
    - The {@link #setLoader(Loader)} has to be set for this to be called.
    - The css class name 'loading-indicator' can style the loading HTML or text.
  - onLoadError
```
protected void onLoadError(LoadExceptionEvent<?> event)
```
    Is called on loader exception. Override to add error handling.
    - The setLoader(Loader) has to be set for this to be called.
    Parameters:
    
    event - is the load exception event
  - onFocus
```
protected void onFocus(Event event)
```
    Overrides:
    
    onFocus in class Component
  - onHighlightRow
```
protected void onHighlightRow(int index,
                              boolean highLight)
```
  - onLongPress
```
protected void onLongPress(TouchData touchData)
```
  - onMouseDown
```
protected void onMouseDown(Event e)
```
  - onMouseOut
```
protected void onMouseOut(Event ce)
```
  - onMouseOver
```
protected void onMouseOver(Event ce)
```
  - onRemove
```
protected void onRemove(M data,
                        int index)
```
  - onResize
```
protected void onResize(int width,
                        int height)
```
    Description copied from class: Component
    
    Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
    
    Overrides:
    
    onResize in class Component
    
    Parameters:
    
    width - the width
    
    height - the height
  - onSelectChange
```
protected void onSelectChange(M model,
                              boolean select)
```
  - onTap
```
protected void onTap(TouchData touch)
```
  - onUpdate
```
protected void onUpdate(M model,
                        int index)
```
  - updateIndexes
```
protected void updateIndexes(int startIndex,
                             int endIndex)
```

Class ListView<M,N>

Nested Class Summary

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.Component

Constructor Summary

Method Summary

Methods inherited from class com.sencha.gxt.widget.core.client.Component

Methods inherited from class java.lang.Object

Field Detail

focusEl

focusImpl

rowSelectorDepth

store

valueProvider

Constructor Detail

ListView

ListView

Method Detail

addRefreshHandler

findElement

findElementIndex

focus

getAppearance

getCell

getElement

getElements

getItemCount

getLoadingIndicator

getQuickTip

getSelectionModel

getSelectOnOver

getStore

indexOf

isEnableQuickTips

isTrackMouseOver

moveSelectedDown

moveSelectedUp

onBrowserEvent

refresh

refreshNode

setAllowTextSelection

setCell

setEnableQuickTips

setLoader

setLoadingIndicator

setSelectionModel

setSelectOnOver

setStore

setTrackMouseOver

bufferRender

cellConsumesEventType

focusItem

getValue

handleEventForCell

onAdd

onAfterFirstAttach

onBeforeLoad

onLoadError

onFocus

onHighlightRow

onLongPress

onMouseDown

onMouseOut

onMouseOver

onRemove

onResize

onSelectChange

onTap

onUpdate

updateIndexes