.. _RadioButton: ================================================ RadioButton ================================================ Description ----------- A dual-state control, grouped with other radiobuttons, of which only one can be in the selected state. Shows the selected state when?value=true, empty when?value=false. Calls the?onClick()?callback if the control is clicked or if its?notify()?method is called. Properties ^^^^^^^^^^ +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`active` readonly | True if this element is active. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`alignment` readonly | The alignment style for this element. If defined, this value overrides the alignChildren setting for the parent container. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bounds` readonly | The boundaries of the element, in parent-relative coordinates. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`characters` readonly | A number of characters for which to reserve space when calculating the preferred size of the element. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`children` readonly | An array of child elements. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`enabled` readonly | True if this element is enabled. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`graphics` readonly | The graphics object that can be used to customize the element's appearance, in response to the?onDraw?event. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`helpTip` readonly | The help text that is displayed when the mouse hovers over the element. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`indent` readonly | The number of pixels to indent the element during automatic layout. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`justify` readonly | The default text justification style for child text elements. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`location` readonly | The upper left corner of this element relative to its parent. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`maximumSize` readonly | The maximum height and width to which the element can be resized. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`minimumSize` readonly | The minimum height and width to which the element can be resized. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`parent` readonly | The parent element. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`preferredSize` readonly | The preferred size, used by layout managers to determine the best size for each element. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`properties` readonly | An object that contains one or more creation properties of the container (properties used only when the element is created). | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`shortcutKey` readonly | The key sequence that invokes the?onShortcutKey()?callback for this element (in Windows only). | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`size` readonly | The current dimensions of this element. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`text` readonly | The label text for this button, a localizable string. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`type` readonly | The element type; "radiobutton". | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`value` readonly | The selection state of this button, selected when true. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`visible` readonly | True if this element is shown, false if it is hidden. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`window` readonly | The window that this element belongs to. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`windowBounds` readonly | The bounds of this element relative to the top-level parent window. | +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Methods ^^^^^^^ +----------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`addEventListener` readonly | Registers an event handler for a particular type of event occuring in this element. | +----------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`dispatchEvent` readonly | Simulates the occurrence of an event in this target. | +----------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`hide` readonly | Hides this element. | +----------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`notify` readonly | Sends a notification message, simulating the specified user interaction event. | +----------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`removeEventListener` readonly | Unregisters an event handler for a particular type of event occuring in this element. | +----------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`show` readonly | Shows this element. | +----------------------------------------------------------------------+---------------------------------------------------------------------------------------+ Events ^^^^^^ +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`onActivate` readonly | An event-handler callback function, called when the element acquires the keyboard focus. | +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`onClick` readonly | An event-handler callback function, called when the element has been clicked. | +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`onDeactivate` readonly | An event-handler callback function, called when the element loses the keyboard focus. | +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`onDraw` readonly | An event-handler callback function, called when the window is about to be drawn. | +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`onShortcutKey` readonly | An event-handler callback function, called when the element's?shortcutKey?sequence is typed in the active window. | +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. container:: hide .. toctree:: :hidden: :maxdepth: 1 RadioButton/value.rst RadioButton/characters.rst RadioButton/justify.rst RadioButton/text.rst RadioButton/active.rst RadioButton/shortcutKey.rst RadioButton/graphics.rst RadioButton/visible.rst RadioButton/bounds.rst RadioButton/location.rst RadioButton/maximumSize.rst RadioButton/minimumSize.rst RadioButton/preferredSize.rst RadioButton/size.rst RadioButton/windowBounds.rst RadioButton/alignment.rst RadioButton/children.rst RadioButton/properties.rst RadioButton/enabled.rst RadioButton/helpTip.rst RadioButton/indent.rst RadioButton/parent.rst RadioButton/window.rst RadioButton/type.rst RadioButton/notify.rst RadioButton/show.rst RadioButton/hide.rst RadioButton/addEventListener.rst RadioButton/removeEventListener.rst RadioButton/dispatchEvent.rst RadioButton/onActivate.rst RadioButton/onDeactivate.rst RadioButton/onDraw.rst RadioButton/onClick.rst RadioButton/onShortcutKey.rst