IKeyboardController

PropertiesMethods
Packageispring.presenter.player
Interfacepublic interface IKeyboardController extends flash.events.IEventDispatcher

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The IKeyboardController interface is used to enable or disable keyboard navigation within the presentation.

To obtain the IKeyboardController interface use the keyboardController property on the IPresentatonView interface.

Keyboard control is enabled if the keyboardEnabled property is true AND no active lock is applied to the keyboard controller.

The IKeyboardController interface extends the flash.events.IEventDispatcher interface. The current implementation of the IKeyboardController interface does not displatch any event. This functionality is reserved for future versions.

See also

ispring.presenter.player.IPresentationView
flash.events.IEventDispatcher

Public Properties
PropertyDefined By
keyboardEnabled : Boolean
Indicates whether keyboard is enabled.
IKeyboardController
Public Methods
MethodDefined By
 
getActiveLockNames():Array
Returns an array of names of the active locks of the keyboard controller.
IKeyboardController
 
isLocked(lockName:String):Boolean
Determines whether a lock with the specified name is in the locked state.
IKeyboardController
 
lock(lockName:String):void
Locks the specified lock of the keyboard controller.
IKeyboardController
 
unlock(lockName:String):void
Unlocks the specified lock of the keyboard controller.
IKeyboardController
 
unlockAll():void
Unlocks all active locks.
IKeyboardController
Property Detail
keyboardEnabledproperty
keyboardEnabled:Boolean

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Indicates whether keyboard is enabled.


Implementation
    public function get keyboardEnabled():Boolean
    public function set keyboardEnabled(value:Boolean):void
Method Detail
getActiveLockNames()method
public function getActiveLockNames():Array

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Returns an array of names of the active locks of the keyboard controller.

Returns
Array — An array of names of the active locks of the keyboard controller.
isLocked()method 
public function isLocked(lockName:String):Boolean

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Determines whether a lock with the specified name is in the locked state.

Parameters

lockName:String — specifies a name of the lock to check.

Returns
Boolean — A Boolean value indicating whether the specified lock is locked.
lock()method 
public function lock(lockName:String):void

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Locks the specified lock of the keyboard controller.

Parameters

lockName:String — A name of the lock to lock.

See also

unlock()
unlock()method 
public function unlock(lockName:String):void

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Unlocks the specified lock of the keyboard controller.

Parameters

lockName:String — is a name of the lock to be unlocked.

unlockAll()method 
public function unlockAll():void

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Unlocks all active locks.





Tue Dec 4 2012, 06:27 PM +04:00