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

class CheckBoxList

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.ButtonList
              |
              +--xp.controls.CheckBoxList

class CheckBoxList
extends ButtonList

CheckBoxList
Represents a list control that encapsulates a group of checkbox controls.

It generates and lays out a set of CheckBoxes within its own container
The CheckBoxList simplifies the management of a gorup of checkbox's
It is particularly useful where you have want to bind to a single data field that contains multiple values.
i.e FavoriteColors "red,blue,green"; The list will parse the value, check the appropriate boxes and when the a value changes it will update the data field. The selected values can be returned either as a csv string using selectedValue property or as an array of values using getSelectedValues.
Events:
valueChanged xp.events.ValueChangedEvent


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.

Fields inherited from class xp.controls.ButtonList

__itemStyle, classInfo, dataItems, labels, selectedItem, selectedValue, tabStop

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
selectedValue: String (read, write)
Gets or sets the selected value of the group

Properties inherited from class xp.controls.ButtonList

columns, flowOrientation, groupName, items, itemsSource, itemStyle, labelPosition, labelText, selectedIndex

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
CheckBoxList ( )
Constructor - This should not be called directly.


Method Summary

public
addItem ( item: Object ): Void
Adds an item to the end of the list.

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

public
getSelectedValues ( ): Array
Gets the array of selected value of the group

public static
newInstance ( owner, instanceId, depth, initObj )
Creates a new Instance of this class

Methods inherited from class xp.controls.ButtonList

addItem, getClass, setGroupItems, setNext, setSelectedItem

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.

Property Documentation

selectedValue

public selectedValue: String (read, write)
Gets or sets the selected value of the group

For a CheckBoxList the value is a CSV string of the checkbox values

Constructor Documentation

CheckBoxList

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

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

Method Documentation

addItem

public function addItem(item: Object): Void
Adds an item to the end of the list.

Adds a new item to the end of the list.

Overrides:
ButtonList.addItem in class ButtonList

Parameters:
item
An item object that usually has label and data properties.

getClass

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

Overrides:
ButtonList.getClass in class ButtonList

getSelectedValues

public function getSelectedValues(): Array
Gets the array of selected value of the group

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.

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:

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