XPComponents: class xp.controls.CheckBox

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

xp.controls

class CheckBox

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.TextBase
              |
              +--xp.controls.Label
                    |
                    +--xp.controls.CheckBox

class CheckBox
extends Label

CheckBox
trueValue and falseValue properties determin the value returned by getValue when the control is checked or not

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

styleClass: String

The name of the style class this instance will use.

public

tabStop: Boolean

Fields inherited from class xp.controls.Label

classInfo, styleClass

Fields inherited from class xp.controls.TextBase

leading, leftMargin, rightMargin, textIndent

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

checked: Boolean (read, write)

Controls the intial state of the checkbox.

public

falseValue (read)

The value or object to be returned if the checkbox is unchecked and no data has been defined. Defaults to false

public

falseValue: Object (write)

public

trueValue (read)

The value or object to be returned if the checkbox is checked and no data has been defined. Defaults to true.

public

trueValue: Object (write)

public

value: Object (read)

Gets or sets the value property

public

value: (write)

Properties inherited from class xp.controls.Label

autoEllipsis, hAnchorPoint, html, icon, iconIndex, styleSheet, vAnchorPoint

Properties inherited from class xp.controls.TextBase

font, fontBold, fontColor, fontEmbed, fontFamily, fontItalic, fontName, fontSize, fontStyle, fontUnderline, fontWeight, text, textAlign, textDecoration, textWrap

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

CheckBox ( )

Constructor - This should not be called directly.

Method Summary

public

getClass ( ): Function

Returns a reference to the components static class

public

getFocusRect ( ): Object

override to set focus ring to icon

public static

newInstance ( owner, instanceId, depth, initObj )

Creates a new Instance of this class

Methods inherited from class xp.controls.Label

drawComponent, getClass, newInstance

Methods inherited from class xp.controls.TextBase

getTextEllipsis, getTextExtent

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.

styleClass

public var styleClass: String

The name of the style class this instance will use.

tabStop

public var tabStop: Boolean

Property Documentation

checked

public checked

: Boolean (read, write)

Controls the intial state of the checkbox.

falseValue

public falseValue

(read)

The value or object to be returned if the checkbox is unchecked and no data has been defined. Defaults to false

falseValue

public falseValue

: Object (write)

trueValue

public trueValue

(read)

The value or object to be returned if the checkbox is checked and no data has been defined. Defaults to true.

trueValue

public trueValue

: Object (write)

value

public value

: Object (read)

Gets or sets the value property

If the data property has been set the value returns the data if checked or otherwise null. If no data has been set it returns the trueValue if checked otherwise falseValue.

value

public value

: (write)

Constructor Documentation

CheckBox

public function CheckBox

()

Constructor - This should not be called directly.

If you want to dynamically create a new instance of a control use its static newInstance method

Method Documentation

getClass

public function getClass

(): Function

Returns a reference to the components static class

Overrides:: Label.getClass in class Label

getFocusRect

public function getFocusRect

(): Object

override to set focus ring to icon

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

newInstance

public static function newInstance

(owner,
instanceId,
depth,
initObj)

Creates a new Instance of this class

Creates an instance of a component at runtime. You need to use the import statement and specify the class package name before calling this method. In addition, the component must be in the FLA file’s library.

Overrides:: Label.newInstance in class Label

Parameters:

owner		A reference to the movie clip or object that will contains the new Instance.
instanceId		A string indicating the instance name of the new instance.(optional)
depth		A number indicating the depth of the new instance.(optional)
initObj		An object containing initialization properties for the new instance.(optional)

Returns:: A object that is an instance of the specified class.

The documentation was generated from the following file:

CheckBox.as, Last Modified: 10/29/2005 10:02:26 PM

AS2Doc