Packagenet.guttershark.managers
Classpublic class FormFieldManager
ImplementsIDisposable

The FormFieldManager Class simplifies managing InteractiveObjects that compose a form.



Public Methods
 MethodDefined by
  
Constructor for FormFieldManager instances.
FormFieldManager
  
addTextField(tf:TextField):void
Add a TextField to the manager.
FormFieldManager
  
addTextFields(tfs:Array):void
Add multiple TextFields to the manager.
FormFieldManager
  
addToggleable(toggleable:IToggleable):void
Add an IToggleable instance to the manager.
FormFieldManager
  
addToggleables(toggleables:Array):void
Add multiple IToggleable clips to the manager.
FormFieldManager
  
Sets the tabEnabled property to false on all toggleable clips in the manager.
FormFieldManager
  
displayBooleansAs(truSubstitute:String, falsSubstitute:String):void
Change what the output value is displayed as for a boolean.
FormFieldManager
  
dispose():void
Dispose of this FormFieldManager.
FormFieldManager
  
Sets the tabEnabled property to true on all toggleable clips in the manager.
FormFieldManager
  
Get all data from the form as a generic Object.
FormFieldManager
  
Get all data from the form as a URL encoded string.
FormFieldManager
  
getOutputAsURLVariables():URLVariables
Get all data from the form as a URLVariables instance.
FormFieldManager
  
setTabs(clips:Array = null):void
Set the tabs for all fields in the form.
FormFieldManager
Constructor detail
FormFieldManager()constructor
public function FormFieldManager()

Constructor for FormFieldManager instances.

Method detail
addTextField()method
public function addTextField(tf:TextField):void

Add a TextField to the manager.

Parameters
tf:TextField — A TextField.
addTextFields()method 
public function addTextFields(tfs:Array):void

Add multiple TextFields to the manager.

Parameters
tfs:Array — An array of TextFields.
addToggleable()method 
public function addToggleable(toggleable:IToggleable):void

Add an IToggleable instance to the manager.

Parameters
toggleable:IToggleable — An IToggleable instance.
addToggleables()method 
public function addToggleables(toggleables:Array):void

Add multiple IToggleable clips to the manager.

Parameters
toggleables:Array — An array of IToggleable clips.
disableTabsOnToggleables()method 
public function disableTabsOnToggleables():void

Sets the tabEnabled property to false on all toggleable clips in the manager.

displayBooleansAs()method 
public function displayBooleansAs(truSubstitute:String, falsSubstitute:String):void

Change what the output value is displayed as for a boolean. You could substitue true with "yes" or false with "no" etc. Values for booleans are only substituded with the getOutputAsObject and getOutputAsURLVariables methods.

Parameters
truSubstitute:String
 
falsSubstitute:String
dispose()method 
public function dispose():void

Dispose of this FormFieldManager.

enableTabsOnToggleables()method 
public function enableTabsOnToggleables():void

Sets the tabEnabled property to true on all toggleable clips in the manager.

getOutputAsObject()method 
public function getOutputAsObject():Object

Get all data from the form as a generic Object.

Returns
Object — Object
getOutputAsQueryString()method 
public function getOutputAsQueryString():String

Get all data from the form as a URL encoded string.

Returns
String — String
getOutputAsURLVariables()method 
public function getOutputAsURLVariables():URLVariables

Get all data from the form as a URLVariables instance.

Returns
URLVariables — URLVariables
setTabs()method 
public function setTabs(clips:Array = null):void

Set the tabs for all fields in the form.

It will set tabs in this order:

  1. TextFields
  2. IToggleables

Or if you provide an array of clips in the call to set tabs, it will use whatever order the array is in.

Parameters
clips:Array (default = null)