GhostWire InputField - Actionscript API

---

GWInputField
Example
// Dynamically attach a GhostWire InputField onto the stage during run time
_root.attachMovie("GWInputField","myInputField",1);

// Override the default properties by passing in the properties in an object
_root.attachMovie("GWInputField","myInputField",1,{
width:300,
height:22});

---

---

GWInputField.getSize()
Parameters
None

Returns
An object containing two properties -
width An integer specifying the width of the input field, in pixels
height An integer specifying the height of the input field, in pixels

Description
Method; gets the width and height of the input field. The method returns an object containing the two properties width and height.

Example
// The following will get the width of myInputField
myInputField.getSize().width;

// The following will get the height of myInputField
myInputField.getSize().height;

---

---

GWInputField.getValue()
Parameters
none

Returns
The contents of the input field.

Description
Method; gets the contents of the input field.

Example
// The following will send the current contents of myInputField to the output window:
trace( myInputField.getValue() );

---

---

GWInputField.setColor(obj)
Parameters
obj An object containing the color properties to set

Returns
Nothing.

Description
Method; sets the current color properties of the input field. The five color properties in the object to pass are: face, highlight, highlight3D, shadow, darkshadow

---

---

GWInputField.setFontColor(color)
Parameters
color A number specifying the font color to use

Returns
Nothing.

Description
Method; sets the current font color of the text in the input field.

Example
// The following code sets the font color to maroon:
myInputField.setFontColor(0x990000);

---

---

GWInputField.setSize(width,height)
Parameters
width An integer specifying the width of the input field, in pixels
height An integer specifying the height of the input field, in pixels

Returns
Nothing.

Description
Method; sets the width and height of the input field at runtime. Calling this method overrides any sizing applied during authoring. You should always use this method to resize the input field during runtime, instead of directly setting the _width and _height properties.

Example
// The following code resizes myInputField to 100 x 50 pixels at runtime.
myInputField.setSize(100,50);

---

---

GWInputField.setTextField(text)
Parameters
text A string specifying the contents to appear in the input field. Optional.

Returns
Nothing.

Description
Method; replaces the contents of the input field with text, if provided. In addition, this method updates the properties of the input field

Example
// The following code disables myInputField:
myInputField.enabled = false;
myInputField.setTextField();

---

---

GWInputField.onKillFocus
Description
Event handler; invoked when the component loses keyboard focus.

---

---

GWInputField.onSetFocus
Description
Event handler; invoked when the component received keyboard focus.

---