AT&T Home | AT&T Labs | Research
AT&T Labs, Inc. - Research

The Yoix® Scripting Language

Home | What's New | Grammar | Documentation | Download | License | YChart | YDAT | YWAIT | Byzgraf | FAQs
invocationBrowse (InvocationEvent event) yoix.event
 
The invocationBrowse event handler is a special user-defined Function that can be added to a JTree when it is created and that will be called automatically with a single InvocationEvent argument whenever a tree node is about to expand or collapse and also when a tree node has just expanded or collapsed. An invocationBrowse event handler can only be added via addEventHandler after a component is created, but an existing invocationBrowse event handler can be assigned new values. Assigning NULL to invocationBrowse disables its functionality until a non-NULL value is assigned to it.

The InvocationEvent received by this handler will have the following fields:
etc A field that is not currently used and may not be defined, but it should be considered reserved for releases.
id An Object that must be an int or String, that identifies the type of this event. A value that is a String must be the name of an event handler that can process this event. A value that is an int must be a number that the yoix.event.HandlerID dictionary associates with an event handler that can process this event.

In practice, id is only used when you build an event that gets handed to postEvent, and in that case the value assigned to id is almost always a String.

type An int has one of the values NODE_COLLAPSING, NODE_COLLAPSED, NODE_EXPANDING or NODE_EXPANDED.
When the event handler is called as a node is about to collapse (i.e., the event has a type value of NODE_COLLAPSING) or when a node is about to expand (i.e., the event has a type value of NODE_EXPANDING), then if this event handler has a return value of zero, the collapsing or expanding can be stopped before it occurs. If the handle has no specified return value or the return value is non-zero, then the expanding or collapsing operation will continue as expected.
 
 Return:   int or none
 
 See Also:   actionPerformed, addEventHandler, adjustmentValueChanged, caretUpdate, componentHidden, componentMoved, componentResized, componentShown, dragDropEnd, dragEnter, dragExit, dragGestureRecognized, dragMouseMoved, dragOver, drop, dropActionChanged, Event, focusGained, focusLost, hyperlinkActivated, hyperlinkEntered, hyperlinkExited, invocationAction, invocationChange, invocationEdit, invocationEditImport, invocationEditKey, InvocationEvent, invocationRun, invocationSelection, itemStateChanged, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, removeEventHandler, stateChanged, textValueChanged, valueChanged, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

 

Yoix is a registered trademark of AT&T Inc.