Main Page | Packages | Class Tree | Index | Help

xp.system

interface IButtonControl

All Known Implementing Classes:
Button

interface IButtonControl

Allows a control to act like a button on a form.

An example of where this interface might be implemented is default and cancel button processing. Default buttons are notified when an unprocessed ENTER key is entered for a form, just like a dialog box would be closed. Similarly, cancel buttons are notified whenever an unprocessed ESC key is entered on a form, much like a dialog box would be dismissed. Note to Implementers: Implement this interface in classes that act as button controls. The members of this interface will provide basic button functionality, such as providing a dialogResult to the parent form or the ability to perform a click event, or acting as the default button of a form.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Method Summary

public
notifyDefault ( v: Boolean )
Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly. This method is called by a parent form to make a control the default button. Default buttons are set to have an extra thick border.

public
performClick ( )
Generates a Click event for the control. This method is called for the button that has focus, or for the default button (if no other button has focus) when the user presses the ENTER key. This method is also called when the user presses the ESC key if the button is set as the cancel button



Method Documentation

notifyDefault

public function notifyDefault(v: Boolean)
Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly. This method is called by a parent form to make a control the default button. Default buttons are set to have an extra thick border.

performClick

public function performClick()
Generates a Click event for the control. This method is called for the button that has focus, or for the default button (if no other button has focus) when the user presses the ENTER key. This method is also called when the user presses the ESC key if the button is set as the cancel button


The documentation was generated from the following file:


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