Package | feathers.media |
Class | public class TimeLabel |
Inheritance | TimeLabel ![]() ![]() ![]() |
Implements | IMediaPlayerControl |
See also
Property | Defined By | ||
---|---|---|---|
![]() | backgroundDisabledSkin : DisplayObject
A background to display when the label is disabled. | Label | |
![]() | backgroundSkin : DisplayObject
The default background to display behind the label's text. | Label | |
![]() | baseline : Number [read-only]
The baseline measurement of the text, in pixels. | Label | |
![]() | 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 | |
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 | ||
![]() | depth : 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 | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : 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 | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | 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 | 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 | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : 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 | ||
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | 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 | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | padding : Number
Quickly sets all padding properties to the same value. | Label | |
![]() | paddingBottom : Number
The minimum space, in pixels, between the label's bottom edge and
the label's text. | Label | |
![]() | paddingLeft : Number
The minimum space, in pixels, between the label's left edge and the
label's text. | Label | |
![]() | paddingRight : Number
The minimum space, in pixels, between the label's right edge and
the label's text. | Label | |
![]() | paddingTop : Number
The minimum space, in pixels, between the label's top edge and the
label's text. | Label | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | 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 | |
![]() | text : String
The text displayed by the label. | Label | |
![]() | textRendererFactory : Function
A function used to instantiate the label's text renderer
sub-component. | Label | |
![]() | textRendererProperties : 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 | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | wordWrap : Boolean
Determines if the text wraps to the next line when it reaches the
width (or max width) of the component. | Label |
Method | Defined By | ||
---|---|---|---|
Constructor. | TimeLabel | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | 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 | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Constant | Defined By | ||
---|---|---|---|
![]() | ALTERNATE_NAME_DETAIL : String = feathers-detail-label [static]
DEPRECATED: Replaced by Label.ALTERNATE_STYLE_NAME_DETAIL. | Label | |
![]() | ALTERNATE_NAME_HEADING : String = feathers-heading-label [static]
DEPRECATED: Replaced by Label.ALTERNATE_STYLE_NAME_HEADING. | Label | |
![]() | ALTERNATE_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 | |
![]() | ALTERNATE_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 | ||
![]() | 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 |
delimiter | property |
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 " / "
.
public function get delimiter():String
public function set delimiter(value:String):void
See also
displayMode | property |
displayMode:String
Determines how the time is displayed by the label.
The default value is TimeLabel.DISPLAY_MODE_CURRENT_AND_TOTAL_TIMES
.
public function get displayMode():String
public function set displayMode(value:String):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all
TimeLabel
components.
The default value is null
.
See also
mediaPlayer | property |
mediaPlayer:IMediaPlayer
The media player that this component controls.
public function get mediaPlayer():IMediaPlayer
public function set mediaPlayer(value:IMediaPlayer):void
toggleDisplayMode | property |
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
.
public function get toggleDisplayMode():Boolean
public function set toggleDisplayMode(value:Boolean):void
See also
TimeLabel | () | Constructor |
public function TimeLabel()
Constructor.
DISPLAY_MODE_CURRENT_AND_TOTAL_TIMES | Constant |
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_TIME | Constant |
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_TIME | Constant |
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_TIME | Constant |
public static const DISPLAY_MODE_TOTAL_TIME:String = totalTime
The label displays only the total time of the media content.
See also