GhostWire CheckBox - Actionscript API

---

GWCheckBox
Example
// The following will dynamically attach a CheckBox
// onto the stage during run time
_root.attachMovie("GWCheckBox","myCheckBox",1,{
data:"I have read the instructions",
checked:true,
width:100
});

// Note that the width (and height) properties set the hitArea dimensions.

---

---

GWCheckBox.getSize()
Parameters
none

Returns
An object containing the width and height properties of the hitArea of the checkbox, in pixels.

Description
Method; gets the width and height of the hitArea of the checkbox, in pixels.

---

---

GWCheckBox.setSize(width, height)
Parameters
width An integer specifying the width of the hitArea of the checkbox, in pixels.
height An integer specifying the height of the hitArea of the checkbox, in pixels.

Returns
Nothing.

Description
Method; sets the width and height of the hitArea of the checkbox at runtime. Calling this method overrides any sizing applied during authoring.

---

---

GWCheckBox.getData()
Parameters
none

Returns
A string specifying the data represented by the checkbox (if checked), or null if unchecked.

Description
Method; gets the data represented by the checkbox (if checked), or null if unchecked.

---

---

GWCheckBox.setData(data)
Parameters
data A string specifying the data to return if the checkbox is checked.

Returns
Nothing.

Description
Method; sets the data of the checkbox. This data is what the checkbox represents - if the checkbox is checked, this data will be returned if the getData() method is called.

---

---

GWCheckBox.getState()
Parameters
none

Returns
A boolean value specifying the checked/unchecked (true/false) state of the checkbox.

Description
Method; gets the checked/unchecked state (true/false) of the checkbox.

---

---

GWCheckBox.setState(flag)
Parameters
flag A boolean value specifying the checked/unchecked (true/false) state of the checkbox.

Returns
Nothing.

Description
Method; sets the checked/unchecked state (true/false) of the checkbox.

---

---

GWCheckBox.getEnabled()
Parameters
none

Returns
A boolean value specifying whether the checkbox is on/off.

Description
Method; gets the current status (enabled/disabled) of the checkbox.

---

---

GWCheckBox.setEnabled(flag)
Parameters
flag A boolean value specifying whether to switch the checkbox on/off.

Returns
Nothing.

Description
Method; specify whether the checkbox can respond to mouse/key actions. If off, the look of the checkbox will change to reflect this disabled state.

---

---

GWCheckBox.onChecked = function(data)
Parameters
data A string specifying the data represented by the checkbox.

Description
Event; triggered when the checkbox is checked. You will need to specifying a handler function for the event. The data of the checkbox will be passed as a parameter to the function.

---

---

GWCheckBox.onUnchecked = function()
Description
Event; triggered when the checkbox is unchecked. You will need to specifying a handler function for the event.

---