feathers.media.FullScreenToggleButton

Public Properties

	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 FullScreenToggleButton components.	FullScreenToggleButton
		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.	FullScreenToggleButton
		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
		width : Number [override] The width of the component, in pixels.	FeathersControl

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		currentIcon : DisplayObject The currently visible icon.	Button
		currentSkin : DisplayObject The currently visible skin.	BasicButton
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl
		labelStyleName : String = "feathers-button-label" The value added to the styleNameList of the label text renderer.	Button
		labelTextRenderer : ITextRenderer The text renderer for the button's label.	Button

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		FullScreenToggleButton() Constructor.	FullScreenToggleButton
		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

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		autoSizeIfNeeded():Boolean If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.	BasicButton
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		createLabel():void Creates the label text renderer sub-component and removes the old instance, if one exists.	Button
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		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
		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
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	FeathersControl
		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
		layoutContent():void Positions and sizes the button's content.	Button
		processStyleRestriction(key:Object):Boolean Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.	FeathersControl
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		refreshIcon():void Sets the currentIcon property.	Button
		refreshSkin():void Sets the currentSkin property.	BasicButton
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	FeathersControl
		setInvalidationFlag(flag:String):void Sets an invalidation flag.	FeathersControl
		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

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
change	Dispatched when the button is selected or deselected either programmatically or as a result of user interaction.	ToggleButton
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
longPress	Dispatched when the button is pressed for a long time.	Button
resize	Dispatched when the width or height of the control changes.	FeathersControl
stateChange	Dispatched when the display object's state changes.	BasicButton
triggered	Dispatched when the the user taps or clicks the button.	BasicButton

Styles

Hide Inherited Styles

Show Inherited Styles

	Style		Defined By
		customLabelStyleName : String A style name to add to the button's label text renderer sub-component.	Button
		defaultIcon : DisplayObject The icon used when no other icon is defined for the current state.	Button
		defaultSelectedIcon : DisplayObject The icon used when no other icon is defined for the current state when the button is selected.	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.	BasicButton
		disabledFontStyles : TextFormat The font styles used to display the button's text when the button is disabled.	Button
		disabledIcon : DisplayObject The icon used for the button's disabled state.	Button
		disabledSkin : DisplayObject The skin used for the button's disabled state.	BasicButton
		downIcon : DisplayObject The icon used for the button's down state.	Button
		downSkin : DisplayObject The skin used for the button's down state.	BasicButton
		focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.	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
		fontStyles : TextFormat The font styles used to display the button's text.	Button
		gap : Number The space, in pixels, between the icon and the label.	Button
		hasLabelTextRenderer : Boolean Determines if the button's label text renderer is created or not.	Button
		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
		hoverSkin : DisplayObject The skin used for the button's hover state.	BasicButton
		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
		keepDownStateOnRollOut : Boolean Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.	BasicButton
		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
		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
		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
		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
		scaleWhenSelected : Number If not NaN, the button renders at this scale when selected.	ToggleButton
		selectedDisabledIcon : DisplayObject The icon used for the button's disabled state when the button is selected.	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
		selectedDownSkin : DisplayObject The skin used for the button's down state when the button is selected.	ToggleButton
		selectedFontStyles : TextFormat The font styles used to display the button's text when the button is selected.	ToggleButton
		selectedHoverIcon : DisplayObject The icon used for the button's hover state when the button is selected.	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
		selectedUpSkin : DisplayObject The skin used for the button's up state when the button is selected.	ToggleButton
		upIcon : DisplayObject The icon used for the button's up state.	Button
		upSkin : DisplayObject The skin used for the button's up state.	BasicButton
		verticalAlign : String The location where the button's content is aligned vertically (on the y-axis).	Button
		wordWrap : Boolean Determines if the text wraps to the next line when it reaches the width (or max width) of the component.	Button

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	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_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

Property Detail

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all FullScreenToggleButton components.

The default value is null.

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
FullScreenToggleButton	Properties Methods Events Styles Constants

Package	feathers.media
Class	public class FullScreenToggleButton
Inheritance	FullScreenToggleButton ToggleButton Button BasicButton FeathersControl starling.display.Sprite
Implements	IMediaPlayerControl