Packagefeathers.media
Classpublic class FullScreenToggleButton
InheritanceFullScreenToggleButton Inheritance ToggleButton Inheritance Button Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IMediaPlayerControl

A specialized toggle button that controls whether a media player is displayed normally or in full-screen mode.

See also

How to use the Feathers VideoPlayer component


Public Properties
 PropertyDefined By
 InheriteddefaultIcon : DisplayObject
The icon used when no other icon is defined for the current state.
Button
 InheriteddefaultLabelProperties : 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
 InheriteddefaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state when the button is selected.
ToggleButton
 InheriteddefaultSelectedLabelProperties : 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
 InheriteddefaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state when the button is selected.
ToggleButton
 InheriteddefaultSkin : DisplayObject
The skin used when no other skin is defined for the current state.
Button
 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
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheriteddisabledIcon : DisplayObject
The icon used for the button's disabled state.
Button
 InheriteddisabledLabelProperties : 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
 InheriteddisabledSkin : DisplayObject
The skin used for the button's disabled state.
Button
 InheriteddownIcon : DisplayObject
The icon used for the button's down state.
Button
 InheriteddownLabelProperties : 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
 InheriteddownSkin : DisplayObject
The skin used for the button's down state.
Button
 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
 Inheritedgap : Number
The space, in pixels, between the icon and the label.
Button
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all FullScreenToggleButton components.
FullScreenToggleButton
 InheritedhasLabelTextRenderer : Boolean
Determines if the button's label text renderer is created or not.
Button
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedhorizontalAlign : String
The location where the button's content is aligned horizontally (on the x-axis).
Button
 InheritedhoverIcon : DisplayObject
The icon used for the button's hover state.
Button
 InheritedhoverLabelProperties : 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
 InheritedhoverSkin : DisplayObject
The skin used for the button's hover state.
Button
 InheritediconOffsetX : Number
Offsets the x position of the icon by a certain number of pixels.
Button
 InheritediconOffsetY : Number
Offsets the y position of the icon by a certain number of pixels.
Button
 InheritediconPosition : String
The location of the icon, relative to the label.
Button
 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
 InheritedisLongPressEnabled : Boolean
Determines if FeathersEventType.LONG_PRESS will be dispatched.
Button
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisSelected : Boolean
Indicates if the button is selected or not.
ToggleButton
 InheritedisToggle : Boolean
Determines if the button may be selected or deselected as a result of user interaction.
ToggleButton
 InheritedkeepDownStateOnRollOut : Boolean = false
Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.
Button
 Inheritedlabel : String
The text displayed on the button.
Button
 InheritedlabelFactory : Function
A function used to instantiate the button's label text renderer sub-component.
Button
 InheritedlabelOffsetX : Number
Offsets the x position of the label by a certain number of pixels.
Button
 InheritedlabelOffsetY : Number
Offsets the y position of the label by a certain number of pixels.
Button
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedlongPressDuration : Number
The duration, in seconds, of a long press.
Button
 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.
FullScreenToggleButton
 InheritedminGap : 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
 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.
Button
 InheritedpaddingBottom : Number
The minimum space, in pixels, between the button's bottom edge and the button's content.
Button
 InheritedpaddingLeft : Number
The minimum space, in pixels, between the button's left edge and the button's content.
Button
 InheritedpaddingRight : Number
The minimum space, in pixels, between the button's right edge and the button's content.
Button
 InheritedpaddingTop : Number
The minimum space, in pixels, between the button's top edge and the button's content.
Button
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
 InheritedscaleWhenDown : Number
The button renders at this scale in the down state.
Button
 InheritedscaleWhenHovering : Number
The button renders at this scale in the hover state.
Button
 InheritedselectedDisabledIcon : DisplayObject
The icon used for the button's disabled state when the button is selected.
ToggleButton
 InheritedselectedDisabledLabelProperties : 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
 InheritedselectedDisabledSkin : DisplayObject
The skin used for the button's disabled state when the button is selected.
ToggleButton
 InheritedselectedDownIcon : DisplayObject
The icon used for the button's down state when the button is selected.
ToggleButton
 InheritedselectedDownLabelProperties : 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
 InheritedselectedDownSkin : DisplayObject
The skin used for the button's down state when the button is selected.
ToggleButton
 InheritedselectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is selected.
ToggleButton
 InheritedselectedHoverLabelProperties : 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
 InheritedselectedHoverSkin : DisplayObject
The skin used for the button's hover state when the button is selected.
ToggleButton
 InheritedselectedUpIcon : DisplayObject
The icon used for the button's up state when the button is selected.
ToggleButton
 InheritedselectedUpLabelProperties : 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
 InheritedselectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected.
ToggleButton
 InheritedstateToIconFunction : Function
Returns an icon for the current state.
Button
 InheritedstateToLabelPropertiesFunction : Function
Returns a text format for the current state.
Button
 InheritedstateToSkinFunction : Function
Returns a skin for the current state.
Button
 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
 InheritedupIcon : DisplayObject
The icon used for the button's up state.
Button
 InheritedupLabelProperties : 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
 InheritedupSkin : DisplayObject
The skin used for the button's up state.
Button
 InheritedverticalAlign : String
The location where the button's content is aligned vertically (on the y-axis).
Button
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
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
 InheritedcurrentIcon : DisplayObject
The currently visible icon.
Button
 InheritedcurrentSkin : DisplayObject
The currently visible skin.
Button
 InheritedcurrentState : String
The current touch state of the button.
Button
 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
 InheritedlabelName : String
DEPRECATED: Replaced by labelStyleName.
Button
 InheritedlabelStyleName : String = feathers-button-label
The value added to the styleNameList of the label text renderer.
Button
 InheritedlabelTextRenderer : ITextRenderer
The text renderer for the button's label.
Button
 InheritedstateNames : Vector.<String>
[read-only] A list of all valid touch state names for use with currentState.
Button
 InheritedtouchPointID : int = -1
The saved ID of the currently active touch.
Button
Public Methods
 MethodDefined By
  
Constructor.
FullScreenToggleButton
 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.
Button
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
Creates the label text renderer sub-component and removes the old instance, if one exists.
Button
 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 the button's content.
Button
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
Sets the currentIcon property.
Button
 Inherited
Sets the currentSkin property.
Button
 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
 Inherited
trigger():void
Triggers the button.
Button
Events
 Event Summary Defined By
 InheritedDispatched when the button is selected or deselected either programmatically or as a result of user interaction.ToggleButton
 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 button is pressed for a long time.Button
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the the user taps or clicks the button.Button
Public Constants
 ConstantDefined By
 InheritedALTERNATE_NAME_BACK_BUTTON : String = feathers-back-button
[static] DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_BACK_BUTTON.
Button
 InheritedALTERNATE_NAME_CALL_TO_ACTION_BUTTON : String = feathers-call-to-action-button
[static] DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON.
Button
 InheritedALTERNATE_NAME_DANGER_BUTTON : String = feathers-danger-button
[static] DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_DANGER_BUTTON.
Button
 InheritedALTERNATE_NAME_FORWARD_BUTTON : String = feathers-forward-button
[static] DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_FORWARD_BUTTON.
Button
 InheritedALTERNATE_NAME_QUIET_BUTTON : String = feathers-quiet-button
[static] DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_QUIET_BUTTON.
Button
 InheritedALTERNATE_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
 InheritedALTERNATE_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
 InheritedALTERNATE_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
 InheritedALTERNATE_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
 InheritedALTERNATE_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
 InheritedDEFAULT_CHILD_NAME_LABEL : String = feathers-button-label
[static] DEPRECATED: Replaced by Button.DEFAULT_CHILD_STYLE_NAME_LABEL.
Button
 InheritedDEFAULT_CHILD_STYLE_NAME_LABEL : String = feathers-button-label
[static] The default value added to the styleNameList of the label.
Button
 InheritedHORIZONTAL_ALIGN_CENTER : String = center
[static] The icon and label will be aligned horizontally to the center of the button.
Button
 InheritedHORIZONTAL_ALIGN_LEFT : String = left
[static] The icon and label will be aligned horizontally to the left edge of the button.
Button
 InheritedHORIZONTAL_ALIGN_RIGHT : String = right
[static] The icon and label will be aligned horizontally to the right edge of the button.
Button
 InheritedICON_POSITION_BOTTOM : String = bottom
[static] The icon will be positioned below the label.
Button
 InheritedICON_POSITION_LEFT : String = left
[static] The icon will be positioned to the left of the label.
Button
 InheritedICON_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
 InheritedICON_POSITION_MANUAL : String = manual
[static] The icon will be positioned manually with no relation to the position of the label.
Button
 InheritedICON_POSITION_RIGHT : String = right
[static] The icon will be positioned to the right of the label.
Button
 InheritedICON_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
 InheritedICON_POSITION_TOP : String = top
[static] The icon will be positioned above the label.
Button
 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
 InheritedSTATE_DISABLED : String = disabled
[static] Identifier for the button's disabled state.
Button
 InheritedSTATE_DOWN : String = down
[static] Identifier for the button's down state.
Button
 InheritedSTATE_HOVER : String = hover
[static] Identifier for the button's hover state.
Button
 InheritedSTATE_UP : String = up
[static] Identifier for the button's up state.
Button
 InheritedVERTICAL_ALIGN_BOTTOM : String = bottom
[static] The icon and label will be aligned vertically to the bottom edge of the button.
Button
 InheritedVERTICAL_ALIGN_MIDDLE : String = middle
[static] The icon and label will be aligned vertically to the middle of the button.
Button
 InheritedVERTICAL_ALIGN_TOP : String = top
[static] The icon and label will be aligned vertically to the top edge of the button.
Button
Property Detail
globalStyleProviderproperty
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all FullScreenToggleButton 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
Constructor Detail
FullScreenToggleButton()Constructor
public function FullScreenToggleButton()

Constructor.