Class SwipeEvents

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

UML class diagram of SwipeEvents
Legend
icon for a class in the UML class diagram class
icon for an abstract class in the UML class diagram abstract class
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property
icon for a private property in the UML class diagram private property
icon for a public method in the UML class diagram public method
icon for a protected method in the UML class diagram protected method
icon for a private method in the UML class diagram private method
italic abstract property/method

Hierarchy

Implements

Methods

finishBuild changeProperty equalsToID _removeEventListeners _setEventListeners _triggerSwipeDown _triggerSwipeLeft _triggerSwipeRight _triggerSwipeUp setA11YProperties setCallbacks setHtmlElements unsetCallbacks unsetHtmlElements EventGestureEnd EventGestureMove build dispose registerCallback

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId

Properties

_gestureMoveEvent _gestureStartEvent _swipableElement _swipeDownCallback _swipeLeftCallback _swipeRightCallback _swipeUpCallback _threshold _velocity

Constructors

constructor

Methods

Protected finishBuild

changeProperty

equalsToID

Private _removeEventListeners

Private _setEventListeners

Private _triggerSwipeDown

Private _triggerSwipeLeft

Private _triggerSwipeRight

Private _triggerSwipeUp

Protected setA11YProperties

Protected setCallbacks

Protected setHtmlElements

Protected unsetCallbacks

Protected unsetHtmlElements

EventGestureEnd

  • Based on the offset, this method triggers the methods on the platform

    Memberof

    OSFramework.Patterns.SwipeEvents.SwipeEvents

    Parameters

    • offsetX: number
    • offsetY: number
    • timeTaken: number

    Returns void

EventGestureMove

  • Block the default behaviour of the GestureMove

    Memberof

    OSFramework.Patterns.SwipeEvents.SwipeEvents

    Parameters

    • event: TouchEvent

    Returns void

build

dispose

registerCallback

  • Method used to register the provider callback

    Memberof

    OSFramework.Patterns.SwipeEvents.SwipeEvents

    Parameters

    • eventName: string

      Event name that will be assigned

    • callback: OSGeneric

      Function name that will be passed as a callback function to the event above

    Returns void

Accessors

Protected _enableAccessibility

  • get _enableAccessibility(): boolean
  • Protected

    Getter that allows to obtain the accessibility is enabled.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns boolean

selfElement

isBuilt

configs

  • get configs(): C

  • Current configurations/state of the pattern.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns C

uniqueId

widgetId

Properties

Private _gestureMoveEvent

_gestureMoveEvent: Generic

Private _gestureStartEvent

_gestureStartEvent: Generic

Private _swipableElement

_swipableElement: HTMLElement

Private _swipeDownCallback

_swipeDownCallback: Generic

Private _swipeLeftCallback

_swipeLeftCallback: Generic

Private _swipeRightCallback

_swipeRightCallback: Generic

Private _swipeUpCallback

_swipeUpCallback: Generic

Private _threshold

_threshold: number

Private _velocity

_velocity: number

Constructors

constructor

Settings

Member Visibility

Theme