Flash 8 Documentation Flash Pro only

Components Language Reference > Form class (Flash Professional only)Form class (Flash Professional only)

Form class (Flash Professional only)

Inheritance MovieClip > UIObject class > UIComponent class > View > Loader component > Screen class (Flash Professional only) > Form

ActionScript Class Name mx.screens.Form

The Form class provides the runtime behavior of forms that you create in the Screen Outline pane in Flash.

Method summary for the Form class

The following table lists methods of the Form class.

Method	Description
Form.getChildForm()	Returns the child form at a specified index.

Methods inherited from the UIObject class

The following table lists the methods the Form class inherits from the UIObject class. When calling these methods from the Form object, use the syntax formInstance.methodName.

Method	Description
UIObject.createClassObject()	Creates an object on the specified class.
UIObject.createObject()	Creates a subobject on an object.
UIObject.destroyObject()	Destroys a component instance.
UIObject.doLater()	Calls a function when parameters have been set in the Property and Component inspectors.
UIObject.getStyle()	Gets the style property from the style declaration or object.
UIObject.invalidate()	Marks the object so it is redrawn on the next frame interval.
UIObject.move()	Moves the object to the requested position.
UIObject.redraw()	Forces validation of the object so it is drawn in the current frame.
UIObject.setSize()	Resizes the object to the requested size.
UIObject.setSkin()	Sets a skin in the object.
UIObject.setStyle()	Sets the style property on the style declaration or object.

Methods inherited from the UIComponent class

The following table lists the methods the Form class inherits from the UIComponent class. When calling these methods from the Form object, use the syntax formInstance.methodName.

Method	Description
UIComponent.getFocus()	Returns a reference to the object that has focus.
UIComponent.setFocus()	Sets focus to the component instance.

Methods inherited from the Loader class

The following table lists the methods the Form class inherits from the Loader class. When calling these methods from the Form object, use the syntax formInstance.methodName.

Method	Description
Loader.load()	Loads the content specified by the `contentPath` property.

Methods inherited from the Screen class

The following table lists the methods the Form class inherits from the Screen class. When calling these methods from the Form object, use the syntax formInstance.methodName.

Method	Description
Screen.getChildScreen()	Returns the child screen of this screen at a particular index.

Property summary for the Form class

The following table lists the properties that are exclusive to the Form class.

Property	Description
Form.currentFocusedForm	Read-only; returns the form that contains the global current focus.
Form.indexInParentForm	Read-only; returns the index (zero-based) of this form in its parent's list of subforms.
Form.numChildForms	Read-only; returns the number of child forms that this form contains.
Form.parentIsForm	Read-only; specifies whether the parent object of this form is also a form.
Form.parentForm	Read-only; reference to the form's parent form.
Form.rootForm	Read-only; returns the root of the form tree, or subtree, that contains the form.
Form.visible	Specifies whether the form is visible when its parent form, slide, movie clip, or SWF file is visible.

Properties inherited from the UIObject class

The following table lists the properties the Form class inherits from the UIObject class. When accessing these properties from the Form object, use the syntax formInstance.propertyName.

Property	Description
UIObject.bottom	The position of the bottom edge of the object, relative to the bottom edge of its parent. Read-only.
UIObject.height	The height of the object, in pixels. Read-only.
UIObject.left	The left edge of the object, in pixels. Read-only.
UIObject.right	The position of the right edge of the object, relative to the right edge of its parent. Read-only.
UIObject.scaleX	A number indicating the scaling factor in the x direction of the object, relative to its parent.
UIObject.scaleY	A number indicating the scaling factor in the y direction of the object, relative to its parent.
UIObject.top	The position of the top edge of the object, relative to its parent. Read-only.
UIObject.visible	A Boolean value indicating whether the object is visible (`true`) or not (`false`).
UIObject.width	The width of the object, in pixels. Read-only.
UIObject.x	The left edge of the object, in pixels. Read-only.
UIObject.y	The top edge of the object, in pixels. Read-only.

Properties inherited from the UIComponent class

The following table lists the properties the Form class inherits from the UIComponent class. When accessing these properties from the Form object, use the syntax formInstance.propertyName.

Property	Description
UIComponent.enabled	Indicates whether the component can receive focus and input.
UIComponent.tabIndex	A number indicating the tab order for a component in a document.

Properties inherited from the Loader class

The following table lists the properties the Form class inherits from the Loader class. When accessing these properties from the Form object, use the syntax formInstance.propertyName.

Property	Description
Loader.autoLoad	A Boolean value that indicates whether the content loads automatically (`true`) or you must call Loader.load() (`false`).
Loader.bytesLoaded	A read-only property that indicates the number of bytes that have been loaded.
Loader.bytesTotal	A read-only property that indicates the total number of bytes in the content.
Loader.content	A reference to the content of the loader. This property is read-only.
Loader.contentPath	A string that indicates the URL of the content to be loaded.
Loader.percentLoaded	A number that indicates the percentage of loaded content. This property is read-only.
Loader.scaleContent	A Boolean value that indicates whether the content scales to fit the loader (`true`), or the loader scales to fit the content (`false`).

Properties inherited from the Screen class

The following table lists the properties that the Form class inherits from the Screen class. When accessing these properties from the Form object, use the syntax formInstance.propertyName.

Property	Description
Screen.currentFocusedScreen	Read-only; returns the screen that contains the global current focus.
Screen.indexInParent	Read-only; returns the screen's index (zero-based) in its parent screen's list of child screens.
Screen.numChildScreens	Read-only; returns the number of child screens contained by the screen.
Screen.parentIsScreen	Read-only; returns a Boolean (`true` or `false`) value that indicates whether the screen's parent object is itself a screen.
Screen.rootScreen	Read-only; returns the root screen of the tree or subtree that contains the screen.

Event summary for the Form class

There are no events exclusive to the Form class.

Events inherited from the UIObject class

The following table lists the events the Form class inherits from the UIObject class.

Event	Description
UIObject.draw	Broadcast when an object is about to draw its graphics.
UIObject.hide	Broadcast when an object's state changes from visible to invisible.
UIObject.load	Broadcast when subobjects are being created.
UIObject.move	Broadcast when the object has moved.
UIObject.resize	Broadcast when an object has been resized.
UIObject.reveal	Broadcast when an object's state changes from invisible to visible.
UIObject.unload	Broadcast when the subobjects are being unloaded.

Events inherited from the UIComponent class

The following table lists the events the Form class inherits from the UIComponent class.

Event	Description
UIComponent.focusIn	Broadcast when an object receives focus.
UIComponent.focusOut	Broadcast when an object loses focus.
UIComponent.keyDown	Broadcast when a key is pressed.
UIComponent.keyUp	Broadcast when a key is released.

Events inherited from the Loader class

The following table lists the events the Form class inherits from the Loader class.

Event	Description
Loader.complete	Triggered when the content finished loading.
Loader.progress	Triggered while content is loading.

Events inherited from the Screen class

The following table lists the events the Form class inherits from the Screen class.

Event	Description
Screen.allTransitionsInDone	Broadcast when all "in" transitions applied to a screen have finished.
Screen.allTransitionsOutDone	Broadcast when all "out" transitions applied to a screen have finished.
Screen.mouseDown	Broadcast when the mouse button was pressed over an object (shape or movie clip) directly owned by the screen.
Screen.mouseDownSomewhere	Broadcast when the mouse button was pressed somewhere on the Stage, but not necessarily on an object owned by this screen.
Screen.mouseMove	Broadcast when the mouse is moved while over a screen.
Screen.mouseOut	Broadcast when the mouse is moved from inside the screen to outside it.
Screen.mouseOver	Broadcast when the mouse is moved from outside this screen to inside it.
Screen.mouseUp	Broadcast when the mouse button was released over an object (shape or movie clip) directly owned by the screen.
Screen.mouseUpSomewhere	Broadcast when the mouse button was released somewhere on the Stage, but not necessarily over an object owned by this screen.

Version 8

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/8/main/00003671.html