qnx.display.Scroller

Scroller

Properties | Methods | Events


Packageqnx.display
Classpublic class Scroller
InheritanceScroller Inheritance flash.events.EventDispatcher



Class information:
PlayBook Tablet OS Version:   1.0.6



Public Properties

 PropertyDefined By
  documentHeight : int
The height of the document being scrolled.
Scroller
  documentWidth : int
The width of the document being scrolled.
Scroller
  isScrolling : Boolean
[read-only] true if the document is currently being scrolled
Scroller
  isZooming : Boolean
[read-only] true if the document is currently being zoomed
Scroller
  minZoom : Number
The current minimum zoom factor of the document.
Scroller
  scrollPosition : Point
The current scroll position of the document.
Scroller
  viewPort : Rectangle
The viewport associated with the scroller.
Scroller
  window : NativeWindow
The NativeWindow associated with the Scroller.
Scroller
  zoom : Number
The current zoom factor of the document.
Scroller
  zoomCenter : Point
[read-only] The center point of the zoomed area.
Scroller

Public Methods

 MethodDefined By
  
Scroller
  
stop():void
Stop scrolling/zooming the document
Scroller

Events

 Event Summary Defined By
   Event indicating that a scroller is now active meaning that the scroll position or zoom factor are changing.Scroller
   Event indicating that a scroller is no longer active.Scroller

Property Detail

documentHeight


documentHeight:int

The height of the document being scrolled.


Implementation

public function get documentHeight():int
public function set documentHeight(value:int):void

documentWidth


documentWidth:int

The width of the document being scrolled.


Implementation

public function get documentWidth():int
public function set documentWidth(value:int):void

isScrolling


isScrolling:Boolean  [read-only]

true if the document is currently being scrolled


Implementation

public function get isScrolling():Boolean

isZooming


isZooming:Boolean  [read-only]

true if the document is currently being zoomed


Implementation

public function get isZooming():Boolean

minZoom


minZoom:Number

The current minimum zoom factor of the document.


Implementation

public function get minZoom():Number
public function set minZoom(value:Number):void

scrollPosition


scrollPosition:Point

The current scroll position of the document.


Implementation

public function get scrollPosition():Point
public function set scrollPosition(value:Point):void

viewPort


viewPort:Rectangle

The viewport associated with the scroller. The scroller will act upon all touch/mouse events that occur within the viewport.


Implementation

public function get viewPort():Rectangle
public function set viewPort(value:Rectangle):void

window


window:NativeWindow

The NativeWindow associated with the Scroller. Touch/mouse events on this window are passed to the scroller automatically.


Implementation

public function get window():NativeWindow
public function set window(value:NativeWindow):void

zoom


zoom:Number

The current zoom factor of the document.


Implementation

public function get zoom():Number
public function set zoom(value:Number):void

zoomCenter


zoomCenter:Point  [read-only]

The center point of the zoomed area.


Implementation

public function get zoomCenter():Point

Constructor Detail

Scroller()


public function Scroller()



Method Detail

stop()


public function stop():void

Stop scrolling/zooming the document

Event Detail

active


Event Object Type: qnx.events.ScrollerEvent
ScrollerEvent.type property = qnx.events.ScrollerEvent.ACTIVE

Event indicating that a scroller is now active meaning that the scroll position or zoom factor are changing.

inactive


Event Object Type: qnx.events.ScrollerEvent
ScrollerEvent.type property = qnx.events.ScrollerEvent.INACTIVE

Event indicating that a scroller is no longer active.