Displays a calendar month view that allows the selection of a date. The header displays the current month and year name, along with buttons to change the currently displayed month and year. The buttons in the header may be hidden, if desired.

The following example creates a date picker, sets the selected date, and listens for when the selection changes:

var datePicker = new DatePicker();
datePicker.selectedDate = new Date(2020, 1, 6);
datePicker.addEventListener(Event.CHANGE, (event:Event) -> {
	var datePicker = cast(event.currentTarget, DatePicker);
	trace("DatePicker changed: " + datePicker.selectedDate);
});
this.addChild(datePicker);

Events:

openfl.events.Event.CHANGE

Dispatched when DatePicker.selectedDate changes.

feathers.events.DatePickerEvent.ITEM_TRIGGER

Dispatched when the user taps or clicks an item renderer in the date picker. The pointer must remain within the bounds of the item renderer on release, or the gesture will be ignored.

Available since

1.0.0

.

See also:

Static variables

@:value("datePicker_dateRenderer")staticfinalread onlyCHILD_VARIANT_DATE_RENDERER:String = "datePicker_dateRenderer"

The variant used to style the date picker's date renderers in a theme.

To override this default variant, set the DatePicker.customDateRendererVariant property.

Available since

1.0.0

.

See also:

@:value("datePicker_decrementMonthButton")staticfinalread onlyCHILD_VARIANT_DECREMENT_MONTH_BUTTON:String = "datePicker_decrementMonthButton"

The variant used to style the decrement month Button child component in a theme.

To override this default variant, set the DatePicker.customDecrementMonthButtonVariant property.

Available since

1.0.0

.

See also:

@:value("datePicker_decrementYearButton")staticfinalread onlyCHILD_VARIANT_DECREMENT_YEAR_BUTTON:String = "datePicker_decrementYearButton"

The variant used to style the decrement year Button child component in a theme.

To override this default variant, set the DatePicker.customDecrementYearButtonVariant property.

Available since

1.0.0

.

See also:

@:value("datePicker_incrementMonthButton")staticfinalread onlyCHILD_VARIANT_INCREMENT_MONTH_BUTTON:String = "datePicker_incrementMonthButton"

The variant used to style the increment month Button child component in a theme.

To override this default variant, set the DatePicker.customIncrementMonthButtonVariant property.

Available since

1.0.0

.

See also:

@:value("datePicker_incrementYearButton")staticfinalread onlyCHILD_VARIANT_INCREMENT_YEAR_BUTTON:String = "datePicker_incrementYearButton"

The variant used to style the increment year Button child component in a theme.

To override this default variant, set the DatePicker.customIncrementYearButtonVariant property.

Available since

1.0.0

.

See also:

@:value("datePicker_monthTitleView")staticfinalread onlyCHILD_VARIANT_MONTH_TITLE_VIEW:String = "datePicker_monthTitleView"

The variant used to style the current month title child component in a theme.

To override this default variant, set the DatePicker.customMonthTitleViewVariant property.

Available since

1.0.0

.

See also:

@:value("datePicker_mutedDateRenderer")staticfinalread onlyCHILD_VARIANT_MUTED_DATE_RENDERER:String = "datePicker_mutedDateRenderer"

The variant used to style the date picker's date renderers in a theme.

To override this default variant, set the DatePicker.customMutedDateRendererVariant property.

Available since

1.0.0

.

See also:

@:value("datePicker_weekdayLabel")staticfinalread onlyCHILD_VARIANT_WEEKDAY_LABEL:String = "datePicker_weekdayLabel"

The variant used to style the Label child components that display the names of weekdays.

To override this default variant, set the DatePicker.customWeekdayLabelVariant property.

Available since

1.0.0

.

See also:

Constructor

new()

Creates a new DatePicker object.

Available since

1.0.0

.

Variables

read onlyactualLocaleIDName:String

The locale ID name that is being used, which may be different from the requested locale ID name.

Available since

1.0.0

.

See also:

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind the date picker's content.

The following example passes a bitmap for the date picker to use as a background skin:

datePicker.backgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

@:style@:flash.propertycustomDateRendererVariant:String

A custom variant to set on all date renderers, instead of DatePicker.CHILD_VARIANT_DATE_RENDERER.

The customDateRendererVariant will be not be used if the result of dateRendererRecycler.create() already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomDecrementMonthButtonVariant:String

A custom variant to set on the decrement month button sub-component, instead of DatePicker.CHILD_VARIANT_DECREMENT_MONTH_BUTTON.

The customDecrementMonthButtonVariant will be not be used if the result of decrementMonthButtonFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomDecrementYearButtonVariant:String

A custom variant to set on the decrement year button sub-component, instead of DatePicker.CHILD_VARIANT_DECREMENT_YEAR_BUTTON.

The customDecrementYearButtonVariant will be not be used if the result of decrementYearButtonFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomIncrementMonthButtonVariant:String

A custom variant to set on the increment month button sub-component, instead of DatePicker.CHILD_VARIANT_INCREMENT_MONTH_BUTTON.

The customIncrementMonthButtonVariant will be not be used if the result of incrementMonthButtonFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomIncrementYearButtonVariant:String

A custom variant to set on the increment year button sub-component, instead of DatePicker.CHILD_VARIANT_INCREMENT_YEAR_BUTTON.

The customIncrementYearButtonVariant will be not be used if the result of incrementYearButtonFactory already has a variant set.

Available since

1.0.0

.

See also:

customMonthNames:Array<String>

A custom set of month names to use instead of the default.

Available since

1.0.0

.

@:style@:flash.propertycustomMonthTitleViewVariant:String

A custom variant to set on the month title view sub-component, instead of DatePicker.CHILD_VARIANT_MONTH_TITLE_VIEW.

The customMonthTitleViewVariant will be not be used if the result of monthTitleViewFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomMutedDateRendererVariant:String

A custom variant to set on all date renderers, instead of DatePicker.CHILD_VARIANT_MUTED_DATE_RENDERER.

The customMutedDateRendererVariant will be not be used if the result of dateRendererRecycler.create() already has a variant set.

Available since

1.0.0

.

See also:

customStartOfWeek:Null<Int>

The index of the day that starts each week. 0 is Sunday and 6 is Saturday. Set to null to use the default.

Available since

1.0.0

.

@:style@:flash.propertycustomWeekdayLabelVariant:String

An optional custom variant to use for the labels that display the names of weekdays, instead of DatePicker.CHILD_VARIANT_WEEKDAY_LABEL.

Available since

1.0.0

.

See also:

customWeekdayNames:Array<String>

A custom set of weekday names to use instead of the default.

Available since

1.0.0

.

dateRendererRecycler:AbstractDisplayObjectRecycler<Dynamic, DatePickerItemState, DisplayObject>

Manages date renderers used by the date picker.

In the following example, the date picker uses a custom date renderer class:

datePicker.dateRendererRecycler = DisplayObjectRecycler.withClass(CustomDateRenderer);
Available since

1.0.0

.

decrementMonthButtonFactory:AbstractDisplayObjectFactory<Dynamic, Button>

Creates the decrement month button that is displayed as a sub-component. The button must be of type feathers.controls.Button.

In the following example, a custom decrement month button factory is provided:

datePicker.decrementMonthButtonFactory = () ->
{
	return new Button();
};
Available since

1.0.0

.

See also:

decrementYearButtonFactory:AbstractDisplayObjectFactory<Dynamic, Button>

Creates the decrement year button that is displayed as a sub-component. The button must be of type feathers.controls.Button.

In the following example, a custom decrement year button factory is provided:

datePicker.decrementYearButtonFactory = () ->
{
	return new Button();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertydisabledBackgroundSkin:DisplayObject

A background skin to display behind the date picker's content when the date picker is disabled.

The following example gives the date picker a disabled background skin:

datePicker.disabledBackgroundSkin = new Bitmap(bitmapData);
datePicker.enabled = false;
Available since

1.0.0

.

See also:

@:bindable("scroll")displayedFullYear:Int

Along with the displayedMonth, sets the month that is currently visible in the calendar. Defaults to the current year.

Available since

1.0.0

.

See also:

@:bindable("scroll")displayedMonth:Int

Along with the displayedFullYear, sets the month that is currently visible in the calendar. Defaults to the current month.

Months are indexed starting from 0. So the index of January is 0, and the index of December is 11.

Available since

1.0.0

.

See also:

@:style@:flash.propertyheaderGap:Float

The space, in pixels, between items in the date picker's header.

In the following example, the date picker's header gap is set to 20 pixels:

datePicker.headerGap = 20.0;
Available since

1.0.0

.

incrementMonthButtonFactory:AbstractDisplayObjectFactory<Dynamic, Button>

Creates the increment month button that is displayed as a sub-component. The button must be of type feathers.controls.Button.

In the following example, a custom increment month button factory is provided:

datePicker.incrementMonthButtonFactory = () ->
{
	return new Button();
};
Available since

1.0.0

.

See also:

incrementYearButtonFactory:AbstractDisplayObjectFactory<Dynamic, Button>

Creates the increment year button that is displayed as a sub-component. The button must be of type feathers.controls.Button.

In the following example, a custom increment year button factory is provided:

datePicker.incrementYearButtonFactory = () ->
{
	return new Button();
};
Available since

1.0.0

.

See also:

monthTitleViewFactory:AbstractDisplayObjectFactory<Dynamic, Label>

Creates the current month view that is displayed as a sub-component. The view must be of type feathers.controls.Label.

In the following example, a custom current month view factory is provided:

datePicker.monthTitleViewFactory = () ->
{
	return new Label();
};
Available since

1.0.0

.

@:style@:flash.propertymonthTitleViewPosition:HorizontalAlign

The horizontal position of the month title view, relative to the increment and decrement buttons.

Note: The HorizontalAlign.JUSTIFY constant is not supported by this component.

Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingBottom:Float

The minimum space, in pixels, between the date picker's bottom edge and the date picker's content.

In the following example, the date picker's bottom padding is set to 20 pixels:

datePicker.paddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingLeft:Float

The minimum space, in pixels, between the date picker's left edge and the date picker's content.

In the following example, the date picker's left padding is set to 20 pixels:

datePicker.paddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingRight:Float

The minimum space, in pixels, between the date picker's right edge and the date picker's content.

In the following example, the date picker's right padding is set to 20 pixels:

datePicker.paddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingTop:Float

The minimum space, in pixels, between the date picker's top edge and the date picker's content.

In the following example, the date picker's top padding is set to 20 pixels:

datePicker.paddingTop = 20.0;
Available since

1.0.0

.

@:value(true)pointerSelectionEnabled:Bool = true

Indicates if selection is changed with MouseEvent.CLICK or TouchEvent.TOUCH_TAP when the item renderer does not implement the IToggle interface. If set to false, all item renderers must control their own selection manually (not only ones that implement IToggle).

The following example disables pointer selection:

datePicker.pointerSelectionEnabled = false;
Available since

1.0.0

.

requestedLocaleIDName:String

The locale ID name that is requested.

Available since

1.0.0

.

See also:

selectable:Bool

Available since

1.0.0

.

@:bindable("change")selectedDate:Date

The currently selected date.

Available since

1.0.0

.

@:style@:flash.propertyshowDatesFromAdjacentMonths:Bool

Determines if the date renderers for dates in the adjacent months are visible or not.

Available since

1.0.0

.

@:style@:flash.propertyshowMonthButtons:Bool

Determines if the buttons to decrement and increment the month buttons are displayed or hidden.

Available since

1.0.0

.

@:style@:flash.propertyshowMonthTitleView:Bool

Determines if the name of the month title view is displayed or hidden.

Available since

1.0.0

.

@:style@:flash.propertyshowWeekdayLabels:Bool

Determines if the weekday labels are visible or not.

Available since

1.0.0

.

@:style@:flash.propertyshowYearButtons:Bool

Determines if the buttons to decrement and increment the year buttons are displayed or hidden.

Available since

1.0.0

.

weekdayLabelFactory:AbstractDisplayObjectFactory<Dynamic, Label>

Creates the weekday labels that are displayed as sub-components. The labels must be of type feathers.controls.Label.

In the following example, a custom weekday label factory is provided:

datePicker.weekdayLabelFactory = () ->
{
	return new Label();
};
Available since

1.0.0

.

Methods

setPadding(value:Float):Void

Sets all four padding properties to the same value.

Available since

1.0.0

.

See also:

Inherited Variables

Defined by FeathersControl

@:bindable("creationComplete")read onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See also:

@:value(null)@:styledisabledAlpha:Null<Float> = null

When disabledAlpha is not null, sets the alpha property to this value when the the enabled property is set to false.

Available since

1.0.0

.

@stylefocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:bindable("layoutDataChange")includeInLayout:Bool

@:bindable("initialize")read onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@style@:bindable("layoutDataChange")layoutData:ILayoutData

read onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

styleProvider:IStyleProvider

Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.

When a component initializes, its style provider sets properties that affect the component's visual appearance. If the style provider dispatches StyleProviderEvent.STYLES_CHANGE after the component has initialized, the original properties set by the style provider will be reset to their default values and before applying the new property values.

Setting the style provider or replacing an existing style provider before a component initializes will queue up the style changes until after initialization. Once a component initializes, the style provider may be changed, but the changes will be applied immediately. Similarly to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE, any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

If the themeEnabled property is false, the current theme's style provider will be ignored. However, if a custom style provider was provided from outside of the theme, it will still be used.

Available since

1.0.0

.

See also:

variant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

Defined by ValidatingSprite

read onlyvalidating:Bool

Indicates if the display object is currently validating.

Available since

1.0.0

.

Inherited Methods

Defined by FeathersControl

private@:dox(show)initialize():Void

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, `FeathersEvent.INITIALIZE is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

See also:

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setFocusPadding(value:Float):Void

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

Defined by MeasureSprite

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithInvalidationFlagsOnly(callback:() ‑> Void):Void

Calls a function that temporarily limits setInvalid() calls to setting invalidation flags only, and the control will not be added to the validation queue. In other words, setInvalid() calls will work similarly to setInvalidationFlag() instead.

Typically, this method should be called only during validation. If called outside of update(), the component's validation may be delayed until a future call to setInvalid().

Available since

1.2.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.