| Package | com.keepcore |
| Class | public class KCTimePicker |
| Inheritance | KCTimePicker mx.controls.ComboBox |
The KCTimePicker component is used to select hour & minutes.
It is base on an editable comboBox allowing user to specify times not available in the list.
The component controls user entry and proposes a list of predefined values according to the startTime, endTime, timeInterval & showEmptyValue properties.
Default MXML PropertydataProvider
| Property | Defined By | ||
|---|---|---|---|
| allowNullTimeValue : Boolean
Indicates if null value can be returned by timeValue property. | KCTimePicker | ||
| endTime : Date
Indicates the end time for combobox items (only hours & minutes are taken in account). | KCTimePicker | ||
| isNullTime : Boolean [read-only]
Indicates if time value is or should be null. | KCTimePicker | ||
| showEmptyValue : Boolean
Indicates if first item in the time list should be an empty value allowing user to specify no time (timeValue will be null in this case). | KCTimePicker | ||
| startTime : Date
Indicates the start time for combobox items (only hours & minutes are taken in account). | KCTimePicker | ||
| timeInterval : int
Specify time interval in minutes of the combobox items. | KCTimePicker | ||
| timeValue : Date
Current time value. | KCTimePicker | ||
| Method | Defined By | ||
|---|---|---|---|
| KCTimePicker | |||
| Method | Defined By | ||
|---|---|---|---|
addToDisplayHandler(event:Event):void | KCTimePicker | ||
commitProperties():void [override]
Overriden commitProperties method. | KCTimePicker | ||
measure():void [override]
Overriden measure method. | KCTimePicker | ||
resourcesChanged():void [override]
Overriden resourcesChanged method. | KCTimePicker | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the selected time has been changed (item selection or user typing). | KCTimePicker | |||
| Constant | Defined By | ||
|---|---|---|---|
| TIME_CHANGED : String = timeChanged [static] | KCTimePicker | ||
| allowNullTimeValue | property |
allowNullTimeValue:BooleanIndicates if null value can be returned by timeValue property. It could happen in too case: bad user input or empty value selection. If set to false, bad user input value or empty value selection doesn't change time value. In both case, isNullTime property tells if the time value is or should be null.
This property can be used as the source for data binding.
public function get allowNullTimeValue():Boolean public function set allowNullTimeValue(value:Boolean):void| endTime | property |
endTime:DateIndicates the end time for combobox items (only hours & minutes are taken in account). Default value is xx/xx/xxxx 23:59.
This property can be used as the source for data binding.
public function get endTime():Date public function set endTime(value:Date):void| isNullTime | property |
isNullTime:Boolean [read-only] Indicates if time value is or should be null. Time value is or should be null (according to the allowNullTimeValue property) if it has not been set, if user types bad input or if user selects the empty value.
This property can be used as the source for data binding.
public function get isNullTime():Boolean| showEmptyValue | property |
showEmptyValue:BooleanIndicates if first item in the time list should be an empty value allowing user to specify no time (timeValue will be null in this case).
This property can be used as the source for data binding.
public function get showEmptyValue():Boolean public function set showEmptyValue(value:Boolean):void| startTime | property |
startTime:DateIndicates the start time for combobox items (only hours & minutes are taken in account). Default value is xx/xx/xxxx 00:00.
This property can be used as the source for data binding.
public function get startTime():Date public function set startTime(value:Date):void| timeInterval | property |
timeInterval:intSpecify time interval in minutes of the combobox items.
This property can be used as the source for data binding.
public function get timeInterval():int public function set timeInterval(value:int):void| timeValue | property |
timeValue:DateCurrent time value. Set this property to update the component display (item is selected if it is in the times array). Read it to get the selected time or user typed time.
This property can be used as the source for data binding.
public function get timeValue():Date public function set timeValue(value:Date):void| KCTimePicker | () | Constructor |
public function KCTimePicker()| addToDisplayHandler | () | method |
protected function addToDisplayHandler(event:Event):voidParameters
event:Event |
| commitProperties | () | method |
override protected function commitProperties():voidOverriden commitProperties method.
| measure | () | method |
override protected function measure():voidOverriden measure method.
| resourcesChanged | () | method |
override protected function resourcesChanged():voidOverriden resourcesChanged method. Update hour format on the fly.
| timeChanged | Event |
flash.events.Eventflash.events.EventDispatched when the selected time has been changed (item selection or user typing).
| TIME_CHANGED | Constant |
public static const TIME_CHANGED:String = timeChanged