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
invocationAction (InvocationEvent event) yoix.event
 
The invocationAction event handler is a special user-defined Function that can be added to a JTable when it is created and that will be called automatically with a single InvocationEvent argument whenever a JTable header label is pressed. Note: supplying this handler to a JTable converts the table column headers into buttons. An invocationAction event handler can only be added via addEventHandler after a component is created, but an existing invocationAction event handler can be assigned new values. Assigning NULL to invocationAction disables its functionality until a non-NULL value is assigned to it.

The InvocationEvent received by this handler will have the following fields:
coordinates A Point that indicates where the pointer was at the time of the event. The coordinates and location fields may or may not match, but coordinates should only be used by event handlers that are defined in drawable objects (i.e., components that define a graphics field). In that case coordinates will be a point in the coordinate system described by the drawable object's graphics.CTM at the time the event arrived, otherwise coordinates and location will match.
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.

location A Point that indicates where the pointer was at the time of the event. The point always describes a location in the component that requested the event in a coordinate system that has its origin at that component's upper left corner, positive x to the right, positive y down, and a resolution of 72 dots per inch.
modifiers An int that is a bitmask that represents the mouse buttons and keyboard modifiers that were down when the event occurred. Use BUTTON1_MASK, BUTTON2_MASK, BUTTON3_MASK, CTRL_MASK, ALT_MASK, META_MASK, and SHIFT_MASK, which are defined in yoix.awt and yoix.swing, to test the bits in modifiers.
pressed An int that is non-zero when at least one button is pressed at the time of the event. In many cases the value of pressed matches the number of buttons pressed at the time of the event, but Yoix applications should not currently rely on that fact.
valuesColumn An int that is the column location where the header was pressed in terms of its position in the values matrix.
viewColumn An int that is the column location where the header was pressed in terms of its position in the view matrix.
 
 Return:   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, invocationBrowse, invocationChange, invocationEdit, 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.