Package | feathers.media |
Class | public class PlayPauseToggleButton |
Inheritance | PlayPauseToggleButton ![]() ![]() ![]() ![]() |
Implements | IMediaPlayerControl |
See also
Property | Defined By | ||
---|---|---|---|
![]() | defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state. | Button | |
![]() | defaultLabelProperties : Object
An object that stores properties for the button's label text renderer
when no specific properties are defined for the button's current
state, and the properties will be passed down to the label text
renderer when the button validates. | Button | |
![]() | defaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state
when the button is selected. | ToggleButton | |
![]() | defaultSelectedLabelProperties : Object
An object that stores properties for the button's label text renderer
when no specific properties are defined for the button's current
state (and the button's isSelected property is
true), and the properties will be passed down to the
label text renderer when the button validates. | ToggleButton | |
![]() | defaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state
when the button is selected. | ToggleButton | |
![]() | defaultSkin : DisplayObject
The skin used when no other skin is defined for the current state. | Button | |
![]() | 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 | |
![]() | disabledIcon : DisplayObject
The icon used for the button's disabled state. | Button | |
![]() | disabledLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DISABLED state,
and the properties will be passed down to the label text renderer
when the button validates. | Button | |
![]() | disabledSkin : DisplayObject
The skin used for the button's disabled state. | Button | |
![]() | downIcon : DisplayObject
The icon used for the button's down state. | Button | |
![]() | downLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DOWN state, and
the properties will be passed down to the label text renderer when
the button validates. | Button | |
![]() | downSkin : DisplayObject
The skin used for the button's down state. | Button | |
![]() | 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 | |
![]() | gap : Number
The space, in pixels, between the icon and the label. | Button | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all
PlayPauseToggleButton components. | PlayPauseToggleButton | ||
![]() | hasLabelTextRenderer : Boolean
Determines if the button's label text renderer is created or not. | Button | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | horizontalAlign : String
The location where the button's content is aligned horizontally (on
the x-axis). | Button | |
![]() | hoverIcon : DisplayObject
The icon used for the button's hover state. | Button | |
![]() | hoverLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_HOVER state, and
the properties will be passed down to the label text renderer when
the button validates. | Button | |
![]() | hoverSkin : DisplayObject
The skin used for the button's hover state. | Button | |
![]() | iconOffsetX : Number
Offsets the x position of the icon by a certain number of pixels. | Button | |
![]() | iconOffsetY : Number
Offsets the y position of the icon by a certain number of pixels. | Button | |
![]() | iconPosition : String
The location of the icon, relative to the label. | Button | |
![]() | 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 | |
![]() | isLongPressEnabled : Boolean
Determines if FeathersEventType.LONG_PRESS will be
dispatched. | Button | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isSelected : Boolean
Indicates if the button is selected or not. | ToggleButton | |
![]() | isToggle : Boolean
Determines if the button may be selected or deselected as a result of
user interaction. | ToggleButton | |
![]() | keepDownStateOnRollOut : Boolean = false
Determines if a pressed button should remain in the down state if a
touch moves outside of the button's bounds. | Button | |
![]() | label : String
The text displayed on the button. | Button | |
![]() | labelFactory : Function
A function used to instantiate the button's label text renderer
sub-component. | Button | |
![]() | labelOffsetX : Number
Offsets the x position of the label by a certain number of pixels. | Button | |
![]() | labelOffsetY : Number
Offsets the y position of the label by a certain number of pixels. | Button | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | longPressDuration : Number
The duration, in seconds, of a long press. | Button | |
![]() | 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. | PlayPauseToggleButton | ||
![]() | minGap : Number
If the value of the gap property is
Number.POSITIVE_INFINITY, meaning that the gap will
fill as much space as possible, the final calculated value will not be
smaller than the value of the minGap property. | Button | |
![]() | 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. | Button | |
![]() | paddingBottom : Number
The minimum space, in pixels, between the button's bottom edge and
the button's content. | Button | |
![]() | paddingLeft : Number
The minimum space, in pixels, between the button's left edge and the
button's content. | Button | |
![]() | paddingRight : Number
The minimum space, in pixels, between the button's right edge and the
button's content. | Button | |
![]() | paddingTop : Number
The minimum space, in pixels, between the button's top edge and the
button's content. | Button | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | scaleWhenDown : Number
The button renders at this scale in the down state. | Button | |
![]() | scaleWhenHovering : Number
The button renders at this scale in the hover state. | Button | |
![]() | selectedDisabledIcon : DisplayObject
The icon used for the button's disabled state when the button is
selected. | ToggleButton | |
![]() | selectedDisabledLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DISABLED state
(and the button's isSelected property is
true), and the properties will be passed down to the
label text renderer when the button validates. | ToggleButton | |
![]() | selectedDisabledSkin : DisplayObject
The skin used for the button's disabled state when the button is
selected. | ToggleButton | |
![]() | selectedDownIcon : DisplayObject
The icon used for the button's down state when the button is
selected. | ToggleButton | |
![]() | selectedDownLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DOWN state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | |
![]() | selectedDownSkin : DisplayObject
The skin used for the button's down state when the button is
selected. | ToggleButton | |
![]() | selectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is
selected. | ToggleButton | |
![]() | selectedHoverLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_HOVER state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | |
![]() | selectedHoverSkin : DisplayObject
The skin used for the button's hover state when the button is
selected. | ToggleButton | |
![]() | selectedUpIcon : DisplayObject
The icon used for the button's up state when the button is
selected. | ToggleButton | |
![]() | selectedUpLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_UP state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | |
![]() | selectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected. | ToggleButton | |
![]() | stateToIconFunction : Function
Returns an icon for the current state. | Button | |
![]() | stateToLabelPropertiesFunction : Function
Returns a text format for the current state. | Button | |
![]() | stateToSkinFunction : Function
Returns a skin for the current state. | Button | |
![]() | 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 | |
touchableWhenPlaying : Boolean
Determines if the button may be touched when the media player is
playing its content. | PlayPauseToggleButton | ||
![]() | upIcon : DisplayObject
The icon used for the button's up state. | Button | |
![]() | upLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_UP state, and the
properties will be passed down to the label text renderer when the
button validates. | Button | |
![]() | upSkin : DisplayObject
The skin used for the button's up state. | Button | |
![]() | verticalAlign : String
The location where the button's content is aligned vertically (on
the y-axis). | Button | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | PlayPauseToggleButton | ||
![]() | 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_BACK_BUTTON : String = feathers-back-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_BACK_BUTTON. | Button | |
![]() | ALTERNATE_NAME_CALL_TO_ACTION_BUTTON : String = feathers-call-to-action-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON. | Button | |
![]() | ALTERNATE_NAME_DANGER_BUTTON : String = feathers-danger-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_DANGER_BUTTON. | Button | |
![]() | ALTERNATE_NAME_FORWARD_BUTTON : String = feathers-forward-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_FORWARD_BUTTON. | Button | |
![]() | ALTERNATE_NAME_QUIET_BUTTON : String = feathers-quiet-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_QUIET_BUTTON. | Button | |
![]() | ALTERNATE_STYLE_NAME_BACK_BUTTON : String = feathers-back-button [static]
An alternate style name to use with Button to allow a
theme to give it a "back button" style, perhaps with an arrow
pointing backward. | Button | |
![]() | ALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON : String = feathers-call-to-action-button [static]
An alternate style name to use with Button to allow a
theme to give it a more prominent, "call-to-action" style. | Button | |
![]() | ALTERNATE_STYLE_NAME_DANGER_BUTTON : String = feathers-danger-button [static]
An alternate style name to use with Button to allow a
theme to give it a highly prominent, "danger" style. | Button | |
![]() | ALTERNATE_STYLE_NAME_FORWARD_BUTTON : String = feathers-forward-button [static]
An alternate style name to use with Button to allow a
theme to give it a "forward" button style, perhaps with an arrow
pointing forward. | Button | |
ALTERNATE_STYLE_NAME_OVERLAY_PLAY_PAUSE_TOGGLE_BUTTON : String = feathers-overlay-play-pause-toggle-button [static]
An alternate style name to use with
PlayPauseToggleButton to allow a theme to give it an
appearance of an overlay above video. | PlayPauseToggleButton | ||
![]() | ALTERNATE_STYLE_NAME_QUIET_BUTTON : String = feathers-quiet-button [static]
An alternate style name to use with Button to allow a
theme to give it a less prominent, "quiet" style. | Button | |
![]() | DEFAULT_CHILD_NAME_LABEL : String = feathers-button-label [static]
DEPRECATED: Replaced by Button.DEFAULT_CHILD_STYLE_NAME_LABEL. | Button | |
![]() | DEFAULT_CHILD_STYLE_NAME_LABEL : String = feathers-button-label [static]
The default value added to the styleNameList of the label. | Button | |
![]() | HORIZONTAL_ALIGN_CENTER : String = center [static]
The icon and label will be aligned horizontally to the center of the button. | Button | |
![]() | HORIZONTAL_ALIGN_LEFT : String = left [static]
The icon and label will be aligned horizontally to the left edge of the button. | Button | |
![]() | HORIZONTAL_ALIGN_RIGHT : String = right [static]
The icon and label will be aligned horizontally to the right edge of the button. | Button | |
![]() | ICON_POSITION_BOTTOM : String = bottom [static]
The icon will be positioned below the label. | Button | |
![]() | ICON_POSITION_LEFT : String = left [static]
The icon will be positioned to the left of the label. | Button | |
![]() | ICON_POSITION_LEFT_BASELINE : String = leftBaseline [static]
The icon will be positioned to the left the label, and the bottom of
the icon will be aligned to the baseline of the label text. | Button | |
![]() | ICON_POSITION_MANUAL : String = manual [static]
The icon will be positioned manually with no relation to the position
of the label. | Button | |
![]() | ICON_POSITION_RIGHT : String = right [static]
The icon will be positioned to the right of the label. | Button | |
![]() | ICON_POSITION_RIGHT_BASELINE : String = rightBaseline [static]
The icon will be positioned to the right the label, and the bottom of
the icon will be aligned to the baseline of the label text. | Button | |
![]() | ICON_POSITION_TOP : String = top [static]
The icon will be positioned above the label. | Button | |
![]() | 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 | |
![]() | STATE_DISABLED : String = disabled [static]
Identifier for the button's disabled state. | Button | |
![]() | STATE_DOWN : String = down [static]
Identifier for the button's down state. | Button | |
![]() | STATE_HOVER : String = hover [static]
Identifier for the button's hover state. | Button | |
![]() | STATE_UP : String = up [static]
Identifier for the button's up state. | Button | |
![]() | VERTICAL_ALIGN_BOTTOM : String = bottom [static]
The icon and label will be aligned vertically to the bottom edge of the button. | Button | |
![]() | VERTICAL_ALIGN_MIDDLE : String = middle [static]
The icon and label will be aligned vertically to the middle of the button. | Button | |
![]() | VERTICAL_ALIGN_TOP : String = top [static]
The icon and label will be aligned vertically to the top edge of the button. | Button |
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all
PlayPauseToggleButton
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
touchableWhenPlaying | property |
touchableWhenPlaying:Boolean
Determines if the button may be touched when the media player is playing its content. In other words, this button will only work when the content is paused.
The default value is true
.
public function get touchableWhenPlaying():Boolean
public function set touchableWhenPlaying(value:Boolean):void
PlayPauseToggleButton | () | Constructor |
public function PlayPauseToggleButton()
Constructor.
ALTERNATE_STYLE_NAME_OVERLAY_PLAY_PAUSE_TOGGLE_BUTTON | Constant |
public static const ALTERNATE_STYLE_NAME_OVERLAY_PLAY_PAUSE_TOGGLE_BUTTON:String = feathers-overlay-play-pause-toggle-button
An alternate style name to use with
PlayPauseToggleButton
to allow a theme to give it an
appearance of an overlay above video. If a theme does not provide a
style for an overlay play/pause button, the theme will automatically
fall back to using the default play/pause button style.
An alternate style name should always be added to a component's
styleNameList
before the component is initialized. If
the style name is added later, it will be ignored.
In the following example, the overlay play/pause style is applied to a button:
var overlayButton:PlayPauseButton = new PlayPauseButton(); overlayButton.styleNameList.add( PlayPauseButton.ALTERNATE_STYLE_NAME_OVERLAY_PLAY_PAUSE_TOGGLE_BUTTON ); player.addChild( overlayButton );
See also