org.openPyro.controls.ComboBox

Public Properties

	Property		Defined by
		backgroundPainter : IPainter UIControls can have a backgroundPainter object attached that is triggered everytime updateDisplayList is called.	UIControl
		_bttnLabelFunction : Function	ComboBox
		button : Button [write-only]	ComboBox
		creationCompleteFired : Boolean	MeasurableControl
		dataProvider : Array [write-only]	ComboBox
		displayListInvalidated : Boolean = true Flag to mark a dirty displaylist.	MeasurableControl
		dragData : Object	UIControl
		dragEnabled : Boolean	UIControl
		dropEnabled : Boolean	UIControl
		explicitWidth : Number The height set in terms of actual pixels.	MeasurableControl
		forceInvalidateDisplayList : Boolean = false	MeasurableControl
		height : Number Set/get the height of the control.	MeasurableControl
		includeInLayout : Boolean Specifies whether this control participates in the layout system in OpenPyro.	MeasurableControl
		initialized : Boolean = false Property indicates whether a control has been initialized or not.	MeasurableControl
		list : List [write-only]	ComboBox
		maxDropDownHeight : Number Sets the height of the dropdown list.	ComboBox
		maximumHeight : Number	MeasurableControl
		maximumWidth : Number	MeasurableControl
		measuredHeight : Number Overrides the set measuredHeight property from `MeasurableControl` to invalidate children (UIControl acknowledges that it can have children whose dimensions are based on its own)	UIControl
		measuredWidth : Number Overrides the set measuredWidth property from `MeasurableControl` to invalidate children (UIControl acknowledges that it can have children whose dimensions are based on its own)	UIControl
		mouseActionsDisabled : Boolean	MeasurableControl
		needsMeasurement : Boolean = true Only setting percent width/heights changes the needsMeasurement flag which makes its parent container call measure on it.	MeasurableControl
		padding : Padding Paddings define the unusable space within UIContainers that should not be used for measurement and layout.	UIControl
		parentContainer : UIControl	MeasurableControl
		percentHeight : Number	MeasurableControl
		percentUnusedHeight : Number Set/get the percent height.	MeasurableControl
		percentUnusedWidth : Number Set/get the percent width.	MeasurableControl
		percentWidth : Number	MeasurableControl
		selectedIndex : int [read-only]	ComboBox
		sizeInvalidated : Boolean = false The flag to mark that the control's size has been invalidated.	MeasurableControl
		skin : ISkin [write-only]	ComboBox
		skinnedControl : UIControl	UIControl
		styleName : String Defines the skin this component is registered to.	UIControl
		toolTip : *	UIControl
		usesMeasurementStrategy : Boolean This property defines whether measure() will be called during validateSize() or not.	MeasurableControl
		visible : Boolean	MeasurableControl
		width : Number Set/get the width of the control.	MeasurableControl

	Property	Defined by
		_backgroundPainter : IPainter	UIControl
		_creationCompleteFired : Boolean = false	MeasurableControl
		_dataProvider : Array	ComboBox
		_dimensionsChanged : Boolean = true	MeasurableControl
		_dragEnabled : Boolean = false	UIControl
		_dropEnabled : Boolean = false	UIControl
		_explicitHeight : Number = NaN	MeasurableControl
		_explicitWidth : Number = NaN	MeasurableControl
		isMouseDown : Boolean = false	UIControl
		_isOpen : Boolean = false	ComboBox
		_maskShape : Shape	ComboBox
		_maxDropDownHeight : Number = NaN	ComboBox
		_maximumHeight : Number = NaN	MeasurableControl
		_maximumWidth : Number = NaN	MeasurableControl
		_measuredHeight : Number = NaN	MeasurableControl
		_measuredWidth : Number = NaN	MeasurableControl
		_mouseActionsDisabled : Boolean = false	MeasurableControl
		_padding : Padding	UIControl
		_parentContainer : UIControl	MeasurableControl
		_percentHeight : Number	MeasurableControl
		_percentUnusedHeight : Number	MeasurableControl
		_percentUnusedWidth : Number	MeasurableControl
		_percentWidth : Number	MeasurableControl
		_selectedIndex : int = -1	ComboBox
		_skin : ISkin	UIControl
		_skinnedControl : UIControl	UIControl
		_styleName : String	UIControl
		_toolTipData : *	UIControl
		toolTipRenderer : Class	UIControl

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		ComboBox()	ComboBox
		addChild(child:DisplayObject):DisplayObject	UIControl
		addChildAt(child:DisplayObject, index:int):DisplayObject	UIControl
		cancelMouseEvents():void	MeasurableControl
		checkDisplayListValidation():void Calls the queueValidateDisplayList if measure causes _dimensionsChanged to change to true.	UIControl
		close():void	ComboBox
		dispose():void	UIControl
		doLayoutChildren():void	UIControl
		doOnAdded():void [Temp] This function is called automatically by a parent UIControl if this is created as a child of a UIControl.	MeasurableControl
		enableMouseEvents():void	MeasurableControl
		getExplicitOrMeasuredHeight():Number Returns the explicitly defined height or the measured height computed by the `measure` function.	MeasurableControl
		getExplicitOrMeasuredWidth():Number Returns the explicitly defined width or the measured number computed by the `measure` function.	MeasurableControl
		heightForMeasurement():Number When measure is called, it uses the widthForMeasurement and heightForMeasurement to calculate the sizes for percent-dimension based children	UIControl
		initialize():void	ComboBox
		invalidateSize(event:PyroEvent = null):void Marks itself dirty and waits till either the container to validateSize or validates itself at the next enterframe if it has no parent container.	MeasurableControl
		isMouseOver(event:MouseEvent):Boolean Utility function to check if a mouseEvent happened while the mouse was over the displayObject	MeasurableControl
		measure():void Measure is called during the validateSize if the needsmeasurement flag is set.	UIControl
		open():void	ComboBox
		position(x:Number, y:Number):UIControl	UIControl
		queueValidateDisplayList(event:PyroEvent = null):void This function is called if the framework determines that dimensions of the control have changed.	MeasurableControl
		removeBackgroundPainter():void	UIControl
		removeChild(d:DisplayObject):DisplayObject	UIControl
		resizeHandler():void	MeasurableControl
		size(w:, h:):UIControl Convinience function for setting width and height in one call.	UIControl
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void	ComboBox
		validateDisplayList(event:Event = null):void validateDisplayList is called as a response to invalidateDisplayList.	MeasurableControl
		validateSize():void The validateSize function is called in response to a component declaring its size invalid (usually by calling invalidateSize()).	MeasurableControl
		widthForMeasurement():Number When measure is called, it uses the widthForMeasurement and heightForMeasurement to calculate the sizes for percent-dimension based children	UIControl

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		calculateMeasuredHeight():void Calculates the measuredHeight property.	MeasurableControl
		calculateMeasuredWidth():void Calculates the measuredWidth property.	MeasurableControl
		createChildren():void This is where the new children should be created and then added to the displaylist.	MeasurableControl
		disableEvent(event:Event):void	MeasurableControl
		dispatchDragStart(event:MouseEvent):void	UIControl
		dispatchUpdateComplete():void Dispatches the UpdateComplete event	MeasurableControl
		doChildBasedValidation():void While UIControls can be sized based on the dimensions of the parent container, if the explicit or percent dimension values are not specified, the UIControl can look at its children's dimensions and base its sizing off them.	UIControl
		doQueuedValidateSize(event:Event):void doQueueValidateSize is executed by the top level UIControl.	MeasurableControl
		handlePreDragMouseDown(event:Event):void This function is called if the UIControl instance is drag enabled and the user clicks the mouse down.	UIControl
		invalidateDisplayList():void	MeasurableControl
		onAddedToParent(event:Event):void The event listener executed when this component has been added to the parent.	MeasurableControl
		onListChange(event:ListEvent):void	ComboBox
		onListItemClick(event:ListEvent):void	ComboBox
		onSkinnedControlResize(event:Event):void Event handler for when the UIControl is applied as a Skin and the control it is skinning is resized.	UIControl
		onStageClick(event:MouseEvent):void	ComboBox

Property detail

_bttnLabelFunction

property

public var _bttnLabelFunction:Function

button

property

button:Button [write-only]Implementation
public function set button(value:Button):void

_dataProvider

property

protected var _dataProvider:Array

dataProvider

property

dataProvider:Array [write-only]Implementation
public function set dataProvider(value:Array):void

_isOpen

property

protected var _isOpen:Boolean = false

list

property

list:List [write-only]Implementation
public function set list(value:List):void

_maskShape

property

protected var _maskShape:Shape

_maxDropDownHeight

property

protected var _maxDropDownHeight:Number = NaN

maxDropDownHeight

property

maxDropDownHeight:Number [read-write]

Sets the height of the dropdown list. If this value is set and the list's data needs more height than that was set as the maxDropDownHeight, the list tries to create a scrollbar as long as the IComboButtonSkin specifies a List skin with Scrollbars defined.

Implementation
public function get maxDropDownHeight():Number
public function set maxDropDownHeight(value:Number):void

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class ComboBox	Properties \| Methods \| Events

Package	org.openPyro.controls
Class	public class ComboBox
Inheritance	ComboBox UIControl MeasurableControl flash.display.Sprite

	Event		Summary	Defined by
		change		ComboBox
		close		ComboBox
		dragDrop		UIControl
		initialize		MeasurableControl
		itemClick		ComboBox
		open		ComboBox
		preInitialize		MeasurableControl
		propertyChange		MeasurableControl
		resize		MeasurableControl
		sizeChanged		MeasurableControl
		sizeInvalidated		MeasurableControl
		sizeValidated		MeasurableControl
		updateComplete		MeasurableControl

	`unscaledWidth:Number`

	`unscaledHeight:Number`