Packagecom.flexicious.controls
Classpublic class ComboBox
InheritanceComboBox Inheritance mx.controls.ComboBox
Implements ISingleSelectFilterControl, ISingleSelectDataBoundControl
Subclasses DateComboBox

A ComboBox that implements ISingleSelectFilterControl (IFilterControl) and ISingleSelectDataBoundControl (IDataBoundControl) which enables it to be used within the filtering/binding infrasturcture.

Default MXML PropertydataProvider

See also

com.flexicious.controls.interfaces.filters.IFilterControl
com.flexicious.controls.interfaces.databindings.IDataBoundControl

Public Properties
 PropertyDefined By
  addAllItem : Boolean
Flag, when set will cause the associated control to have an Filter.ALL_ITEM Item value, which can then be used by the filtering infrastructure to ignore the column in the search
ComboBox
  addAllItemText : String
Text of the "All" item.
ComboBox
  autoRegister : Boolean
Register with the container on creation complete
ComboBox
  bindingTriggerEvent : String
The event to trigger the binding on.
ComboBox
  dataField : String
For Selected Value Support
ComboBox
  dataProvider : Object
[override] [write-only]
ComboBox
  filterComparisionType : String
This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects.
ComboBox
  filterOperation : String
The filter operation to apply to the comparison See the FilterExpression class for a list.
ComboBox
  filterTriggerEvent : String
The event that the filter triggers on.
ComboBox
  grid : IExtendedDataGrid
The grid that the filter belongs to - can be null if filter is used outside the grid
ComboBox
  gridColumn : IDataGridFilterColumn
The grid column that the filter belongs to - can be null if filter is used outside the grid
ComboBox
  hasSearch : Boolean
ComboBox
  rendererStyleName : String
ComboBox
  rowHeight : Number
Height of the dropdown
ComboBox
  searchField : String
The field to search on, usually same as the data field.
ComboBox
  selectedIndex : int
[override] [write-only]
ComboBox
  selectedValue : Object
Gets the selected value on our comboboxes.
ComboBox
Protected Properties
 PropertyDefined By
  _filterControlInterface : FilterControlImpl
ComboBox
Public Methods
 MethodDefined By
  
ComboBox()
ComboBox
  
callCalculatePreferredSizeFromData(count:int):Object
ComboBox
  
clear():void
ComboBox
  
getValue():Object
Generic function that returns the value of a IFilterControl
ComboBox
  
setSourceFromControl():void
ComboBox
  
setValue(val:Object):void
Generic function that sets the value of a IFilterControl
ComboBox
Protected Methods
 MethodDefined By
  
calculatePreferredSizeFromData(count:int):Object
[override] http://bugs.adobe.com/jira/browse/SDK-16727
ComboBox
  
commitProperties():void
[override]
ComboBox
Property Detail
_filterControlInterfaceproperty
protected var _filterControlInterface:FilterControlImpl

addAllItemproperty 
addAllItem:Boolean

Flag, when set will cause the associated control to have an Filter.ALL_ITEM Item value, which can then be used by the filtering infrastructure to ignore the column in the search


Implementation
    public function get addAllItem():Boolean
    public function set addAllItem(value:Boolean):void
addAllItemTextproperty 
addAllItemText:String

Text of the "All" item. Defaults to "All"


Implementation
    public function get addAllItemText():String
    public function set addAllItemText(value:String):void
autoRegisterproperty 
autoRegister:Boolean

Register with the container on creation complete


Implementation
    public function get autoRegister():Boolean
    public function set autoRegister(value:Boolean):void
bindingTriggerEventproperty 
bindingTriggerEvent:String

The event to trigger the binding on. Defaults to none, so you must call applyChanges on the container to update the souce object.


Implementation
    public function get bindingTriggerEvent():String
    public function set bindingTriggerEvent(value:String):void
dataFieldproperty 
dataField:String

For Selected Value Support


Implementation
    public function get dataField():String
    public function set dataField(value:String):void
dataProviderproperty 
dataProvider:Object  [write-only] [override]


Implementation
    public function set dataProvider(value:Object):void
filterComparisionTypeproperty 
filterComparisionType:String

This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion. Values : auto,string,number,boolean,date

The default value is auto.


Implementation
    public function get filterComparisionType():String
    public function set filterComparisionType(value:String):void
filterOperationproperty 
filterOperation:String

The filter operation to apply to the comparison See the FilterExpression class for a list. Please note, for CheckBoxList and MultiSelectComboBox, this field defaults to "InList" and is ignored when set. see


Implementation
    public function get filterOperation():String
    public function set filterOperation(value:String):void
filterTriggerEventproperty 
filterTriggerEvent:String

The event that the filter triggers on. Defaults to "change", or if the filterRenderer supports com.flexicious.controls.interfaces.IDelayedChange, then the delayedChange event.


Implementation
    public function get filterTriggerEvent():String
    public function set filterTriggerEvent(value:String):void

See also

com.flexicious.controls.interfaces.IDelayedChange
gridproperty 
grid:IExtendedDataGrid

The grid that the filter belongs to - can be null if filter is used outside the grid


Implementation
    public function get grid():IExtendedDataGrid
    public function set grid(value:IExtendedDataGrid):void
gridColumnproperty 
gridColumn:IDataGridFilterColumn

The grid column that the filter belongs to - can be null if filter is used outside the grid


Implementation
    public function get gridColumn():IDataGridFilterColumn
    public function set gridColumn(value:IDataGridFilterColumn):void
hasSearchproperty 
hasSearch:Boolean


Implementation
    public function get hasSearch():Boolean
    public function set hasSearch(value:Boolean):void
rendererStyleNameproperty 
public var rendererStyleName:String

rowHeightproperty 
rowHeight:Number

Height of the dropdown


Implementation
    public function get rowHeight():Number
    public function set rowHeight(value:Number):void
searchFieldproperty 
searchField:String

The field to search on, usually same as the data field.


Implementation
    public function get searchField():String
    public function set searchField(value:String):void
selectedIndexproperty 
selectedIndex:int  [write-only] [override]


Implementation
    public function set selectedIndex(value:int):void
selectedValueproperty 
selectedValue:Object

Gets the selected value on our comboboxes. Just like the selected label, but applies to the data property. Needs the datafield property to be set.


Implementation
    public function get selectedValue():Object
    public function set selectedValue(value:Object):void
Constructor Detail
ComboBox()Constructor
public function ComboBox()



Method Detail
calculatePreferredSizeFromData()method
override protected function calculatePreferredSizeFromData(count:int):Object

http://bugs.adobe.com/jira/browse/SDK-16727

Parameters

count:int

Returns
Object
callCalculatePreferredSizeFromData()method 
public function callCalculatePreferredSizeFromData(count:int):Object

Parameters

count:int

Returns
Object
clear()method 
public function clear():void

commitProperties()method 
override protected function commitProperties():void

getValue()method 
public function getValue():Object

Generic function that returns the value of a IFilterControl

Returns
Object
setSourceFromControl()method 
public function setSourceFromControl():void

setValue()method 
public function setValue(val:Object):void

Generic function that sets the value of a IFilterControl

Parameters

val:Object




Copyright 2012 Flexicious LLC. All rights reserved.

Mon Jun 24 2013, 11:00 PM -04:00