Main Page | Packages | Class Tree | Index
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
it.gotoandplay.smartfoxbits.events

class BitEvent

Object
  |
  +--it.gotoandplay.smartfoxbits.events.BaseEvent
        |
        +--it.gotoandplay.smartfoxbits.events.BitEvent

class BitEvent
extends BaseEvent

The SFSEvent class is the base class for all the event objects dispatched by the SmartFoxBits components, passed as parameters to event listeners when an event occurs.

The SFSEvent class provides the public property params that can contain any number of parameters.

Usage:
Refer to the SmartFoxBits components' addEventListener method for usage examples.


Author:
The gotoAndPlay() Team
www.smartfoxserver.com
www.gotoandplay.it
www.gotoandplay.biz

Version:
1.0.0

Since:
SmartFoxBits v1.0

See also:
SmartFoxServer documentation

Field Summary

public static
onClearClick: String
Dispatched when a "clear" button is pressed in a SmartFoxBits component.

public static
onRoomChange: String
Dispatched when the selected room in the SmartFoxBits' RoomList component has changed.

public static
onUserChange: String
Dispatched when the selected user in the SmartFoxBits' UserList component has changed.

Property Summary

public
params: Object (read, write)
Object containing the parameters passed by the event.

Properties inherited from class it.gotoandplay.smartfoxbits.events.BaseEvent

target, type

Constructor


BitEvent ( target: Object, type: String)
BitEvent class constructor.


Field Documentation

onClearClick

public static var onClearClick: String
Dispatched when a "clear" button is pressed in a SmartFoxBits component.

The params object doesn't contain parameters.

onRoomChange

public static var onRoomChange: String
Dispatched when the selected room in the SmartFoxBits' RoomList component has changed.

The params object contains the following parameters:

  • selectedRoom:Room
    The SmartFoxServer Room object corresponding to the selected list item. Check the Room class documentation for a list of available properties and methods.

onUserChange

public static var onUserChange: String
Dispatched when the selected user in the SmartFoxBits' UserList component has changed.

The params object contains the following parameters:

  • selectedUser:User
    The SmartFoxServer user object corresponding to the selected list item. Check the User class documentation for a list of available properties and methods.

Property Documentation

params

public params: Object (read, write)
Object containing the parameters passed by the event.

Value:
The event parameters.

Constructor Documentation

BitEvent

function BitEvent(target: Object,
 type: String)
BitEvent class constructor.

See also:
BaseEvent

The documentation was generated from the following file:

Copyright 2007 gotoAndPlay() Team