Packagecom.flexicious.controls
Classpublic class NumericRangeBox
InheritanceNumericRangeBox Inheritance mx.containers.HBox
Implements IRangeFilterControl, IFilterControl, mx.managers.IFocusManagerComponent, IFocusControllerComponent

An HBox that contains two textboxes to specify a range. Implements IRangeFilterControl (IFilterControl) which enables it to be used within the filtering/binding infrasturcture.

See also

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


Public Properties
 PropertyDefined By
  autoRegister : Boolean
Register with the container on creation complete
NumericRangeBox
  filterComparisionType : String
This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects.
NumericRangeBox
  filterOperation : String
The filter operation to apply to the comparison See the FilterExpression class for a list.
NumericRangeBox
  filterTriggerEvent : String
The event that the filter triggers on.
NumericRangeBox
  grid : IExtendedDataGrid
The grid that the filter belongs to - can be null if filter is used outside the grid
NumericRangeBox
  gridColumn : IDataGridFilterColumn
The grid column that the filter belongs to - can be null if filter is used outside the grid
NumericRangeBox
  maxValue : Object
[read-only] Returns the maximum value of the range
NumericRangeBox
  minValue : Object
[read-only] Returns the minimum value of the range
NumericRangeBox
  range : Array
eturns an array of [rangeStart,rangeEnd]
NumericRangeBox
  rangeEnd : Number
The end of the range
NumericRangeBox
  rangeStart : Number
The start of the range
NumericRangeBox
  relinquishFocus : Boolean
[read-only] During filter tabbing, indicates that this control wishes to own its own tabbing, between the two boxes.
NumericRangeBox
  rendererStyleName : String
NumericRangeBox
  searchField : String
The field to search on, usually same as the data field.
NumericRangeBox
  searchRangeEnd : Object
[read-only] f the range is invalid, returns the last value of the range.
NumericRangeBox
  searchRangeStart : Object
[read-only] f the range is valid, returns the first value of the range.
NumericRangeBox
Protected Properties
 PropertyDefined By
  _filterControlInterface : FilterControlImpl
NumericRangeBox
Public Methods
 MethodDefined By
  
NumericRangeBox
  
clear():void
Clears out the textboxes
NumericRangeBox
  
drawFocus(isFocused:Boolean):void
[override] raws the focus around the first textbox
NumericRangeBox
  
getValue():Object
Generic function that returns the value of a IFilterControl
NumericRangeBox
  
reset():void
ipes out the text boxes
NumericRangeBox
  
setActualSize(w:Number, h:Number):void
[override]
NumericRangeBox
  
setFocus():void
[override] ets the focus on the first checkbox
NumericRangeBox
  
setValue(val:Object):void
Generic function that sets the value of a IFilterControl
NumericRangeBox
Protected Methods
 MethodDefined By
  
[override]
NumericRangeBox
  
setFocusOnChild(child:IFocusManagerComponent):void
NumericRangeBox
Property Detail
_filterControlInterfaceproperty
protected var _filterControlInterface:FilterControlImpl

autoRegisterproperty 
autoRegister:Boolean

Register with the container on creation complete


Implementation
    public function get autoRegister():Boolean
    public function set autoRegister(value:Boolean):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

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
maxValueproperty 
maxValue:Object  [read-only]

Returns the maximum value of the range


Implementation
    public function get maxValue():Object
minValueproperty 
minValue:Object  [read-only]

Returns the minimum value of the range


Implementation
    public function get minValue():Object
rangeproperty 
range:Array

eturns an array of [rangeStart,rangeEnd]


Implementation
    public function get range():Array
    public function set range(value:Array):void
rangeEndproperty 
rangeEnd:Number

The end of the range


Implementation
    public function get rangeEnd():Number
    public function set rangeEnd(value:Number):void
rangeStartproperty 
rangeStart:Number

The start of the range


Implementation
    public function get rangeStart():Number
    public function set rangeStart(value:Number):void
relinquishFocusproperty 
relinquishFocus:Boolean  [read-only]

During filter tabbing, indicates that this control wishes to own its own tabbing, between the two boxes. If user tabs out of the second box or shift tabs out of the first box, it relinquishes focus to the tabbing mechanism of the filter row.


Implementation
    public function get relinquishFocus():Boolean
rendererStyleNameproperty 
public var rendererStyleName:String

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
searchRangeEndproperty 
searchRangeEnd:Object  [read-only]

f the range is invalid, returns the last value of the range.


Implementation
    public function get searchRangeEnd():Object
searchRangeStartproperty 
searchRangeStart:Object  [read-only]

f the range is valid, returns the first value of the range.


Implementation
    public function get searchRangeStart():Object
Constructor Detail
NumericRangeBox()Constructor
public function NumericRangeBox()



Method Detail
clear()method
public function clear():void

Clears out the textboxes

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

drawFocus()method 
override public function drawFocus(isFocused:Boolean):void

raws the focus around the first textbox

Parameters

isFocused:Boolean

getValue()method 
public function getValue():Object

Generic function that returns the value of a IFilterControl

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

ipes out the text boxes

setActualSize()method 
override public function setActualSize(w:Number, h:Number):void

Parameters

w:Number
 
h:Number

setFocus()method 
override public function setFocus():void

ets the focus on the first checkbox

setFocusOnChild()method 
protected function setFocusOnChild(child:IFocusManagerComponent):void

Parameters

child:IFocusManagerComponent

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

Generic function that sets the value of a IFilterControl

Parameters

val:Object