Main Page | Packages | Class Tree | Index | Help

xp.events

class PanelEvent

Object
  |
  +--xp.events.Event
        |
        +--xp.events.PanelEvent


class PanelEvent
extends Event

PanelEvent
Broadcast Panel event.

Event; broadcast to all registered listeners when an Panel action event occurs.
The action property determine what action is taking place.
If the cancel property is set to true the action will be cancelled.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary


action: String
Gets or sets a value indicating what action is/has taken place.


data: Object
The data item associated with this panel


index: Number
The index of the panel.


panel: Object
The panel that the action has been performed on.


prevIndex: Number
the index of the child that was previously selected.


type: String
The type of event, the string "panel"

Fields inherited from class xp.events.Event

bubbles, cancel, currentTarget, handled, target, type

Constructor

public
PanelEvent ( panel: Object, index: Number, data: Object, action: String, prevIndex: Number)
Constructs a new panel event



Field Documentation

action

var action: String
Gets or sets a value indicating what action is/has taken place.

This will be one of the following or a custom action defined by the user
selecting
selected
opening
opened
closing
closed
For single selection panels only the select/selecting actions will fire
with index referring to the panel that is about to be selected
and prevIndex referring to the panel that was previously selected.
For multiple selection panels both open and close events fire independently.

data

var data: Object
The data item associated with this panel

index

var index: Number
The index of the panel.

panel

var panel: Object
The panel that the action has been performed on.

prevIndex

var prevIndex: Number
the index of the child that was previously selected.

type

var type: String
The type of event, the string "panel"


Constructor Documentation

PanelEvent

public function PanelEvent(panel: Object,
 index: Number,
 data: Object,
 action: String,
 prevIndex: Number)
Constructs a new panel event

Parameters:
panel
The panel that the action has been performed on.
index
The index of the panel.
data
The data item associated with this panel
action
A value indicating what action is/has taken place.
prevIndex
the index of the child that was previously selected.

The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc