com.vaadin.terminal.gwt.client.ui
Class TouchScrollDelegate.TouchScrollHandler

java.lang.Object
  com.vaadin.terminal.gwt.client.ui.TouchScrollDelegate.TouchScrollHandler

All Implemented Interfaces:

com.google.gwt.event.dom.client.TouchStartHandler, com.google.gwt.event.shared.EventHandler

Enclosing class:

TouchScrollDelegate

public static class TouchScrollDelegate.TouchScrollHandler
extends Object
implements com.google.gwt.event.dom.client.TouchStartHandler

A helper class for making a widget scrollable. Uses native scrolling if supported by the browser, otherwise registers a touch start handler delegating to a TouchScrollDelegate instance.

Constructor Summary

TouchScrollDelegate.TouchScrollHandler(com.google.gwt.user.client.ui.Widget widget, com.google.gwt.dom.client.Element... scrollables)
Constructs a scroll handler for the given widget.

Method Summary

void	addElement(com.google.gwt.dom.client.Element scrollable) Registers the given element as scrollable.
void	debug(com.google.gwt.dom.client.Element e)
void	onTouchStart(com.google.gwt.event.dom.client.TouchStartEvent event)
void	removeElement(com.google.gwt.dom.client.Element scrollable) Unregisters the given element as scrollable.
void	setElements(com.google.gwt.dom.client.Element... scrollables) Registers the given elements as scrollable, removing previously registered scrollables from this handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TouchScrollDelegate.TouchScrollHandler

public TouchScrollDelegate.TouchScrollHandler(com.google.gwt.user.client.ui.Widget widget,
                                              com.google.gwt.dom.client.Element... scrollables)

Constructs a scroll handler for the given widget.

Parameters:

widget - The widget that contains scrollable elements

scrollables - The elements of the widget that should be scrollable.

Method Detail

onTouchStart

public void onTouchStart(com.google.gwt.event.dom.client.TouchStartEvent event)

Specified by:

onTouchStart in interface com.google.gwt.event.dom.client.TouchStartHandler

debug

public void debug(com.google.gwt.dom.client.Element e)

addElement

public void addElement(com.google.gwt.dom.client.Element scrollable)

Registers the given element as scrollable.

removeElement

public void removeElement(com.google.gwt.dom.client.Element scrollable)

Unregisters the given element as scrollable. Should be called when a previously-registered element is removed from the DOM to prevent memory leaks.

setElements

public void setElements(com.google.gwt.dom.client.Element... scrollables)

Registers the given elements as scrollable, removing previously registered scrollables from this handler.

Parameters:

scrollables - The elements that should be scrollable