UIGestureRecognizer (cmioslayer 3.4.0 API)

java.lang.Object
- crossmobile.ios.foundation.NSObject
- - crossmobile.ios.uikit.UIGestureRecognizer

Direct Known Subclasses:

UILongPressGestureRecognizer, UIPanGestureRecognizer, UIPinchGestureRecognizer, UIRotationGestureRecognizer, UISwipeGestureRecognizer, UITapGestureRecognizer
```
public abstract class UIGestureRecognizer
extends NSObject
```
UIGestureRecognizer is an abstract class that recognizes series of touches as gestures along with the changes that occur to these gestures. It is responsible to send this information to related objects that will handle it appropriately.

Constructor Summary

Constructors
Constructor and Description

UIGestureRecognizer(NSSelector<UIGestureRecognizer> target)
Constructs a UIGestureRecognizer and associates it with the specified target.

Constructors
Constructor and Description
`UIGestureRecognizer(NSSelector<UIGestureRecognizer> target)` Constructs a UIGestureRecognizer and associates it with the specified target.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTarget(NSSelector<UIGestureRecognizer> target)` Adds the target defined as parameter to this UIGestureRecognizer.
`abstract boolean`	`canBePreventedByGestureRecognizer(UIGestureRecognizer preventing)` Override this method so that the specified UIGestureRecognizer prevents this UIGestureRecognizer from recognizing a gesture.
`boolean`	`cancelsTouchesInView()` Returns a Boolean that shows whether touches are passed to a view when an event is perceived as a gesture.
`abstract boolean`	`canPreventGestureRecognizer(UIGestureRecognizer preventing)` Override this method so that this UIGestureRecognizer prevents the specified UIGestureRecognizer from recognizing a gesture.
`boolean`	`delaysTouchesBegan()` Returns a Boolean that shows whether there is an initial delay in sending touches to the view for this UIGestureRecognizer.
`boolean`	`delaysTouchesEnded()` Returns a Boolean that shows whether there is a delay in sending touches to the view, at the end of the phase, for this UIGestureRecognizer.
`UIGestureRecognizerDelegate`	`delegate()` Returns the delegate object for this UIGestureRecognizer.
`boolean`	`isEnabled()` Returns a Boolean that shows whether this UIGestureRecognizer is enabled or not.
`CGPoint`	`locationInView(UIView view)` Returns the location of the gesture for this receiver, expressed in the coordinate system of the view that is passed as parameter.
`CGPoint`	`locationOfTouch(int touch, UIView view)` Returns the location of the touch parameter expressed in the coordinate system of the view that is passed as parameter.
`int`	`numberOfTouches()` Returns the number of touches that constitute this gesture.
`void`	`removeTarget(NSSelector<UIGestureRecognizer> target)` Removes the target defined as parameter from this UIGestureRecognizer.
`void`	`requireGestureRecognizerToFail(UIGestureRecognizer other)` Connects this UIGestureRecognizer with corresponding that is passed as parameter.
`void`	`reset()` Resets internal state when the gesture recognition is completed.
`void`	`setCancelsTouchesInView(boolean cancelsTouchesInView)` Set a Boolean that defines whether touches are passed to a view when an event is perceived as a gesture.
`void`	`setDelaysTouchesBegan(boolean delaysTouchesBegan)` Sets a Boolean that defines whether there is an initial delay in sending touches to the view for this UIGestureRecognizer.
`void`	`setDelaysTouchesEnded(boolean delaysTouchesEnded)` Sets a Boolean that defines whether there is a delay in sending touches to the view, at the end of the phase, for this UIGestureRecognizer.
`void`	`setDelegate(UIGestureRecognizerDelegate delegate)` Sets the delegate object for this UIGestureRecognizer.
`void`	`setEnabled(boolean enabled)` Sets a Boolean that defines whether this UIGestureRecognizer is enabled or not.
`int`	`state()` Returns the current state for this UIGestureRecognizer.
`String`	`toString()`
`void`	`touchesBegan(Set<UITouch> touches, UIEvent event)` Informs this UIGestureRecognizer when one or more fingers touched down in the associated UIView.
`void`	`touchesCancelled(Set<UITouch> touches, UIEvent event)` Informs this UIGestureRecognizer that a touch event was canceled due to system event.
`void`	`touchesEnded(Set<UITouch> touches, UIEvent event)` Informs this UIGestureRecognizer when one or more fingers were lifted from the associated view.
`void`	`touchesMoved(Set<UITouch> touches, UIEvent event)` Informs this UIGestureRecognizer when one or more fingers were moved within the associated view.
`UIView`	`view()` Returns the view for this UIGestureRecognizer.

Methods inherited from class crossmobile.ios.foundation.NSObject
addObserver, observeValueForKeyPath, performSelector, performSelectorOnMainThread, release, removeObserver, removeObserver, retain, setValueForKey, setValueForUndefinedKey, valueForKey, valueForUndefinedKey

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

- Constructor Detail
  - UIGestureRecognizer
```
public UIGestureRecognizer(NSSelector<UIGestureRecognizer> target)
```
    Constructs a UIGestureRecognizer and associates it with the specified target.
    
    Parameters:
    
    target - The target of the new UIGestureRecognizer.
- Method Detail
  - addTarget
```
public void addTarget(NSSelector<UIGestureRecognizer> target)
```
    Adds the target defined as parameter to this UIGestureRecognizer.
    
    Parameters:
    
    target - The target to be added to the UIGestureRecognizer.
  - removeTarget
```
public void removeTarget(NSSelector<UIGestureRecognizer> target)
```
    Removes the target defined as parameter from this UIGestureRecognizer.
    
    Parameters:
    
    target - The target to be removed from this UIGestureRecognizer.
  - locationInView
```
public CGPoint locationInView(UIView view)
```
    Returns the location of the gesture for this receiver, expressed in the coordinate system of the view that is passed as parameter.
    
    Parameters:
    
    view - The view in whose coordinate system the location is defined.
    
    Returns:
    
    The location of the gesture for this receiver.
  - locationOfTouch
```
public CGPoint locationOfTouch(int touch,
                               UIView view)
```
    Returns the location of the touch parameter expressed in the coordinate system of the view that is passed as parameter.
    
    Parameters:
    
    touch - The touch for which the location is computed.
    
    view - The view in whose coordinate system the location is defined.
    
    Returns:
    
    The location of the touch.
  - numberOfTouches
```
public int numberOfTouches()
```
    Returns the number of touches that constitute this gesture.
    
    Returns:
    
    The number of touches that constitute this gesture.
  - view
```
public UIView view()
```
    Returns the view for this UIGestureRecognizer.
    
    Returns:
    
    The view for this UIGestureRecognizer.
  - delegate
```
public UIGestureRecognizerDelegate delegate()
```
    Returns the delegate object for this UIGestureRecognizer.
    
    Returns:
    
    The delegate object for this UIGestureRecognizer.
  - setDelegate
```
public void setDelegate(UIGestureRecognizerDelegate delegate)
```
    Sets the delegate object for this UIGestureRecognizer.
    
    Parameters:
    
    delegate - The delegate object for this UIGestureRecognizer.
  - isEnabled
```
public boolean isEnabled()
```
    Returns a Boolean that shows whether this UIGestureRecognizer is enabled or not.
    
    Returns:
    
    Boolean that shows whether this UIGestureRecognizer is enabled or not.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets a Boolean that defines whether this UIGestureRecognizer is enabled or not.
    
    Parameters:
    
    enabled - Boolean that defines whether this UIGestureRecognizer is enabled or not.
  - cancelsTouchesInView
```
public boolean cancelsTouchesInView()
```
    Returns a Boolean that shows whether touches are passed to a view when an event is perceived as a gesture.
    
    Returns:
    
    Boolean that shows whether touches are passed to a view when an event is perceived as a gesture.
  - setCancelsTouchesInView
```
public void setCancelsTouchesInView(boolean cancelsTouchesInView)
```
    Set a Boolean that defines whether touches are passed to a view when an event is perceived as a gesture.
    
    Parameters:
    
    cancelsTouchesInView - Boolean that defines whether touches are passed to a view when an event is perceived as a gesture.
  - delaysTouchesBegan
```
public boolean delaysTouchesBegan()
```
    Returns a Boolean that shows whether there is an initial delay in sending touches to the view for this UIGestureRecognizer.
    
    Returns:
    
    Boolean that shows whether there is an initial delay in sending touches to the view for this UIGestureRecognizer.
  - setDelaysTouchesBegan
```
public void setDelaysTouchesBegan(boolean delaysTouchesBegan)
```
    Sets a Boolean that defines whether there is an initial delay in sending touches to the view for this UIGestureRecognizer.
    
    Parameters:
    
    delaysTouchesBegan - Boolean that defines whether there is an initial delay in sending touches to the view for this UIGestureRecognizer.
  - delaysTouchesEnded
```
public boolean delaysTouchesEnded()
```
    Returns a Boolean that shows whether there is a delay in sending touches to the view, at the end of the phase, for this UIGestureRecognizer.
    
    Returns:
    
    Boolean that shows whether there is a delay in sending touches to the view, at the end of the phase, for this UIGestureRecognizer.
  - setDelaysTouchesEnded
```
public void setDelaysTouchesEnded(boolean delaysTouchesEnded)
```
    Sets a Boolean that defines whether there is a delay in sending touches to the view, at the end of the phase, for this UIGestureRecognizer.
    
    Parameters:
    
    delaysTouchesEnded - Boolean that shows whether there is a delay in sending touches to the view, at the end of the phase, for this UIGestureRecognizer.
  - state
```
public int state()
```
    Returns the current state for this UIGestureRecognizer.
    
    Returns:
    
    The current state for this UIGestureRecognizer.
  - requireGestureRecognizerToFail
```
public void requireGestureRecognizerToFail(UIGestureRecognizer other)
```
    Connects this UIGestureRecognizer with corresponding that is passed as parameter.
    
    Parameters:
    
    other - The UIGestureRecognizer that is to be connected to this.
  - reset
```
public void reset()
```
    Resets internal state when the gesture recognition is completed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - touchesBegan
```
public void touchesBegan(Set<UITouch> touches,
                         UIEvent event)
```
    Informs this UIGestureRecognizer when one or more fingers touched down in the associated UIView.
    
    Parameters:
    
    touches - The set of touches until the UITouchPhaseCancelled phase.
    
    event - The event to which the touches belong.
  - touchesMoved
```
public void touchesMoved(Set<UITouch> touches,
                         UIEvent event)
```
    Informs this UIGestureRecognizer when one or more fingers were moved within the associated view.
    
    Parameters:
    
    touches - The set of touches until the UITouchPhaseCancelled phase.
    
    event - The event to which the touches belong.
  - touchesEnded
```
public void touchesEnded(Set<UITouch> touches,
                         UIEvent event)
```
    Informs this UIGestureRecognizer when one or more fingers were lifted from the associated view.
    
    Parameters:
    
    touches - The set of touches until the UITouchPhaseCancelled phase.
    
    event - The event to which the touches belong.
  - touchesCancelled
```
public void touchesCancelled(Set<UITouch> touches,
                             UIEvent event)
```
    Informs this UIGestureRecognizer that a touch event was canceled due to system event.
    
    Parameters:
    
    touches - The set of touches until the UITouchPhaseCancelled phase.
    
    event - The event to which the touches belong.
  - canBePreventedByGestureRecognizer
```
public abstract boolean canBePreventedByGestureRecognizer(UIGestureRecognizer preventing)
```
    Override this method so that the specified UIGestureRecognizer prevents this UIGestureRecognizer from recognizing a gesture.
    
    Parameters:
    
    preventing - The UIGestureRecognizer that prevents this gesture recognizer from recognizing a gesture.
    
    Returns:
    
    TRUE then the specified UIGestureRecognizer is able to prevent the recognition of a gesture.
  - canPreventGestureRecognizer
```
public abstract boolean canPreventGestureRecognizer(UIGestureRecognizer preventing)
```
    Override this method so that this UIGestureRecognizer prevents the specified UIGestureRecognizer from recognizing a gesture.
    
    Parameters:
    
    preventing - The UIGestureRecognizer that is prevented from recognizing a gesture.
    
    Returns:
    
    TRUE then this UIGestureRecognizer is able to prevent the recognition of a gesture.

Class UIGestureRecognizer

Constructor Summary

Method Summary

Methods inherited from class crossmobile.ios.foundation.NSObject

Methods inherited from class java.lang.Object

Constructor Detail

UIGestureRecognizer

Method Detail

addTarget

removeTarget

locationInView

locationOfTouch

numberOfTouches

view

delegate

setDelegate

isEnabled

setEnabled

cancelsTouchesInView

setCancelsTouchesInView

delaysTouchesBegan

setDelaysTouchesBegan

delaysTouchesEnded

setDelaysTouchesEnded

state

requireGestureRecognizerToFail

reset

toString

touchesBegan

touchesMoved

touchesEnded

touchesCancelled

canBePreventedByGestureRecognizer

canPreventGestureRecognizer