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

A control composed of two date fields, start date and end date, and an optional DateComboBox, that allows for easy keyboard entry of date ranges.


Public Properties
 PropertyDefined By
  autoRegister : Boolean
Register with the container on creation complete
DateRangeBox
  dateComboBoxOptions : Object
A key value pair to initialize the date combobox with.
DateRangeBox
  dateComboBoxWidth : Number = 19
The width of the date combobox.
DateRangeBox
  dateFieldOptions : Object
A key value pair to initialize the datefields with.
DateRangeBox
  dateFormatString : String
Date format for the custom date range popup
DateRangeBox
  dateRangeOptions : Array
An array of DateRange.DATE_RANGE_constants.
DateRangeBox
  defaultDateRange : String
One of the DateRange constants, defines the default date range.
DateRangeBox
  filterComparisionType : String
This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects.
DateRangeBox
  filterOperation : String
The filter operation to apply to the comparison See the FilterExpression class for a list.
DateRangeBox
  filterTriggerEvent : String
The event that the filter triggers on.
DateRangeBox
  grid : IExtendedDataGrid
The grid that the filter belongs to - can be null if filter is used outside the grid
DateRangeBox
  gridColumn : IDataGridFilterColumn
The grid column that the filter belongs to - can be null if filter is used outside the grid
DateRangeBox
  inputCharValidFunction : Function = null
Wire this up where you need character by character validation of entered text in the date text input.
DateRangeBox
  inputMask : String
Input mask for the date text input
DateRangeBox
  inputMaskDelimiters : String = /,(,),-
A comma seperated list of characters that should be treated as literal characters for input mask purposes.
DateRangeBox
  inputMaskForceLength : Boolean = true
Does not allow user to add more characters than those specified by the mask.
DateRangeBox
  maxValue : Object
[read-only] Returns the maximum value of the range
DateRangeBox
  minValue : Object
[read-only] Returns the minimum value of the range
DateRangeBox
  range : Array
eturns an array of [rangeStart,rangeEnd]
DateRangeBox
  rangeEnd : Date
The end of the range
DateRangeBox
  rangeStart : Date
The start of the range
DateRangeBox
  relinquishFocus : Boolean
[read-only] During filter tabbing, indicates that this control wishes to own its own tabbing, between the two boxes.
DateRangeBox
  rendererStyleName : String
DateRangeBox
  searchField : String
The field to search on, usually same as the data field.
DateRangeBox
  searchRangeEnd : Object
[read-only] f the range is invalid, returns the last value of the range.
DateRangeBox
  searchRangeStart : Object
[read-only] f the range is valid, returns the first value of the range.
DateRangeBox
  showDropdown : Boolean
Flag to control appearance of the dropdown;
DateRangeBox
Protected Properties
 PropertyDefined By
  dateComboBox : DateComboBox
The date combobbox
DateRangeBox
  endDateField : DateField
The End Date Field
DateRangeBox
  _filterControlInterface : FilterControlImpl
DateRangeBox
  separatorText : Text
The separator Text
DateRangeBox
  startDateField : DateField
The Start Date Field
DateRangeBox
Public Methods
 MethodDefined By
  
DateRangeBox()
DateRangeBox
  
clear():void
Clears out the textboxes
DateRangeBox
  
drawFocus(isFocused:Boolean):void
[override] raws the focus around the first textbox
DateRangeBox
  
getValue():Object
Generic function that returns the value of a IFilterControl
DateRangeBox
  
reset():void
ipes out the text boxes
DateRangeBox
  
setActualSize(w:Number, h:Number):void
[override]
DateRangeBox
  
setFocus():void
[override] ets the focus on the first checkbox
DateRangeBox
  
setValue(val:Object):void
Generic function that sets the value of a IFilterControl
DateRangeBox
Protected Methods
 MethodDefined By
  
commitProperties():void
[override]
DateRangeBox
  
createChildren():void
[override]
DateRangeBox
  
createDateComboBox():DateComboBox
DateRangeBox
  
createDateField():DateField
Creates a new DateField object.
DateRangeBox
  
onDateComboBoxChange(event:ListEvent):void
On combobox change, populate the date fields.
DateRangeBox
  
populateDateRange(dr:DateRange):void
Populates the date fields using the provided date range.
DateRangeBox
  
setFocusOnChild(child:IFocusManagerComponent):void
DateRangeBox
  
setupInputMask(df:DateField):void
Sets up the input Mask on the given DateField
DateRangeBox
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
dateComboBoxproperty 
protected var dateComboBox:DateComboBox

The date combobbox

dateComboBoxOptionsproperty 
public var dateComboBoxOptions:Object

A key value pair to initialize the date combobox with.

dateComboBoxWidthproperty 
public var dateComboBoxWidth:Number = 19

The width of the date combobox. Since we only show the button portion of the datecombobox, we set the default width to 19

dateFieldOptionsproperty 
public var dateFieldOptions:Object

A key value pair to initialize the datefields with.

dateFormatStringproperty 
public var dateFormatString:String

Date format for the custom date range popup

dateRangeOptionsproperty 
public var dateRangeOptions:Array

An array of DateRange.DATE_RANGE_constants.

defaultDateRangeproperty 
public var defaultDateRange:String

One of the DateRange constants, defines the default date range.

endDateFieldproperty 
protected var endDateField:DateField

The End Date Field

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
inputCharValidFunctionproperty 
public var inputCharValidFunction:Function = null

Wire this up where you need character by character validation of entered text in the date text input.

inputMaskproperty 
public var inputMask:String

Input mask for the date text input

inputMaskDelimitersproperty 
public var inputMaskDelimiters:String = /,(,),-

A comma seperated list of characters that should be treated as literal characters for input mask purposes. Defaults to /,(,),-

inputMaskForceLengthproperty 
public var inputMaskForceLength:Boolean = true

Does not allow user to add more characters than those specified by the mask. Set to true for date type masks, and false for telephone type masks where you would want the user to be able to enter an extension. Defaults to true

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:Date

The end of the range


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

The start of the range


Implementation
    public function get rangeStart():Date
    public function set rangeStart(value:Date):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
separatorTextproperty 
protected var separatorText:Text

The separator Text

showDropdownproperty 
showDropdown:Boolean

Flag to control appearance of the dropdown;


Implementation
    public function get showDropdown():Boolean
    public function set showDropdown(value:Boolean):void
startDateFieldproperty 
protected var startDateField:DateField

The Start Date Field

Constructor Detail
DateRangeBox()Constructor
public function DateRangeBox()



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

Clears out the textboxes

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

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

createDateComboBox()method 
protected function createDateComboBox():DateComboBox

Returns
DateComboBox
createDateField()method 
protected function createDateField():DateField

Creates a new DateField object.

Returns
DateField
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
onDateComboBoxChange()method 
protected function onDateComboBoxChange(event:ListEvent):void

On combobox change, populate the date fields.

Parameters

event:ListEvent

populateDateRange()method 
protected function populateDateRange(dr:DateRange):void

Populates the date fields using the provided date range.

Parameters

dr:DateRange

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

setupInputMask()method 
protected function setupInputMask(df:DateField):void

Sets up the input Mask on the given DateField

Parameters

df:DateField

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