com.extjs.gxt.ui.client.widget
Class DataView

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<T>
                      extended by com.extjs.gxt.ui.client.widget.ScrollContainer<DataViewItem>
                          extended by com.extjs.gxt.ui.client.widget.DataView
All Implemented Interfaces:
Observable, Selectable<DataViewItem>, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

Deprecated. see ListView

public class DataView
extends ScrollContainer<DataViewItem>
implements Selectable<DataViewItem>

A mechanism for displaying data using custom layout templates. DataView uses an Template as its internal templating mechanism.

A itemSelector MUST be provided for the DataView to determine what nodes it will be working with.

Events:
BeforeAdd : DataViewEvent(view, item, index)
Fires before an item is added or inserted. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
BeforeRemove : DataViewEvent(view, item)
Fires before an item is removed. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Add : DataViewEvent(view, item, index)
Fires after an item has been added or inserted.
Remove : DataViewEvent(view, item)
Fires after an item has been removed.
SelectionChange : DataViewEvent(view, selected)
Fires after the selection changes.
ContextMenu : DataViewEvent(view)
Fires before the view's context menu is shown. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Inherited Events:
ScrollContainer Scroll
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
 class DataView.DataViewSelectionModel
          Deprecated. Data view selection model.
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
protected  DataView.DataViewSelectionModel sm
          Deprecated. The view's selection model.
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
DataView()
          Deprecated. Creates a new data view.
DataView(Template template)
          Deprecated. Creates a new data view with the given template.
 
Method Summary
 boolean add(DataViewItem component)
          Deprecated. Adds a item to the container.
protected  java.lang.String bulkRenderItem(DataViewItem item)
          Deprecated.  
protected  ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
          Deprecated.  
protected  ContainerEvent createContainerEvent(DataViewItem item)
          Deprecated.  
 DataViewBinder<?> getBinder()
          Deprecated. Returns the view's binder.
 java.lang.String getContainerTagName()
          Deprecated. Returns the container's tag name.
 Menu getContextMenu()
          Deprecated. Returns the component's context menu.
 java.lang.String getDefaultTemplate()
          Deprecated. Returns the default template.
 java.lang.String getItemSelector()
          Deprecated. Returns the item selector.
 java.lang.String getOverStyle()
          Deprecated. Returns the over style.
 DataViewItem getSelectedItem()
          Deprecated. Returns the selected item.
 java.util.List<DataViewItem> getSelectedItems()
          Deprecated. Returns the selected items.
 Style.SelectionMode getSelectionMode()
          Deprecated. Returns the view's selection mode.
 DataView.DataViewSelectionModel getSelectionModel()
          Deprecated. Returns the view's selection model.
 boolean getSelectOnOver()
          Deprecated. Returns true if select on hover is enabled.
 java.lang.String getSelectStyle()
          Deprecated. Returns the select style.
 Template getTemplate()
          Deprecated. Returns the view's template.
 boolean insert(DataViewItem item, int index)
          Deprecated. Adds a item into the container.
 void onComponentEvent(ComponentEvent ce)
          Deprecated. Any events a component receives will be forwarded to this method.
protected  void onMouseOut(DataViewItem item)
          Deprecated.  
protected  void onMouseOver(DataViewItem item)
          Deprecated.  
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Deprecated. Subclasses must override and ensure setElement is called for lazy rendered components.
 void onSelectChange(DataViewItem item, boolean select)
          Deprecated. Called when the visual state of a item is changed.
 boolean remove(DataViewItem component)
          Deprecated. Removes the item from the container.
protected  void renderAll()
          Deprecated.  
protected  void renderItem(DataViewItem item, int index)
          Deprecated.  
 void setContainerTagName(java.lang.String containerTagName)
          Deprecated. Sets the container's tag name (defaults to 'div', pre-render).
 void setContextMenu(Menu menu)
          Deprecated. Sets the component's context menu.
 void setDefaultTemplate(java.lang.String defaultTemplate)
          Deprecated. Sets the default template.
 void setItemSelector(java.lang.String itemSelector)
          Deprecated. This is a required setting.
 void setOverStyle(java.lang.String overStyle)
          Deprecated. Sets the style name to be applied on mouse over (defaults to 'x-view-item-over').
 void setSelectedItem(DataViewItem item)
          Deprecated. Selects the item.
 void setSelectedItems(java.util.List<DataViewItem> items)
          Deprecated. Selects the items.
 void setSelectionMode(Style.SelectionMode mode)
          Deprecated. Sets the list's selection mode.
protected  void setSelectionModel(DataView.DataViewSelectionModel sm)
          Deprecated.  
 void setSelectOnOver(boolean selectOnHover)
          Deprecated. True to select the item when mousing over a element (defaults to false).
 void setSelectStyle(java.lang.String selectStyle)
          Deprecated. The style to be applied to each selected item (defaults to 'x-view-item-sel').
 void setStore(ListStore store)
          Deprecated. Convenience method that create a new DataViewBinder using the given store.
 void setTemplate(java.lang.String html)
          Deprecated. Sets the view's template.
 void setTemplate(Template template)
          Deprecated. Sets the view's template.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer
addScrollListener, afterRender, getHScrollPosition, getScrollMode, getVScrollPosition, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
adjustIndex, adopt, disable, doAttachChildren, doDetachChildren, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getLayout, getLayoutTarget, getWidget, indexOf, isLayoutNeeded, iterator, layout, layout, notifyHide, notifyShow, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, removeAll, removeAll, scrollIntoView, setLayout, setLayoutNeeded, setLayoutOnChange, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetach, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sm

protected DataView.DataViewSelectionModel sm
Deprecated. 
The view's selection model.

Constructor Detail

DataView

public DataView()
Deprecated. 
Creates a new data view.


DataView

public DataView(Template template)
Deprecated. 
Creates a new data view with the given template.

Parameters:
template - the template
Method Detail

add

public boolean add(DataViewItem component)
Deprecated. 
Description copied from class: Container
Adds a item to the container. Fires the BeforeAdd event before inserting, then fires the Add event after the widget has been inserted.

Overrides:
add in class Container<DataViewItem>
Parameters:
component - the item to be added

getBinder

public DataViewBinder<?> getBinder()
Deprecated. 
Returns the view's binder. Only applies when set setStore(ListStore) is used.

Returns:
the binder

getContainerTagName

public java.lang.String getContainerTagName()
Deprecated. 
Returns the container's tag name.

Returns:
the container tag name

getContextMenu

public Menu getContextMenu()
Deprecated. 
Description copied from class: Component
Returns the component's context menu.

Overrides:
getContextMenu in class Component
Returns:
the context menu

getDefaultTemplate

public java.lang.String getDefaultTemplate()
Deprecated. 
Returns the default template.

Returns:
the default template

getItemSelector

public java.lang.String getItemSelector()
Deprecated. 
Returns the item selector.

Returns:
the selector

getOverStyle

public java.lang.String getOverStyle()
Deprecated. 
Returns the over style.

Returns:
the over style

getSelectedItem

public DataViewItem getSelectedItem()
Deprecated. 
Description copied from interface: Selectable
Returns the selected item.

Specified by:
getSelectedItem in interface Selectable<DataViewItem>
Returns:
the selected item

getSelectedItems

public java.util.List<DataViewItem> getSelectedItems()
Deprecated. 
Description copied from interface: Selectable
Returns the selected items. For single-select, the last selected item is returned.

Specified by:
getSelectedItems in interface Selectable<DataViewItem>
Returns:
the selected items

getSelectionMode

public Style.SelectionMode getSelectionMode()
Deprecated. 
Returns the view's selection mode.

Returns:
the selection mode.

getSelectionModel

public DataView.DataViewSelectionModel getSelectionModel()
Deprecated. 
Returns the view's selection model.

Returns:
the selection model

getSelectOnOver

public boolean getSelectOnOver()
Deprecated. 
Returns true if select on hover is enabled.

Returns:
the select on hover state

getSelectStyle

public java.lang.String getSelectStyle()
Deprecated. 
Returns the select style.

Returns:
the select style

getTemplate

public Template getTemplate()
Deprecated. 
Returns the view's template.

Returns:
the template

insert

public boolean insert(DataViewItem item,
                      int index)
Deprecated. 
Description copied from class: Container
Adds a item into the container. Fires the BeforeAdd event before inserting, then fires the Add event after the widget has been inserted.

Overrides:
insert in class Container<DataViewItem>
Parameters:
item - the item to insert
index - the insert location

onComponentEvent

public void onComponentEvent(ComponentEvent ce)
Deprecated. 
Description copied from class: Component
Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:
onComponentEvent in class ScrollContainer<DataViewItem>
Parameters:
ce - the base event

onSelectChange

public void onSelectChange(DataViewItem item,
                           boolean select)
Deprecated. 
Description copied from interface: Selectable
Called when the visual state of a item is changed.

Specified by:
onSelectChange in interface Selectable<DataViewItem>
Parameters:
item - the item
select - the select state

remove

public boolean remove(DataViewItem component)
Deprecated. 
Description copied from class: Container
Removes the item from the container. Fires the BeforeRemove event before removing, then fires the Remove event after the widget has been removed.

Overrides:
remove in class Container<DataViewItem>
Parameters:
component - the item to remove
Returns:
true if the item was removed

setContainerTagName

public void setContainerTagName(java.lang.String containerTagName)
Deprecated. 
Sets the container's tag name (defaults to 'div', pre-render).

Parameters:
containerTagName -

setContextMenu

public void setContextMenu(Menu menu)
Deprecated. 
Description copied from class: Component
Sets the component's context menu.

Overrides:
setContextMenu in class Component
Parameters:
menu - the context menu

setDefaultTemplate

public void setDefaultTemplate(java.lang.String defaultTemplate)
Deprecated. 
Sets the default template.

Parameters:
defaultTemplate - the default template

setItemSelector

public void setItemSelector(java.lang.String itemSelector)
Deprecated. 
This is a required setting. A simple CSS selector (e.g. div.some-class or span:first-child) that will be used to determine what nodes this DataView will be working with (defaults to 'x-view-item').

Parameters:
itemSelector - the item selector

setOverStyle

public void setOverStyle(java.lang.String overStyle)
Deprecated. 
Sets the style name to be applied on mouse over (defaults to 'x-view-item-over').

Parameters:
overStyle - the over style

setSelectedItem

public void setSelectedItem(DataViewItem item)
Deprecated. 
Description copied from interface: Selectable
Selects the item. Any existing selections are cleared.

Specified by:
setSelectedItem in interface Selectable<DataViewItem>
Parameters:
item - the item to select

setSelectedItems

public void setSelectedItems(java.util.List<DataViewItem> items)
Deprecated. 
Description copied from interface: Selectable
Selects the items. Only the first item is selected for single-select. Any existing selections are cleared.

Specified by:
setSelectedItems in interface Selectable<DataViewItem>
Parameters:
items - the items to select

setSelectionMode

public void setSelectionMode(Style.SelectionMode mode)
Deprecated. 
Sets the list's selection mode.

Parameters:
mode - the selection mode

setSelectOnOver

public void setSelectOnOver(boolean selectOnHover)
Deprecated. 
True to select the item when mousing over a element (defaults to false).

Parameters:
selectOnHover - true to select on mouse over

setSelectStyle

public void setSelectStyle(java.lang.String selectStyle)
Deprecated. 
The style to be applied to each selected item (defaults to 'x-view-item-sel').

Parameters:
selectStyle - the select style

setStore

public void setStore(ListStore store)
Deprecated. 
Convenience method that create a new DataViewBinder using the given store.

Parameters:
store - the store

setTemplate

public void setTemplate(java.lang.String html)
Deprecated. 
Sets the view's template.

Parameters:
html - the HTML fragment

setTemplate

public void setTemplate(Template template)
Deprecated. 
Sets the view's template.

Parameters:
template - the template

bulkRenderItem

protected java.lang.String bulkRenderItem(DataViewItem item)
Deprecated. 

createComponentEvent

protected ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
Deprecated. 
Overrides:
createComponentEvent in class BoxComponent

createContainerEvent

protected ContainerEvent createContainerEvent(DataViewItem item)
Deprecated. 
Overrides:
createContainerEvent in class Container<DataViewItem>

onMouseOut

protected void onMouseOut(DataViewItem item)
Deprecated. 

onMouseOver

protected void onMouseOver(DataViewItem item)
Deprecated. 

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Deprecated. 
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location

renderAll

protected void renderAll()
Deprecated. 

renderItem

protected void renderItem(DataViewItem item,
                          int index)
Deprecated. 

setSelectionModel

protected void setSelectionModel(DataView.DataViewSelectionModel sm)
Deprecated.