Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
xp.controls

class Form

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.Container
              |
              +--xp.controls.Form

Implemented Interfaces: IForm
All Known Subclasses: MessageBox, ModalAbout, ModalLoader, ModalWait, PromptBox
class Form
extends Container

Form
A Form is a representation of the contents of any window displayed in your application


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Field Summary

public static
classInfo: Object
A static class information object

public
isMainForm: Boolean
Indicates whether this form is the applications MainForm

public
styleClass: String
The name of the style class this instance will use.

public
tabModeWrap
root container wrap by default

public
topLevel: Boolean
are we a top level form

public
window
Reference to the window this form is contained in.

Fields inherited from class xp.controls.Container

__showStatusBar, __showTitleBar, acceptButton, cancelButton, children, classInfo, controlBar, controls, dataSource, enableBGMouseEvents, initialFocusControl, isRoot, lastFocus, layoutDescriptor, layoutId, layoutManager, rootContainer, styleClass, symbolId, tabList, tabModeWrap

Fields inherited from class xp.system.UIControl

__layout, allowDrop, autoLayout, bindingDefaultValue, bindingFormatter, bindingPath, bindingSource, bindingType, bindingValidator, border, causesValidation, classInfo, clickOnENTER, clickOnSPACE, container, context, data, disableAcceptButton, disableCancelButton, enableBGMouseEvents, enableDblClickEvent, enableKeyDownEvents, enableKeyEvents, enableKeyUpEvents, enableMouseWheelEvents, formatterOptions, horizontalAlignment, index, isBinding, itemId, logEnabled, parent, parentContainer, parentForm, percentageHeight, percentageWidth, styleClass, tabIndex, tabStop, tooltip, tree, verticalAlignment

Property Summary

public
application (read-only)
Reference to the application object

Properties inherited from class xp.controls.Container

childCount, footerHeight, headerHeight, innerBackground, innerBackgroundVisible, innerBorderBrush, innerBorderRadius, innerBorderStyle, innerBorderThickness, numChildren, showStatusBar, showTitleBar, status, title

Properties inherited from class xp.system.UIControl

alpha, autosize, background, backgroundVisible, bindings, borderBrush, borderRadius, borderShadow, borderStyle, borderThickness, bottom, dataSource, enableMouseEvents, focusManager, height, id, isEnabled, isFocused, isMouseOver, isPressed, isSelected, isValid, layout, left, margin, maxHeight, maxWidth, measuredHeight, measuredMinHeight, measuredMinWidth, measuredWidth, minHeight, minWidth, padding, readOnly, resources, right, styleName, top, triggers, visible, width, x, y

Constructor

public
Form ( )
Create a new Form instance

Method Summary

public
closeWait ( )
Closes the wait dialog

public
destroy ( ): Void
overrider to call the formOnClose handler

public
getClass ( ): Function
Returns a reference to the components static class

public
getDialogResultData ( ): Object
Allows a user defined data object to be returned to the Forms owner. This method is invoked by the window just prior to its closing and triggering the DialogResult event. The return value of this function will be passed as the data property of the DialogResult event

public
getFocusManager ( ): Object
Get the current SystemManager.

public
hide ( )
Hides the form and calls the formOnHide handler. This is usually called by the parent window on its content form

public
hideWait ( )
Hides the wait dialog

public
show ( )
Shows the form and calls the formOnShow handler This is usually called by the parent window on its content form

public
showWait ( message )
Shows the wait dialog

Methods inherited from class xp.controls.Container

addChild, addChildren, addControlBar, clearAll, createChild, destroyChildAt, getChild, getChildAt, getChildFromMouse, getClass, getFooterHeight, getHeaderHeight, getNextControl, getUIBuilder, getViewMetrics, initLayoutManager, onChildFocus, processEnterKey, processEscapeKey, registerChild, selectNextControl, setDataContext, setFocus, setMeasuredMinSize, setMeasuredSize, unregisterChild

Methods inherited from class xp.system.UIControl

addBinding, addBindings, addEventListener, addPropertyTrigger, applyStyle, beginDeferUpdate, canUpdate, centerContent, checkState, containsFocus, destroy, destroyObject, drawFocus, endDeferUpdate, findFocusFromObject, findFocusInChildren, getBinding, getBounds, getCenter, getClass, getFocus, getFocusManager, getFocusRect, getLocation, getPropertyValue, getSize, getStateName, getTrigger, globalToLocalPoint, invalidate, invalidateLayout, invalidateSize, invalidateSizeAndLayout, invalidChild, isChild, isMouseDirectlyOver, isParent, localToGlobalPoint, localToLocalPoint, measure, mouseWheel, move, onChildFocus, onKillFocus, onSetFocus, processEnterKey, processEscapeKey, processTabKey, redraw, refresh, removeEventListener, routeEvent, setBounds, setFocus, setLocation, setPropertyValue, setSize, setValueChanged, update, validate


Field Documentation

classInfo

public static var classInfo: Object
A static class information object

Every class has an associated classInfo object that holds the version and other static information. The classInfo can be accessed either directly by referencing the static class or by calling getClass() on any class instance.

isMainForm

public var isMainForm: Boolean
Indicates whether this form is the applications MainForm

styleClass

public var styleClass: String
The name of the style class this instance will use.

tabModeWrap

public var tabModeWrap
root container wrap by default

topLevel

public var topLevel: Boolean
are we a top level form

window

public var window
Reference to the window this form is contained in.

Property Documentation

application

public application (read-only)
Reference to the application object

Constructor Documentation

Form

public function Form()
Create a new Form instance

Do not call directly. Forms are usually instantiated by Windows, Frames or an MDIController via the source property or by Application as the application mainUI. A Form can also be placed on stage at design time as the Application mainUI. In this case it is necessary to set the the isMainForm property to true.

Method Documentation

closeWait

public function closeWait()
Closes the wait dialog

destroy

public function destroy(): Void
overrider to call the formOnClose handler

Overrides:
xp.system.UIControl.destroy in class xp.system.UIControl

getClass

public function getClass(): Function
Returns a reference to the components static class

Overrides:
Container.getClass in class Container

getDialogResultData

public function getDialogResultData(): Object
Allows a user defined data object to be returned to the Forms owner. This method is invoked by the window just prior to its closing and triggering the DialogResult event. The return value of this function will be passed as the data property of the DialogResult event

getFocusManager

public function getFocusManager(): Object
Get the current SystemManager.

Overrides:
xp.system.UIControl.getFocusManager in class xp.system.UIControl

hide

public function hide()
Hides the form and calls the formOnHide handler. This is usually called by the parent window on its content form

hideWait

public function hideWait()
Hides the wait dialog

decrement the wait counter and if it is 0 closes the wait dialog

show

public function show()
Shows the form and calls the formOnShow handler This is usually called by the parent window on its content form

showWait

public function showWait(message)
Shows the wait dialog

Show the dialog and increments the wait counter. Subsequent calls to show wait before hide wait is called will just increment the counter

The documentation was generated from the following file:

Generated on 10/30/2005 9:34:02 PM by AS2Doc