FormControl.mouseUp Method

Is called when the user releases the mouse button over the control area.

Syntax

public int mouseUp(
    int x, 
    int y, 
    int button, 
    boolean Ctrl, 
    boolean Shift)

Run On

Client

Parameters

  • x
    Type: int
    The x-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.
  • y
    Type: int
    The y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.
  • button
    Type: int
    An integer value: 1 if the left mouse button is down, 2 if the middle mouse button is down, or 3 if the right mouse button is down.
  • Ctrl
    Type: boolean
    A Boolean value that indicates whether the CTRL key is down.
  • Shift
    Type: boolean
    A Boolean value that indicates whether the SHIFT key is down.

Return Value

Type: int
0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Examples

The following example shows how to display the parameters of a mouseUp event in the Infolog.

public int mouseUp(int x,  
                   int y,  
                   int button, 
                   boolean Ctrl, 
                   boolean Shift) 
{ 
    int ret; 
 
    if (Shift) 
    { 
        info("Shift set"); 
    } 
    if (Ctrl) 
    { 
        info("Ctrl set"); 
    } 
    info (strfmt("x, y: %1 %2 button: %3", x, y, button)); 
 
    ret = super(x, y, button, Ctrl, Shift); 
 
    info (strfmt("ret: %1", ret)); 
 
    return ret; 
}

See Also

FormControl Class

Event Method Sequences in Form Scenarios