AbstractTouchEventHandler (library API)

java.lang.Object
- de.mrapp.android.tabswitcher.gesture.AbstractTouchEventHandler

All Implemented Interfaces:

java.util.Comparator<AbstractTouchEventHandler>

Direct Known Subclasses:

AbstractDragGestureEventHandler, AbstractDragTabsEventHandler
```
public abstract class AbstractTouchEventHandler
extends java.lang.Object
implements java.util.Comparator<AbstractTouchEventHandler>
```
An abstract base class for all event handlers, which can be managed by a TouchEventDispatcher in order to dispatch touch events to them.

Since:

1.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`MAX_PRIORITY` The maximum priority of an event handler.
`protected static int`	`MIN_PRIORITY` The minimum priority of an event handler.

Constructor Summary

Constructors
Constructor and Description
`AbstractTouchEventHandler(int priority, TabSwitcher tabSwitcher, int dragThreshold)` Creates a new handler, which can be managed by a `TouchEventDispatcher` in order to dispatch touch events to it.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compare(AbstractTouchEventHandler o1, AbstractTouchEventHandler o2)`
`boolean`	`equals(java.lang.Object obj)`
`DragHelper`	`getDragHelper()` Returns the drag helper, which is used by the event handler to recognize drag gestures.
`int`	`getPriority()` Returns the priority of the event handler.
`protected TabSwitcher`	`getTabSwitcher()` Returns the tab switcher, the event handler belongs to.
`android.graphics.RectF`	`getTouchableArea()` Returns the bounds of the onscreen area, the handler takes into consideration for handling touch events.
`protected android.view.VelocityTracker`	`getVelocityTracker()` The velocity tracker, which is used by the touch handler to measure the velocity of drag gestures.
`boolean`	`handleTouchEvent(android.view.MotionEvent event)` Handles a specific touch event.
`int`	`hashCode()`
`boolean`	`isDragging()` Returns, whether a drag gesture is currently handled by the event handler, or not.
`protected abstract boolean`	`isDraggingAllowed()` Returns, whether performing a drag gesture is currently allowed, or not.
`boolean`	`isInsideTouchableArea(android.view.MotionEvent event)` Returns, whether a specific touch event occurred inside the touchable area of the event handler.
`boolean`	`isReset()` Returns, whether the event handler is reset, or not.
`protected abstract void`	`onDown(android.view.MotionEvent event)` The method, which is invoked on implementing subclasses in order to handle, when a drag gesture has been started.
`protected abstract void`	`onDrag(android.view.MotionEvent event)` The method, which is invoked on implementing subclasses in order to handle, when a drag gesture is performed.
`protected abstract void`	`onTouchEvent()` The method, which is invoked on implementing subclasses, when a touch event is about to be handled.
`protected abstract void`	`onUp(android.view.MotionEvent event)` Handles, when a drag gesture has been ended.
`protected void`	`reset()` Resets the event handler once a drag gesture has been ended.
`void`	`setPointerId(int pointerId)` Sets the id of the pointer, which has been used to start the current drag gesture.

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

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Field Detail
  - MAX_PRIORITY
```
protected static final int MAX_PRIORITY
```
    The maximum priority of an event handler.
    
    See Also:
    
    Constant Field Values
  - MIN_PRIORITY
```
protected static final int MIN_PRIORITY
```
    The minimum priority of an event handler.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractTouchEventHandler
```
public AbstractTouchEventHandler(int priority,
                                 TabSwitcher tabSwitcher,
                                 int dragThreshold)
```
    Creates a new handler, which can be managed by a TouchEventDispatcher in order to dispatch touch events to it.
    
    Parameters:
    
    priority - The priority of the handler as an Integer value. The priority must be at least MIN_PRIORITY and at maximum MAX_PRIORITY
    
    tabSwitcher - The tab switcher, the event handler belongs to, as an instance of the class TabSwitcher. The tab switcher may not be null
    
    dragThreshold - The threshold of the drag helper, which is used to recognize drag gestures, in pixels as an Integer value The threshold must be at least 0
- Method Detail
  - getTabSwitcher
```
protected final TabSwitcher getTabSwitcher()
```
    Returns the tab switcher, the event handler belongs to.
    
    Returns:
    
    The tab switcher, the event handler belongs to, as an instance of the class TabSwitcher. The tab switcher may not be null
  - getVelocityTracker
```
protected final android.view.VelocityTracker getVelocityTracker()
```
    The velocity tracker, which is used by the touch handler to measure the velocity of drag gestures.
    
    Returns:
    
    The velocity tracker, which is used by the touch handler to measure the velocity of drag gestures as an instance of the class VelocityTracker or null, if the velocity tracker has not be initialized yet
  - reset
```
protected void reset()
```
    Resets the event handler once a drag gesture has been ended.
  - isDraggingAllowed
```
protected abstract boolean isDraggingAllowed()
```
    Returns, whether performing a drag gesture is currently allowed, or not.
    
    Returns:
    
    True, if performing a drag gesture is currently allowed, false otherwise
  - onTouchEvent
```
protected abstract void onTouchEvent()
```
    The method, which is invoked on implementing subclasses, when a touch event is about to be handled.
  - onDown
```
protected abstract void onDown(android.view.MotionEvent event)
```
    The method, which is invoked on implementing subclasses in order to handle, when a drag gesture has been started.
    
    Parameters:
    
    event - The touch event, which started the drag gesture, as an instance of the class MotionEvent. The touch event may not be null
  - onDrag
```
protected abstract void onDrag(android.view.MotionEvent event)
```
    The method, which is invoked on implementing subclasses in order to handle, when a drag gesture is performed.
    
    Parameters:
    
    event - The last touch event of the drag gesture as an instance of the class MotionEvent. The touch event may not be null
  - onUp
```
protected abstract void onUp(android.view.MotionEvent event)
```
    Handles, when a drag gesture has been ended.
    
    Parameters:
    
    event - The touch event, which ended the drag gesture, as an instance of the class MotionEvent or null, if no fling animation should be triggered
  - isReset
```
public final boolean isReset()
```
    Returns, whether the event handler is reset, or not.
    
    Returns:
    
    True, if the event handler is reset, false otherwise
  - isDragging
```
public boolean isDragging()
```
    Returns, whether a drag gesture is currently handled by the event handler, or not. This method may be overridden by subclasses, if multiple drag helpers are used.
    
    Returns:
    
    True, if a drag gesture is currently handled by the event handler, false otherwise
  - getPriority
```
public final int getPriority()
```
    Returns the priority of the event handler. Events are first dispatched to handlers with a higher priority.
    
    Returns:
    
    The priority of the event handler as an Integer value
  - getTouchableArea
```
public android.graphics.RectF getTouchableArea()
```
    Returns the bounds of the onscreen area, the handler takes into consideration for handling touch events. Touch events that occur outside of the area are clipped. By default, the area is not restricted. Subclasses may override this method in order to restrict the area.
    
    Returns:
    
    The bounds of the onscreen area, the handler takes into consideration for handling touch events, as an instance of the class RectF or null, if the area is not restricted
  - isInsideTouchableArea
```
public final boolean isInsideTouchableArea(android.view.MotionEvent event)
```
    Returns, whether a specific touch event occurred inside the touchable area of the event handler.
    
    Parameters:
    
    event - The touch event, which should be checked, as an instance of the class MotionEvent. The touch event may not be null
    
    Returns:
    
    True, if the given touch event occurred inside the touchable area, false otherwise
  - getDragHelper
```
public final DragHelper getDragHelper()
```
    Returns the drag helper, which is used by the event handler to recognize drag gestures.
    
    Returns:
    
    The drag helper, which is used by the event handler to recognize drag gestures, as an instance of the class DragHelper. The drag helper may not be null
  - setPointerId
```
public final void setPointerId(int pointerId)
```
    Sets the id of the pointer, which has been used to start the current drag gesture.
    
    Parameters:
    
    pointerId - The id, which should be set, as an Integer value or -1, if no drag gesture is currently started
  - handleTouchEvent
```
public final boolean handleTouchEvent(android.view.MotionEvent event)
```
    Handles a specific touch event. The event is only handled, if it occurred inside the touchable area.
    
    Parameters:
    
    event - The event, which should be handled, as an instance of the class MotionEvent. The event may not be null
    
    Returns:
    
    True, if the event has been handled, false otherwise
  - compare
```
public final int compare(AbstractTouchEventHandler o1,
                         AbstractTouchEventHandler o2)
```
    Specified by:
    
    compare in interface java.util.Comparator<AbstractTouchEventHandler>
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public final boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface java.util.Comparator<AbstractTouchEventHandler>
    
    Overrides:
    
    equals in class java.lang.Object

Class AbstractTouchEventHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Field Detail

MAX_PRIORITY

MIN_PRIORITY

Constructor Detail

AbstractTouchEventHandler

Method Detail

getTabSwitcher

getVelocityTracker

reset

isDraggingAllowed

onTouchEvent

onDown

onDrag

onUp

isReset

isDragging

getPriority

getTouchableArea

isInsideTouchableArea

getDragHelper

setPointerId

handleTouchEvent

compare

hashCode

equals