Package | feathers.controls |
Class | public class DateTimeSpinner |
Inheritance | DateTimeSpinner ![]() ![]() ![]() ![]() ![]() ![]() |
Product Version : | Feathers 2.3.0 |
SpinnerList
components that allow you to select the
date, the time, or the date and time.
The following example sets the date spinner's range and listens for when the value changes:
var spinner:DateTimeSpinner = new DateTimeSpinner(); spinner.editingMode = DateTimeMode.DATE; spinner.minimum = new Date(1970, 0, 1); spinner.maximum = new Date(2050, 11, 31); spinner.value = new Date(); spinner.addEventListener( Event.CHANGE, spinner_changeHandler ); this.addChild( spinner );
See also
Property | Defined By | ||
---|---|---|---|
![]() | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
![]() | alpha : Number The opacity of the object. | DisplayObject | |
![]() | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
![]() | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
![]() | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
editingMode : String
Determines which parts of the Date value may be edited. | DateTimeSpinner | ||
![]() | effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
![]() | explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
![]() | explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
![]() | explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
![]() | explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
![]() | explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
![]() | explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
![]() | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
![]() | focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
![]() | focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
![]() | focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all DateTimeSpinner
components. | DateTimeSpinner | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
itemRendererFactory : Function
A function used to instantiate the date time spinner's item renderer
sub-components. | DateTimeSpinner | ||
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
listFactory : Function
A function used to instantiate the date time spinner's list
sub-components. | DateTimeSpinner | ||
locale : String
The locale used to display the date. | DateTimeSpinner | ||
![]() | maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
![]() | mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
![]() | maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
maximum : Date
The date time spinner's value will not go higher than the maximum. | DateTimeSpinner | ||
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
minimum : Date
The date time spinner's value will not go lower than the minimum. | DateTimeSpinner | ||
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
minuteStep : int
In the list that allows selection of minutes, customizes the number
of minutes between each item. | DateTimeSpinner | ||
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
![]() | name : String The name of the display object (default: null). | DisplayObject | |
![]() | nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
![]() | nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
![]() | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
![]() | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
![]() | requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
![]() | resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
![]() | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
![]() | rotation : Number The rotation of the object in radians. | DisplayObject | |
![]() | scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
![]() | scaleX : Number The horizontal scale factor. | DisplayObject | |
![]() | scaleY : Number The vertical scale factor. | DisplayObject | |
![]() | showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
![]() | skewX : Number The horizontal skew angle in radians. | DisplayObject | |
![]() | skewY : Number The vertical skew angle in radians. | DisplayObject | |
![]() | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
todayLabel : String
If not null, and the editingMode property
is set to DateTimeMode.DATE_AND_TIME the date matching
today's current date will display this label instead of the date. | DateTimeSpinner | ||
![]() | toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
![]() | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
![]() | touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
![]() | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
value : Date
The value of the date time spinner, between the minimum and maximum. | DateTimeSpinner | ||
![]() | visible : Boolean The visibility of the object. | DisplayObject | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
![]() | actualMinHeight : Number = 0
The final minimum height value that should be used for layout. | FeathersControl | |
![]() | actualMinWidth : Number = 0
The final minimum width value that should be used for layout. | FeathersControl | |
![]() | actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
styleProvider property is set to this value. | FeathersControl | |
listStyleName : String = feathers-date-time-spinner-list
The value added to the styleNameList of the lists. | DateTimeSpinner |
Method | Defined By | ||
---|---|---|---|
Constructor. | DateTimeSpinner | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
![]() | alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
![]() | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
![]() | broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
![]() | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
![]() | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
![]() | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
![]() | dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer | |
![]() | drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
![]() | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
![]() | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
![]() | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
![]() | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
![]() | getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
![]() | globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
![]() | hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
![]() | hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
![]() | hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
![]() | initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | Removes a child from the container. | DisplayObjectContainer | |
![]() | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
![]() | removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
![]() | removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
![]() | removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
![]() | [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
![]() | resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
![]() | resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
scrollToDate(date:Date, animationDuration:Number):void
After the next validation, animates the scroll positions of the lists
to a specific date. | DateTimeSpinner | ||
![]() | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
![]() | setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
![]() | suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
![]() | Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN
that may be overridden in subclasses to perform additional actions
when the component receives focus. | FeathersControl | |
![]() | focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | FeathersControl | |
![]() | ignoreNextStyleRestriction():void
The next style that is set will not be restricted. | FeathersControl | |
![]() | 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. | FeathersControl | |
![]() | processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to
determine if the setter has been called directly on the component or
from a style provider. | FeathersControl | |
refreshBackgroundSkin():void
Choose the appropriate background skin based on the control's current
state. | DateTimeSpinner | ||
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the
component. | FeathersControl | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when an object is added to a parent. | DisplayObject | ||
![]() | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
Dispatched when the spinner's value changes. | DateTimeSpinner | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
![]() | Dispatched when a key on the keyboard is released. | DisplayObject | ||
![]() | Dispatched when an object is removed from its parent. | DisplayObject | ||
![]() | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
![]() | Dispatched when an object is touched. | DisplayObject |
Style | Description | Defined By | ||
---|---|---|---|---|
backgroundDisabledSkin | Type: starling.display.DisplayObject The background to display behind all content when the date time spinner is disabled. The background skin is resized to fill the full width and height of the date time spinner, and the lists are centered. In the following example, the spinner is given a background skin:
spinner.backgroundDisabledSkin = new Image( texture );
The default value is null .See also | DateTimeSpinner | ||
backgroundSkin | Type: starling.display.DisplayObject The default background to display behind all content. The background skin is resized to fill the full width and height of the date time spinner, and the lists are centered. In the following example, the spinner is given a background skin:
spinner.backgroundSkin = new Image( texture );
The default value is null .See also | DateTimeSpinner | ||
customItemRendererStyleName | Type: String A style name to add to the date time spinner's item renderer sub-components. Typically used by a theme to provide different styles to different date time spinners. In the following example, a custom item renderer style name is passed to the date time spinner:
spinner.customItemRendererStyleName = "my-custom-date-time-spinner-item-renderer";
In your theme, you can target this sub-component style name to provide different styles than the default:
getStyleProviderForClass( DefaultListItemRenderer ).setFunctionForStyleName( "my-custom-date-time-spinner-item-renderer", setCustomDateTimeSpinnerItemRendererStyles );
The default value is null .See also | DateTimeSpinner | ||
customListStyleName | Type: String A style name to add to the date time spinner's list sub-components. Typically used by a theme to provide different styles to different date time spinners. In the following example, a custom list style name is passed to the date time spinner:
spinner.customListStyleName = "my-custom-spinner-list";
In your theme, you can target this sub-component style name to provide different styles than the default:
getStyleProviderForClass( SpinnerList ).setFunctionForStyleName( "my-custom-spinner-list", setCustomSpinnerListStyles );
The default value is null .See also | DateTimeSpinner | ||
![]() | Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.See also | FeathersControl | ||
![]() | Type: Number Quickly sets all focus padding properties to the same value. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also | FeathersControl | ||
padding | Type: Number Quickly sets all padding properties to the same value. The padding getter always returns the value of
paddingTop , but the other padding values may be
different.
In the following example, the padding is set to 20 pixels:
spinner.padding = 20;
The default value is 0 .See also | DateTimeSpinner | ||
paddingBottom | Type: Number The minimum space, in pixels, between the date time spinner's bottom edge and the its content. In the following example, the bottom padding is set to 20 pixels:
spinner.paddingBottom = 20;
The default value is 0 .See also | DateTimeSpinner | ||
paddingLeft | Type: Number The minimum space, in pixels, between the date time spinner's left edge and the its content. In the following example, the left padding is set to 20 pixels:
spinner.paddingLeft = 20;
The default value is 0 .See also | DateTimeSpinner | ||
paddingRight | Type: Number The minimum space, in pixels, between the date time spinner's right edge and the its content. In the following example, the right padding is set to 20 pixels:
spinner.paddingRight = 20;
The default value is 0 .See also | DateTimeSpinner | ||
paddingTop | Type: Number The minimum space, in pixels, between the date time spinner's top edge and the its content. In the following example, the top padding is set to 20 pixels:
spinner.paddingTop = 20;
The default value is 0 .See also | DateTimeSpinner | ||
scrollDuration | Type: Number The duration, in seconds, of the animation when the scrollToDate() function is called, or when an invalid
date is selected.
In the following example, the duration of the animation that changes the page when thrown is set to 250 milliseconds:
spinner.scrollDuration = 0.25;
The default value is 0.5 .See also | DateTimeSpinner |
Constant | Defined By | ||
---|---|---|---|
DEFAULT_CHILD_STYLE_NAME_LIST : String = feathers-date-time-spinner-list [static]
The default name to use with lists. | DateTimeSpinner | ||
![]() | INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
![]() | INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl |
editingMode | property |
editingMode:String
Determines which parts of the Date
value may be edited.
The default value is feathers.controls.DateTimeMode.DATE_AND_TIME
.
public function get editingMode():String
public function set editingMode(value:String):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all DateTimeSpinner
components.
The default value is null
.
See also
itemRendererFactory | property |
itemRendererFactory:Function
A function used to instantiate the date time spinner's item renderer
sub-components. A single factory will be shared by all
SpinnerList
sub-components displayed by the
DateTimeSpinner
. The item renderers must be instances of
DefaultListItemRenderer
. This factory can be used to
change properties of the item renderer sub-components when they are
first created. For instance, if you are skinning Feathers components
without a theme, you might use this factory to style the item
renderer sub-components.
The factory should have the following function signature:
function():DefaultListItemRenderer
In the following example, the date time spinner uses a custom item renderer factory:
spinner.itemRendererFactory = function():DefaultListItemRenderer { var itemRenderer:DefaultListItemRenderer = new DefaultListItemRenderer(); // set properties return itemRenderer; };
The default value is null
.
public function get itemRendererFactory():Function
public function set itemRendererFactory(value:Function):void
See also
listFactory | property |
listFactory:Function
A function used to instantiate the date time spinner's list
sub-components. The lists must be instances of
SpinnerList
. This factory can be used to change
properties of the list sub-components when they are first created.
For instance, if you are skinning Feathers components without a
theme, you might use this factory to style the list sub-components.
Warning: The itemRendererFactory
and customItemRendererStyleName
properties of the
SpinnerList
should not be set in the
listFactory
. Instead, set the
itemRendererFactory
and
customItemRendererStyleName
properties of the
DateTimeSpinner
.
The factory should have the following function signature:
function():SpinnerList
In the following example, the date time spinner uses a custom list factory:
spinner.listFactory = function():SpinnerList { var list:SpinnerList = new SpinnerList(); // set properties return list; };
The default value is null
.
public function get listFactory():Function
public function set listFactory(value:Function):void
See also
listStyleName | property |
protected var listStyleName:String = feathers-date-time-spinner-list
The value added to the styleNameList
of the lists. This
variable is protected
so that sub-classes can customize
the list style name in their constructors instead of using the
default style name defined by DEFAULT_CHILD_STYLE_NAME_LIST
.
To customize the list style name without subclassing, see
customListStyleName
.
See also
locale | property |
locale:String
The locale used to display the date. Supports values defined by
Unicode Technical Standard #35, such as "en_US"
,
"fr_FR"
or "ru_RU"
.
The default value is flash.globalization.LocaleID.DEFAULT
.
public function get locale():String
public function set locale(value:String):void
See also
maximum | property |
maximum:Date
The date time spinner's value will not go higher than the maximum.
In the following example, the maximum is changed:
spinner.maximum = new Date(2050, 11, 31);
public function get maximum():Date
public function set maximum(value:Date):void
See also
minimum | property |
minimum:Date
The date time spinner's value will not go lower than the minimum.
In the following example, the minimum is changed:
spinner.minimum = new Date(1970, 0, 1);
public function get minimum():Date
public function set minimum(value:Date):void
See also
minuteStep | property |
minuteStep:int
In the list that allows selection of minutes, customizes the number of minutes between each item. For instance, one might choose 15 or 30 minute increments.
In the following example, the spinner uses 15 minute increments:
spinner.minuteStep = 15;
The default value is 1
.
public function get minuteStep():int
public function set minuteStep(value:int):void
todayLabel | property |
todayLabel:String
If not null
, and the editingMode
property
is set to DateTimeMode.DATE_AND_TIME
the date matching
today's current date will display this label instead of the date.
In the following example, the label for today is set:
spinner.todayLabel = "Today";
The default value is null
.
public function get todayLabel():String
public function set todayLabel(value:String):void
value | property |
value:Date
The value of the date time spinner, between the minimum and maximum.
In the following example, the value is changed to a date:
stepper.minimum = new Date(1970, 0, 1); stepper.maximum = new Date(2050, 11, 31); stepper.value = new Date(1995, 2, 7);
The default value is 0
.
public function get value():Date
public function set value(value:Date):void
See also
DateTimeSpinner | () | Constructor |
public function DateTimeSpinner()
Constructor.
refreshBackgroundSkin | () | method |
protected function refreshBackgroundSkin():void
Choose the appropriate background skin based on the control's current state.
scrollToDate | () | method |
public function scrollToDate(date:Date, animationDuration:Number):void
After the next validation, animates the scroll positions of the lists
to a specific date. If the animationDuration
argument is
NaN
(the default value), the value of the
scrollDuration
property is used instead. The duration is
measured in seconds.
Note: The value
property will not be updated
immediately when calling scrollToDate()
. Similar to how
the animation won't start until the next validation, the
value
property will be updated at the same time.
In the following example, we scroll to a specific date with animation of 1.5 seconds:
spinner.scrollToDate( new Date(2016, 0, 1), 1.5 );
Parameters
date:Date | |
animationDuration:Number (default = NaN )
|
See also
change | Event |
starling.events.Event
starling.events.Event.CHANGE
Dispatched when the spinner's value changes.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
DEFAULT_CHILD_STYLE_NAME_LIST | Constant |
public static const DEFAULT_CHILD_STYLE_NAME_LIST:String = feathers-date-time-spinner-list
The default name to use with lists.
See also