Package | feathers.media |
Class | public class PlayPauseToggleButton |
Inheritance | PlayPauseToggleButton ToggleButton Button BasicButton FeathersControl starling.display.Sprite |
Implements | IMediaPlayerControl |
Product Version : | Feathers 2.2.0 |
See also
Property | Defined By | ||
---|---|---|---|
addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | ||
baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | Button | ||
currentState : String [read-only]
The current state of the button. | BasicButton | ||
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 | ||
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 | ||
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 | ||
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
PlayPauseToggleButton components. | PlayPauseToggleButton | ||
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 | ||
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 | ||
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 | ||
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 | ||
isToggle : Boolean
Determines if the button may be selected or deselected as a result of
user interaction. | ToggleButton | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | ||
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 | ||
numLines : int [read-only]
The number of text lines displayed by the button. | Button | ||
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 | ||
resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | ||
showEffect : Function
An optional effect that is activated when the component is shown. | 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 | ||
toggleGroup : ToggleGroup
When the toggle is added to a ToggleGroup, the group
will manage the entire group's selection when one of the toggles in
the group changes. | ToggleButton | ||
toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | ||
touchableWhenPlaying : Boolean
Determines if the button may be touched when the media player is
playing its content. | PlayPauseToggleButton | ||
width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | PlayPauseToggleButton | ||
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 | ||
getFontStylesForState(state:String):TextFormat
Gets the font styles to be used to display the button's text when the
button's currentState property matches the specified
state value. | Button | ||
getIconForState(state:String):DisplayObject
Gets the icon to be used by the button when the button's
currentState property matches the specified state value. | Button | ||
getScaleForState(state:String):Number
Gets the scale to be used by the button when the button's
currentState property matches the specified state value. | Button | ||
getSkinForState(state:String):DisplayObject
Gets the skin to be used by the button when its
currentState property matches the specified state value. | BasicButton | ||
hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | ||
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 | ||
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | ||
removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | ||
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 | ||
setFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the button's text when the
button's currentState property matches the specified
state value. | Button | ||
setIconForState(state:String, icon:DisplayObject):void
Sets the icon to be used by the button when the button's
currentState property matches the specified state value. | Button | ||
setScaleForState(state:String, scale:Number):void
Sets the scale to be used by the button when the button's
currentState property matches the specified state value. | Button | ||
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | ||
setSkinForState(state:String, skin:DisplayObject):void
Sets the skin to be used by the button when its
currentState property matches the specified state value. | BasicButton | ||
showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | ||
suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | ||
validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Constant | Defined By | ||
---|---|---|---|
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_STYLE_NAME_LABEL : String = "feathers-button-label" [static]
The default value added to the styleNameList of the
label text renderer. | 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 |
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