org.mozilla.geckoview

Class PanZoomController

Object

org.mozilla.geckoview.PanZoomController

@UiThread
public class PanZoomController
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PanZoomController.InputResultDetail Represents how a MotionEvent was handled in Gecko.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INPUT_RESULT_HANDLED Specifies that an input event was handled by the PanZoomController for a panning or zooming operation, but likely not by any touch event listeners in Web content.
static int	INPUT_RESULT_HANDLED_CONTENT Specifies that an input event was handled by the PanZoomController and passed on to touch event listeners in Web content.
static int	INPUT_RESULT_IGNORED Specifies that an input event was consumed by a PanZoomController internally and browsers should do nothing in response to the event.
static int	INPUT_RESULT_UNHANDLED Specifies that an input event was not handled by the PanZoomController for a panning or zooming operation.
static int	OVERSCROLL_FLAG_HORIZONTAL
static int	OVERSCROLL_FLAG_NONE Represents which directions can be over-scrolled in the scroll container where an input event was handled.
static int	OVERSCROLL_FLAG_VERTICAL
static int	SCROLL_BEHAVIOR_AUTO Specifies auto scrolling which jumps content to the desired scroll position.
static int	SCROLL_BEHAVIOR_SMOOTH Specifies smooth scrolling which animates content to the desired scroll position.
static int	SCROLLABLE_FLAG_BOTTOM
static int	SCROLLABLE_FLAG_LEFT
static int	SCROLLABLE_FLAG_NONE Represents which directions can be scrolled in the scroll container where an input event was handled.
static int	SCROLLABLE_FLAG_RIGHT
static int	SCROLLABLE_FLAG_TOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PanZoomController(GeckoSession session)

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
float	getScrollFactor() Get the current scroll factor.
void	onMotionEvent(MotionEvent event) Process a non-touch motion event through the pan-zoom controller.
void	onMouseEvent(MotionEvent event) Process a touch event through the pan-zoom controller.
void	onTouchEvent(MotionEvent event) Process a touch event through the pan-zoom controller.
GeckoResult<PanZoomController.InputResultDetail>	onTouchEventForDetailResult(MotionEvent event) Process a touch event through the pan-zoom controller.
GeckoResult<Integer>	onTouchEventForResult(MotionEvent event) Deprecated.
void	scrollBy(ScreenLength width, ScreenLength height) Scroll the document body by an offset from the current scroll position.
void	scrollBy(ScreenLength width, ScreenLength height, int behavior) Scroll the document body by an offset from the current scroll position.
void	scrollTo(ScreenLength width, ScreenLength height) Scroll the document body to an absolute position.
void	scrollTo(ScreenLength width, ScreenLength height, int behavior) Scroll the document body to an absolute position.
void	scrollToBottom() Scroll to the bottom left corner of the screen.
void	scrollToTop() Scroll to the top left corner of the screen.
void	setIsLongpressEnabled(boolean isLongpressEnabled) Set whether Gecko should generate long-press events.
void	setScrollFactor(float factor) Set the current scroll factor.

Methods inherited from class Object

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

Field Detail

SCROLL_BEHAVIOR_SMOOTH

public static final int SCROLL_BEHAVIOR_SMOOTH

Specifies smooth scrolling which animates content to the desired scroll position.

See Also:

Constant Field Values

SCROLL_BEHAVIOR_AUTO

public static final int SCROLL_BEHAVIOR_AUTO

Specifies auto scrolling which jumps content to the desired scroll position.

See Also:

Constant Field Values

INPUT_RESULT_UNHANDLED

public static final int INPUT_RESULT_UNHANDLED

Specifies that an input event was not handled by the PanZoomController for a panning or zooming operation. The event may have been handled by Web content or internally (e.g. text selection).

See Also:

Constant Field Values

INPUT_RESULT_HANDLED

public static final int INPUT_RESULT_HANDLED

Specifies that an input event was handled by the PanZoomController for a panning or zooming operation, but likely not by any touch event listeners in Web content.

See Also:

Constant Field Values

INPUT_RESULT_HANDLED_CONTENT

public static final int INPUT_RESULT_HANDLED_CONTENT

Specifies that an input event was handled by the PanZoomController and passed on to touch event listeners in Web content.

See Also:

Constant Field Values

INPUT_RESULT_IGNORED

public static final int INPUT_RESULT_IGNORED

Specifies that an input event was consumed by a PanZoomController internally and browsers should do nothing in response to the event.

See Also:

Constant Field Values

SCROLLABLE_FLAG_NONE

public static final int SCROLLABLE_FLAG_NONE

Represents which directions can be scrolled in the scroll container where an input event was handled. This value is only useful in the case of INPUT_RESULT_HANDLED.

See Also:

Constant Field Values

SCROLLABLE_FLAG_TOP

public static final int SCROLLABLE_FLAG_TOP

See Also:

Constant Field Values

SCROLLABLE_FLAG_RIGHT

public static final int SCROLLABLE_FLAG_RIGHT

See Also:

Constant Field Values

SCROLLABLE_FLAG_BOTTOM

public static final int SCROLLABLE_FLAG_BOTTOM

See Also:

Constant Field Values

SCROLLABLE_FLAG_LEFT

public static final int SCROLLABLE_FLAG_LEFT

See Also:

Constant Field Values

OVERSCROLL_FLAG_NONE

public static final int OVERSCROLL_FLAG_NONE

Represents which directions can be over-scrolled in the scroll container where an input event was handled. This value is only useful in the case of INPUT_RESULT_HANDLED.

See Also:

Constant Field Values

OVERSCROLL_FLAG_HORIZONTAL

public static final int OVERSCROLL_FLAG_HORIZONTAL

See Also:

Constant Field Values

OVERSCROLL_FLAG_VERTICAL

public static final int OVERSCROLL_FLAG_VERTICAL

See Also:

Constant Field Values

Constructor Detail

PanZoomController

protected PanZoomController(GeckoSession session)

Method Detail

setScrollFactor

public void setScrollFactor(float factor)

Set the current scroll factor. The scroll factor is the maximum scroll amount that one scroll event may generate, in device pixels.

Parameters:

factor - Scroll factor.

getScrollFactor

public float getScrollFactor()

Get the current scroll factor.

Returns:

Scroll factor.

onTouchEvent

public void onTouchEvent(@NonNull
                         MotionEvent event)

Process a touch event through the pan-zoom controller. Treat any mouse events as "touch" rather than as "mouse". Pointer coordinates should be relative to the display surface.

Parameters:

event - MotionEvent to process.

onTouchEventForResult

@Deprecated
 @DeprecationSchedule(version=90,
                     id="on-touch-event-for-result")
 @NonNull
public GeckoResult<Integer> onTouchEventForResult(@NonNull
                                                                                                                                                               MotionEvent event)

Deprecated.

Process a touch event through the pan-zoom controller. Treat any mouse events as "touch" rather than as "mouse". Pointer coordinates should be relative to the display surface. NOTE: It is highly recommended to only call this with ACTION_DOWN or in otherwise limited capacity. Returning a GeckoResult for every touch event will generate a lot of allocations and unnecessary GC pressure. Instead, prefer to call onTouchEvent(MotionEvent).

Parameters:

event - MotionEvent to process.

Returns:

A GeckoResult resolving to one of the INPUT_RESULT_*) constants indicating how the event was handled.

onTouchEventForDetailResult

@NonNull
public GeckoResult<PanZoomController.InputResultDetail> onTouchEventForDetailResult(@NonNull
                                                                                             MotionEvent event)

Process a touch event through the pan-zoom controller. Treat any mouse events as "touch" rather than as "mouse". Pointer coordinates should be relative to the display surface. NOTE: It is highly recommended to only call this with ACTION_DOWN or in otherwise limited capacity. Returning a GeckoResult for every touch event will generate a lot of allocations and unnecessary GC pressure. Instead, prefer to call onTouchEvent(MotionEvent).

Parameters:

event - MotionEvent to process.

Returns:

A GeckoResult resolving to PanZoomController.InputResultDetail).

onMouseEvent

public void onMouseEvent(@NonNull
                         MotionEvent event)

Process a touch event through the pan-zoom controller. Treat any mouse events as "mouse" rather than as "touch". Pointer coordinates should be relative to the display surface.

Parameters:

event - MotionEvent to process.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

onMotionEvent

public void onMotionEvent(@NonNull
                          MotionEvent event)

Process a non-touch motion event through the pan-zoom controller. Currently, hover and scroll events are supported. Pointer coordinates should be relative to the display surface.

Parameters:

event - MotionEvent to process.

setIsLongpressEnabled

public void setIsLongpressEnabled(boolean isLongpressEnabled)

Set whether Gecko should generate long-press events.

Parameters:

isLongpressEnabled - True if Gecko should generate long-press events.

scrollBy

@UiThread
public void scrollBy(@NonNull
                               ScreenLength width,
                               @NonNull
                               ScreenLength height)

Scroll the document body by an offset from the current scroll position. Uses SCROLL_BEHAVIOR_SMOOTH.

Parameters:

width - ScreenLength offset to scroll along X axis.

height - ScreenLength offset to scroll along Y axis.

scrollBy

@UiThread
public void scrollBy(@NonNull
                               ScreenLength width,
                               @NonNull
                               ScreenLength height,
                               int behavior)

Scroll the document body by an offset from the current scroll position.

Parameters:

width - ScreenLength offset to scroll along X axis.

height - ScreenLength offset to scroll along Y axis.

behavior - ScrollBehaviorType One of SCROLL_BEHAVIOR_SMOOTH, SCROLL_BEHAVIOR_AUTO, that specifies how to scroll the content.

scrollTo

@UiThread
public void scrollTo(@NonNull
                               ScreenLength width,
                               @NonNull
                               ScreenLength height)

Scroll the document body to an absolute position. Uses SCROLL_BEHAVIOR_SMOOTH.

Parameters:

width - ScreenLength position to scroll along X axis.

height - ScreenLength position to scroll along Y axis.

scrollTo

@UiThread
public void scrollTo(@NonNull
                               ScreenLength width,
                               @NonNull
                               ScreenLength height,
                               int behavior)

Scroll the document body to an absolute position.

Parameters:

width - ScreenLength position to scroll along X axis.

height - ScreenLength position to scroll along Y axis.

behavior - ScrollBehaviorType One of SCROLL_BEHAVIOR_SMOOTH, SCROLL_BEHAVIOR_AUTO, that specifies how to scroll the content.

scrollToTop

@UiThread
public void scrollToTop()

Scroll to the top left corner of the screen. Uses SCROLL_BEHAVIOR_SMOOTH.

scrollToBottom

@UiThread
public void scrollToBottom()

Scroll to the bottom left corner of the screen. Uses SCROLL_BEHAVIOR_SMOOTH.