- source
- triggers
- name

- addEventListener
- addTrigger
- removeTrigger
- getValue
- setValue
- refresh

	<form>
		<element class="FFormLabel" />
		<element class="FFormCheckBox">
			<element class="FFormLabel" />
			<element class="FFormLabel" />
		</element>
	</form>
	

	<form indent="30">
	<element class="FFormLabel" id="about" hspace="5" vspace="2" color="0x008BCE" width="300" size="14" font="verdana" label="This is the content of 'simple.xml'..." />
	<element class="FFormCheckBox" id="checkBox_01" label="A checkbox" selected="true" hspace="5" vspace="2">
		<element class="FFormLabel" id="label_A" hspace="5" vspace="2" color="0x999999" width="300" size="8" font="harmony" embed="true" label="This is some additional text, which is shown when activating the CheckBox. This element is a label, acting as a child of the CheckBox." />
		<element class="FFormInput" id="input_A" hspace="5" vspace="2" color="0x124178" width="300" size="10" background="0xA5C8F1" border="0x124178" label="This text is editable..." />
		<element class="FFormInput" id="input_B" hspace="5" vspace="2" color="0x124178" width="300" size="10" background="0xA5C8F1" border="0x124178" label="This text is editable..." />
	</element>
	</form>
	

source

(String) Sets or gets the xml file source. Use FForm.load() to actually load the xml file.

triggers

(Array) Sets or gets the elements which trigger a redraw of the form, replaces the current list.

name

(String) Returns the form name (is also the instancename). Cannot be set.

addEventListener

description: The following standard EventDispatcher events are broadcasted by FForm:

data, indicates a change in the form contents. This event object contains the following properties:

• type : "data"
• target : Object, reference to the form
• element : Object, reference to the form element that has new data

layout, indicates a change in the form layout. This event object contains the following properties:

• type : "layout"
• target : Object, reference to the form
• element : Object, reference to the form element that caused the layout change

error, indicates an XML error. This event object contains the following properties:

• type : "error"
• target : Object, reference to the form
• message : the error message

usage: FForm.addEventListener(event, listener)

parameters:

• event (String) Required; event to subscribe listener to.
• listener (Object) The listener object to subscribe to the specified event.
• event (String) Required; event to unsubscribe listener from.
• listener (Object) The listener object to unsubscribe from the specified event.

returns: Nothing.

addTrigger

description: Adds a class name to the list of elements that may change the form layout.
Default values are: FFormCheckBox, FFormRadioButton, CheckBox, RadioButton

usage: FForm.addTrigger( class )

parameters:

• class (String) The classname to add to the trigger list.

returns: Nothing.

removeTrigger

description: Removes a class name from the list of elements that may change the form layout.

usage: FForm.removeTrigger( class )

parameters:

• class (String) The classname to remove from the trigger list.

returns: Boolean, true if successfullly removed, false when the class name was not found.

getValue

description: Returns the value of specified form element, or, if no element name is given, the value of all form elements.
FForm needs to access a property named "value" in each element to accomplish this, so make sure this getter function is implement when creating custom components for FForm.

usage: FForm.getValue( element )

parameters:

• element (String) Optional, retreives only the value of the specified element.

returns: Object, containing all form elements as properties with their respective value.

setValue

description: Sets the value of a specific form element.
FForm needs to access a property or getter/setter named "value" in each element to accomplish this, so make sure this property is available when creating custom components for FForm.

usage: FForm.setValue( element )

parameters:

• element (String) The element to set the value of.

returns: Nothing.

refresh

description: Redraws the complete form.

usage: FForm.update()

returns: Nothing.