Packagecom.keepcore
Classpublic class KCTimePicker
InheritanceKCTimePicker Inheritance 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



Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined By
  
KCTimePicker
Protected Methods
 MethodDefined By
  
addToDisplayHandler(event:Event):void
KCTimePicker
  
[override] Overriden commitProperties method.
KCTimePicker
  
measure():void
[override] Overriden measure method.
KCTimePicker
  
[override] Overriden resourcesChanged method.
KCTimePicker
Events
 Event Summary Defined By
  Dispatched when the selected time has been changed (item selection or user typing).KCTimePicker
Public Constants
 ConstantDefined By
  TIME_CHANGED : String = timeChanged
[static]
KCTimePicker
Property Detail
allowNullTimeValueproperty
allowNullTimeValue:Boolean

Indicates 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.


Implementation
    public function get allowNullTimeValue():Boolean
    public function set allowNullTimeValue(value:Boolean):void
endTimeproperty 
endTime:Date

Indicates 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.


Implementation
    public function get endTime():Date
    public function set endTime(value:Date):void
isNullTimeproperty 
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.


Implementation
    public function get isNullTime():Boolean
showEmptyValueproperty 
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).

This property can be used as the source for data binding.


Implementation
    public function get showEmptyValue():Boolean
    public function set showEmptyValue(value:Boolean):void
startTimeproperty 
startTime:Date

Indicates 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.


Implementation
    public function get startTime():Date
    public function set startTime(value:Date):void
timeIntervalproperty 
timeInterval:int

Specify time interval in minutes of the combobox items.

This property can be used as the source for data binding.


Implementation
    public function get timeInterval():int
    public function set timeInterval(value:int):void
timeValueproperty 
timeValue:Date

Current 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.


Implementation
    public function get timeValue():Date
    public function set timeValue(value:Date):void
Constructor Detail
KCTimePicker()Constructor
public function KCTimePicker()



Method Detail
addToDisplayHandler()method
protected function addToDisplayHandler(event:Event):void

Parameters

event:Event

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

Overriden commitProperties method.

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

Overriden measure method.

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

Overriden resourcesChanged method. Update hour format on the fly.

Event Detail
timeChanged Event
Event Object Type: flash.events.Event
Event.type property = flash.events.Event

Dispatched when the selected time has been changed (item selection or user typing).

Constant Detail
TIME_CHANGEDConstant
public static const TIME_CHANGED:String = timeChanged