Packageru.kozlovskij.air.mobile.iOS.text.softKeyboard
Classpublic final class SoftKeyboardDetector
InheritanceSoftKeyboardDetector Inheritance ru.kozlovskij.air.mobile.iOS.text.softKeyboard.EventDispatcherDisposable

Since : Oct 25. 2011

OS: only iOS 5.0 and higher. AIR: only AIR 3.0 and higher.



Public Properties
 PropertyDefined By
  keyboardAnimationWaitingTime : int
The time for waiting completion of native keyboard animation.
SoftKeyboardDetector
  relatedObject : Object
[read-only] return last related object - instance of StageText or TextField.
SoftKeyboardDetector
  returnKeyLabel : String
[read-only] Returning relatedObject.returnKeyLabel if it exists and implements StageText.
SoftKeyboardDetector
  softKeyboardType : String
[read-only] Returning relatedObject.softKeyboardType if it exists and implements StageText.
SoftKeyboardDetector
  viewType : uint
[read-only] iOS SoftKeyboard view type.
SoftKeyboardDetector
  viewTypeString : String
[read-only]
SoftKeyboardDetector
Public Methods
 MethodDefined By
  
SoftKeyboardDetector
  
dispatchEvent(event:Event):Boolean
[override]
SoftKeyboardDetector
  
dispose():void
[override]
SoftKeyboardDetector
  
initialize():void
SoftKeyboardDetector
  
listenStageText(field:StageText):void
This method using week reference and week keys.
SoftKeyboardDetector
  
unlistenStageText(field:StageText):void
SoftKeyboardDetector
Protected Methods
 MethodDefined By
  
globalActivityHandler(event:Event):void
SoftKeyboardDetector
Events
 Event Summary Defined By
  SoftKeyboardDetector
  SoftKeyboardDetector
  SoftKeyboardDetector
  SoftKeyboardDetector
  SoftKeyboardDetector
  Only for editable instances of TextField or StageText classes.SoftKeyboardDetector
Property Detail
keyboardAnimationWaitingTimeproperty
keyboardAnimationWaitingTime:int

The time for waiting completion of native keyboard animation. Recommended values range: from 400 to 800. Note: The higher the value - the more stable operation of the analyzer.


Implementation
    public function get keyboardAnimationWaitingTime():int
    public function set keyboardAnimationWaitingTime(value:int):void
relatedObjectproperty 
relatedObject:Object  [read-only]

return last related object - instance of StageText or TextField.


Implementation
    public function get relatedObject():Object
returnKeyLabelproperty 
returnKeyLabel:String  [read-only]

Returning relatedObject.returnKeyLabel if it exists and implements StageText. If not then will return null.


Implementation
    public function get returnKeyLabel():String
softKeyboardTypeproperty 
softKeyboardType:String  [read-only]

Returning relatedObject.softKeyboardType if it exists and implements StageText. If not then will return null.


Implementation
    public function get softKeyboardType():String
viewTypeproperty 
viewType:uint  [read-only]

iOS SoftKeyboard view type.


Implementation
    public function get viewType():uint

See also

viewTypeStringproperty 
viewTypeString:String  [read-only]


Implementation
    public function get viewTypeString():String
Constructor Detail
SoftKeyboardDetector()Constructor
public function SoftKeyboardDetector(stage:Stage)



Parameters
stage:Stage
Method Detail
dispatchEvent()method
override public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
dispose()method 
override public function dispose():void

globalActivityHandler()method 
protected function globalActivityHandler(event:Event):void

Parameters

event:Event

initialize()method 
public function initialize():void

listenStageText()method 
public function listenStageText(field:StageText):void

This method using week reference and week keys.

Parameters

field:StageText — editable instance of StageText class.

See also

unlistenStageText()method 
public function unlistenStageText(field:StageText):void

Parameters

field:StageText — editable and already listenig instance of StageText class.

See also

Event Detail
activateFlat Event
Event Object Type: ru.kozlovskij.air.mobile.iOS.text.softKeyboard.SoftKeyboardDetectorEvent

activateSplit Event  
Event Object Type: ru.kozlovskij.air.mobile.iOS.text.softKeyboard.SoftKeyboardDetectorEvent

changeFlatToSplit Event  
Event Object Type: ru.kozlovskij.air.mobile.iOS.text.softKeyboard.SoftKeyboardDetectorEvent

changeSplitToFlat Event  
Event Object Type: ru.kozlovskij.air.mobile.iOS.text.softKeyboard.SoftKeyboardDetectorEvent

deactivateSoftKeyboard Event  
Event Object Type: ru.kozlovskij.air.mobile.iOS.text.softKeyboard.SoftKeyboardDetectorEvent

relatedObjectChange Event  
Event Object Type: ru.kozlovskij.air.mobile.iOS.text.softKeyboard.SoftKeyboardDetectorEvent

Only for editable instances of TextField or StageText classes.