Documentation
Main | Download | Documentation | FAQ | Forums | Boxely Buzz
User Guide | OCP Services APIs | Actions | Animation | Event Types | Styles


Event Types Reference

Animation Events

animationExit

Fired when the animation is finished.

cancel

Fired when an animation has been canceled.

firstFrame

Fired when an animator has reached the first frame of the animation.

frame

Fired when an animator moves to the next frame of the animation.

lastFrame

Fired when an animator has reached the last frame of the animation.

pause

Fired when an animation is paused.

play

Fired when an animation is started.

stop

Fired when an animation is stopped.

Command Events

backward

Fired when the user generated a command event and navigates backward.

command

Fired when a control has specified a command attribute and that control's command is invoked. For example, the <aolButton> control in the toolkit can have a command attribute which is invoked when the button is clicked.

backward

Fired when the user generated a command event and navigates forward.

Context Menu Events

contextMenu

Fired before the contextMenu pops up.

DHTML Events

navigate

Fired when the DHTML control begins to navigate to a new URL as a result of link being clicked on the page.

parsed

Fired when the DHTML finishes parsing HTML content but before the content is displayed.

readyStateChanged

Fired when the readyState of the page loaded inside a DHTML control changes.

urlLoadComplete

Fired when a new URL is finished loading and displaying in a DHTML control.

DOM Events

activated

Fired when a native window of a scene is brought to the foreground. This typically occurs when the user clicks the window's item in the task bar or chooses the window using Alt-Tab.

appActivated

Fired when a window belonging to a different application than the active window is about to be activated.

appDeactivated

Fired when a window belonging to a different application than the active window is being deactivated.

boxCreated

Fired when a box is created.

boxDestroyed

Fired when a box is destroyed.

blur

Fired when a native window of a scene loses the focus.

constructed

Dispatched to a scene's root box after DOM has been created, prior to first layout and prior to first paint.

initialized

Dispatched to all boxes after the their initial layout - at which point geometry should be valid (event dispatched prior to first paint).

deactivated

Fired when a native window of a scene leaves the foreground. This typically happens when the user chooses another applicaiton in the task bar, or via Alt-Tab.

destroyed

Fired when the DOM is being destructed, usually when the scene is closed.

focus

Fired when a native window of a scene receives the focus.

presented

Fired when the DOM has been drawn to the screen for the first time.

layout

Dispatched to all boxes each time the box is layed out. KNOWN ISSUE - although this is called after each layout pass, at the time the event is dispatched any geometry changes the user code may make to the box will be ignored, due to the fact that the scene is still being layed out.

moved

Fired when the framed box's position is changed.

resized

Fired when the framed box's size is changed.

sceneChanged

Fired when a box is added to a new scene.

shutting

Fired before the pop up is closed.

Drag Events

dragDrop

Fired when the user releases the mouse button over a box during a drag-and-drop operation.

dragMove

Fired when the user moves the mouse during a drag-and-drop operation.

dragOut

Fired when the user leaves the boundry of a box during a drag-and-drop operation.

dragOver

Fired when the user enters the boundry of a box during a drag-and-drop operation.

dragStart

Fired when the user initiates a drag-and-drop operation.

dragStop

Fired when the user cancels a drag-and-drop operation, for example, by pressing the Esc key.

Key Events

keyDown

Fired once when a key is depressed. No other keyDowns will be generated if multiple keys are depressed before the original key is up.

keyPress

Fired when a key is depressed. Several keyPresses will be generated while the key continues to be depressed.

keyUp

Fired once when a key is released. This is paired with a keyDown event.

Mouse Events

click

Fired when a mouse button is depressed and released in the same location inside a box.

mouseDown

Fired when a mouse button is depressed inside a box.

mouseMove

Fired when the mouse cursor changes locations inside a box.

mouseOut

Fired when the mouse cursor leaves the boundry of a box.

mouseOver

Fired when the mouse cursor enters the boundry of a box.

mouseUp

Fired when a mouse button is released inside a box.

doubleClick

Fired when a mouse button is depressed and released twice rapidly inside a box.

mouseDrag

Fired when a drag-and-drop operation is initiated.

mouseWheel

Fired when the mouse wheel is rotated.

hoverHold

If the user moves the cursor over a box, a hoverHold event will be sent to the box with a delay (if the box has instantTooltip property set with some value, the delay will be 1ms, otherwise, the default delay is is system's double click time). If the user press the mouse down and move the cursor over a box, the hoverHold event won't be sent.

pressHold

If the user left mouse down on a box, a pressHold event will be sent to the box with a delay (if the user set pressHoldDelay property on the box, that property's value will be the delay value, otherwise, the default delay is system's double click time).

mouseReleased

If the user clicks the mouse down on a box, he will receive a mouseReleased event when he releases the mouse later. The targetBox of the mouseReleased event will be the same targetBox as the mouseDown event. That is to say, if the user mouseDown when the cursor is on box A and move the cursor over box B and release the mouse, he will get a mouseReleased event whose targetBox is box B.

mousePress

When the user clicks the left mouse button down on a box, he will receive a mousePress event. This event will be sent with a press timer delay (for now it's 500 ms) after the mouseDown event is sent.

Mutation Events

attributeSet

Fired when an attribute of a box is set in script using the setAttribute() function.

childInserted

Fired when a child is added to a box in script using the insertChildAt(), addChild(), or addContentChild() functions.

childRemoved

Fired when a child of a box is removed in script using the removeChild() or deleteChild() functions.

boxHeightCollapse

Used for telling the textboxwin script that the native textbox has collapsed to a single line.

boxHeightExpand

For multiline text boxes; sent when the the native textbox is expanding.

contextChanged

This is a DHTML event; sent when something in the UI of the editor has changed.

displayChanged

Called when a windows display change happens such as someone changing the screen resolution.

menuEnding

This is a DOM event sent when a menu selection is being removed (a new menu item is being selected).

menuStarting

A DOM sent when a menu item is being selected.

modified

DOM event sent when a box's value is being modified. Used for range, select, and native textboxes.

popping

UI event sent when a popup box is opening.

shutting

UI event sent when a popup box is closing down.

toggle

Fired when a control such as a checkbox has its value toggled.

System Events

system

Fired when user logs off or shuts down computer.

Copyright © 2007 AOL, LLC. All rights reserved.