Main Page | Packages | Class Tree | Index | Help

xp.controls

class PromptBox

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


class PromptBox
extends Form

PromptBox
A modal dialog that display information about the application

Commonly used to prompt the user for some information.
This is Form is loaded into a modal Window at run time.
It is not commonly instantiated directly but via methods of the Application or CommonDialog objects.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

static
ALERT
Constants for alert dialog types - alert

static
INFO
Constants for alert dialog types- information

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

static
WARN
Constants for alert dialog types -warning

Fields inherited from class xp.controls.Form

classInfo, isMainForm, styleClass, tabModeWrap, topLevel, window

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

Properties inherited from class xp.controls.Form

application

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


PromptBox ( )
Constructor - This should not be called directly.


Method Summary

public
getDialogResultData ( ): Object
Return dialog result data

public
setMessage ( v )
Sets the message to display whilst the form is visible

public
setPrompt ( prompt )
Sets the initial content of the prompt box

Methods inherited from class xp.controls.Form

closeWait, destroy, getClass, getDialogResultData, getFocusManager, hide, hideWait, show, showWait

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

ALERT

static var ALERT
Constants for alert dialog types - alert

INFO

static var INFO
Constants for alert dialog types- information

styleClass

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

WARN

static var WARN
Constants for alert dialog types -warning


Constructor Documentation

PromptBox

function PromptBox()
Constructor - This should not be called directly.

If you want to dynamically create a new instance of this control use methods in Application or CommonDialog.


Method Documentation

getDialogResultData

public function getDialogResultData(): Object
Return dialog result data

Overrides:

setMessage

public function setMessage(v)
Sets the message to display whilst the form is visible

setPrompt

public function setPrompt(prompt)
Sets the initial content of the prompt box


The documentation was generated from the following file:


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