Packagefeathers.media
Classpublic class TimeLabel
InheritanceTimeLabel Inheritance Label Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IMediaPlayerControl

A specialized label that can display the current playhead time, total time, remaining time, or a combined current and total time for a media player.

See also

How to use the Feathers SoundPlayer component
How to use the Feathers VideoPlayer component


Public Properties
 PropertyDefined By
 InheritedbackgroundDisabledSkin : DisplayObject
A background to display when the label is disabled.
Label
 InheritedbackgroundSkin : DisplayObject
The default background to display behind the label's text.
Label
 Inheritedbaseline : Number
[read-only] The baseline measurement of the text, in pixels.
Label
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
  delimiter : String
When the value of displayMode is TimeLabel.DISPLAY_MODE_CURRENT_AND_TOTAL_TIMES, this text is inserted between the two times to separate them.
TimeLabel
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
  displayMode : String
Determines how the time is displayed by the label.
TimeLabel
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all TimeLabel components.
TimeLabel
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
  mediaPlayer : IMediaPlayer
The media player that this component controls.
TimeLabel
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
FeathersControl
 Inheritedpadding : Number
Quickly sets all padding properties to the same value.
Label
 InheritedpaddingBottom : Number
The minimum space, in pixels, between the label's bottom edge and the label's text.
Label
 InheritedpaddingLeft : Number
The minimum space, in pixels, between the label's left edge and the label's text.
Label
 InheritedpaddingRight : Number
The minimum space, in pixels, between the label's right edge and the label's text.
Label
 InheritedpaddingTop : Number
The minimum space, in pixels, between the label's top edge and the label's text.
Label
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 Inheritedtext : String
The text displayed by the label.
Label
 InheritedtextRendererFactory : Function
A function used to instantiate the label's text renderer sub-component.
Label
 InheritedtextRendererProperties : Object
An object that stores properties for the label's text renderer sub-component, and the properties will be passed down to the text renderer when the label validates.
Label
  toggleDisplayMode : Boolean
If the displayMode property is set to TimeLabel.DISPLAY_MODE_CURRENT_TIME or TimeLabel.DISPLAY_MODE_REMAINING_TIME, and this property is set to true, the label will switch to displaying the current time and the remaining time, if tapped or clicked.
TimeLabel
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
 InheritedwordWrap : Boolean
Determines if the text wraps to the next line when it reaches the width (or max width) of the component.
Label
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
 InheritedtextRenderer : ITextRenderer
The text renderer.
Label
Public Methods
 MethodDefined By
  
Constructor.
TimeLabel
 Inherited
hideFocus():void
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
Label
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
Creates and adds the textRenderer sub-component and removes the old instance, if one exists.
Label
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
Positions and sizes children based on the actual width and height values.
Label
 Inherited
Choose the appropriate background skin based on the control's current state.
Label
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
Public Constants
 ConstantDefined By
 InheritedALTERNATE_NAME_DETAIL : String = feathers-detail-label
[static] DEPRECATED: Replaced by Label.ALTERNATE_STYLE_NAME_DETAIL.
Label
 InheritedALTERNATE_NAME_HEADING : String = feathers-heading-label
[static] DEPRECATED: Replaced by Label.ALTERNATE_STYLE_NAME_HEADING.
Label
 InheritedALTERNATE_STYLE_NAME_DETAIL : String = feathers-detail-label
[static] An alternate style name to use with Label to allow a theme to give it a smaller style meant for less-important details.
Label
 InheritedALTERNATE_STYLE_NAME_HEADING : String = feathers-heading-label
[static] An alternate style name to use with Label to allow a theme to give it a larger style meant for headings.
Label
  DISPLAY_MODE_CURRENT_AND_TOTAL_TIMES : String = currentAndTotalTimes
[static] The label displays the current time of the media content, followed by some text specified by the delimiter property, and completed by the total time of the media content.
TimeLabel
  DISPLAY_MODE_CURRENT_TIME : String = currentTime
[static] The label displays only the current time of the media content.
TimeLabel
  DISPLAY_MODE_REMAINING_TIME : String = remainingTime
[static] The label displays only the remaining time of the media content.
TimeLabel
  DISPLAY_MODE_TOTAL_TIME : String = totalTime
[static] The label displays only the total time of the media content.
TimeLabel
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = focus
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = styles
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
delimiterproperty
delimiter:String

When the value of displayMode is TimeLabel.DISPLAY_MODE_CURRENT_AND_TOTAL_TIMES, this text is inserted between the two times to separate them.

The default value is " / ".


Implementation
    public function get delimiter():String
    public function set delimiter(value:String):void

See also

displayModeproperty 
displayMode:String

Determines how the time is displayed by the label.

The default value is TimeLabel.DISPLAY_MODE_CURRENT_AND_TOTAL_TIMES.


Implementation
    public function get displayMode():String
    public function set displayMode(value:String):void

See also

globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all TimeLabel components.

The default value is null.

See also

mediaPlayerproperty 
mediaPlayer:IMediaPlayer

The media player that this component controls.


Implementation
    public function get mediaPlayer():IMediaPlayer
    public function set mediaPlayer(value:IMediaPlayer):void
toggleDisplayModeproperty 
toggleDisplayMode:Boolean

If the displayMode property is set to TimeLabel.DISPLAY_MODE_CURRENT_TIME or TimeLabel.DISPLAY_MODE_REMAINING_TIME, and this property is set to true, the label will switch to displaying the current time and the remaining time, if tapped or clicked. If the displayMode property is not set to one of the specified values, this property is ignored.

The default value is false.


Implementation
    public function get toggleDisplayMode():Boolean
    public function set toggleDisplayMode(value:Boolean):void

See also

Constructor Detail
TimeLabel()Constructor
public function TimeLabel()

Constructor.

Constant Detail
DISPLAY_MODE_CURRENT_AND_TOTAL_TIMESConstant
public static const DISPLAY_MODE_CURRENT_AND_TOTAL_TIMES:String = currentAndTotalTimes

The label displays the current time of the media content, followed by some text specified by the delimiter property, and completed by the total time of the media content.

See also

DISPLAY_MODE_CURRENT_TIMEConstant 
public static const DISPLAY_MODE_CURRENT_TIME:String = currentTime

The label displays only the current time of the media content.

See also

DISPLAY_MODE_REMAINING_TIMEConstant 
public static const DISPLAY_MODE_REMAINING_TIME:String = remainingTime

The label displays only the remaining time of the media content. In other words, the total time minus the current time.

See also

DISPLAY_MODE_TOTAL_TIMEConstant 
public static const DISPLAY_MODE_TOTAL_TIME:String = totalTime

The label displays only the total time of the media content.

See also