Packagefeathers.controls
Classpublic class Alert
InheritanceAlert Inheritance Panel Inheritance ScrollContainer Inheritance Scroller Inheritance FeathersControl Inheritance starling.display.Sprite

Product Version : Feathers 1.2.0

Displays a message in a modal pop-up with a title and a set of buttons.

In general, an Alert isn't instantiated directly. Instead, you will typically call the static function Alert.show(). This is not required, but it result in less code and no need to manually manage calls to the PopUpManager.

In the following example, an alert is shown when a Button is triggered:

button.addEventListener( Event.TRIGGERED, button_triggeredHandler );

function button_triggeredHandler( event:Event ):void
{
    var alert:Alert = Alert.show( "This is an alert!", "Hello World", new ArrayCollection(
    [
        { label: "OK" }
    ]));
}

See also

How to use the Feathers Alert component


Public Properties
 PropertyDefined By
  acceptButtonIndex : int
The index of the button in the buttonsDataProvider to trigger when Keyboard.ENTER is pressed.
Alert
  alertFactory : Function
[static] Returns a new Alert instance when Alert.show() is called.
Alert
 InheritedautoSizeMode : String
Determines how the container will set its own size when its dimensions (width and height) aren't set explicitly.
ScrollContainer
 InheritedbottomPullView : DisplayObject
A view that is displayed at the bottom of the scroller's view port when dragging up.
Scroller
 InheritedbottomPullViewDisplayMode : String
Indicates whether the bottom pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
  buttonGroupFactory : Function
A function used to generate the alerts's button group sub-component.
Alert
  buttonGroupProperties : Object
An object that stores properties for the alert's button group sub-component, and the properties will be passed down to the button group when the alert validates.
Alert
  buttonsDataProvider : IListCollection
The data provider of the alert's ButtonGroup.
Alert
  cancelButtonIndex : int
The index of the button in the buttonsDataProvider to trigger when Keyboard.ESCAPE or Keyboard.BACK is pressed.
Alert
 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
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusExtrasAfter : Vector.<DisplayObject>
[read-only] Extra display objects that are not accessible through standard display list functions like getChildAt(), but should appear after those children in the focus order.
Panel
 InheritedfocusExtrasBefore : Vector.<DisplayObject>
[read-only] Extra display objects that are not accessible through standard display list functions like getChildAt(), but should appear before those children in the focus order.
Panel
 InheritedfocusManager : 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
 InheritedfocusOwner : 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 Alert components.
Alert
 InheritedheaderFactory : Function
A function used to generate the panel's header sub-component.
Panel
 InheritedheaderProperties : Object
An object that stores properties for the container's header sub-component, and the properties will be passed down to the header when the container validates.
Panel
 InheritedheaderTitleField : String
A property of the header that should be used to display the panel's title.
Panel
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedhorizontalPageCount : int
[read-only] The number of horizontal pages, if snapping is enabled.
Scroller
 InheritedhorizontalPageIndex : int
The index of the horizontal page, if snapping is enabled.
Scroller
 InheritedhorizontalScrollBarFactory : Function
Creates the horizontal scroll bar.
Scroller
 InheritedhorizontalScrollBarProperties : Object
An object that stores properties for the container's horizontal scroll bar, and the properties will be passed down to the horizontal scroll bar when the container validates.
Scroller
 InheritedhorizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the x-axis) or not.
Scroller
 InheritedhorizontalScrollPosition : Number
The number of pixels the container has been scrolled horizontally (on the x-axis).
Scroller
 InheritedhorizontalScrollStep : Number
The number of pixels the horizontal scroll position can be adjusted by a "step".
Scroller
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisBottomPullViewActive : Boolean
Indicates if the bottomPullView has been activated.
Scroller
 InheritedisChildFocusEnabled : Boolean
Determines if this component's children can receive focus.
ScrollContainer
 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
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
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisLeftPullViewActive : Boolean
Indicates if the leftPullView has been activated.
Scroller
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisRightPullViewActive : Boolean
Indicates if the rightPullView has been activated.
Scroller
 InheritedisScrolling : Boolean
[read-only] Determines if the scroller is currently scrolling with user interaction or with animation.
Scroller
 InheritedisShowingFocus : 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
 InheritedisTopPullViewActive : Boolean
Indicates if the topPullView has been activated.
Scroller
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedleftPullView : DisplayObject
A view that is displayed to the left of the scroller's view port when dragging to the right.
Scroller
 InheritedleftPullViewDisplayMode : String
Indicates whether the left pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
 InheritedmaintainTouchFocus : 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
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxHorizontalPageIndex : int
[read-only] The maximum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the right.
Scroller
 InheritedmaxVerticalPageIndex : int
[read-only] The maximum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the bottom edge.
Scroller
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmeasureViewPort : Boolean
Determines if the dimensions of the view port are used when measuring the scroller.
Scroller
  message : String
The alert's main text content.
Alert
  messageFactory : Function
A function used to instantiate the alert's message text renderer sub-component.
Alert
  messageProperties : Object
An object that stores properties for the alert's message text renderer sub-component, and the properties will be passed down to the text renderer when the alert validates.
Alert
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHorizontalPageIndex : int
[read-only] The minimum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the left.
Scroller
 InheritedminimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move before the scroller starts scrolling.
Scroller
 InheritedminimumPageThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch must move before the scroller will "throw" to the next page.
Scroller
 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
 InheritedminVerticalPageIndex : int
[read-only] The minimum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the top edge.
Scroller
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextDownFocus : 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
 InheritednextLeftFocus : 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
 InheritednextRightFocus : 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
 InheritednextTabFocus : 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
 InheritednextUpFocus : 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
 InheritednumRawChildren : int
[read-only] Returns the number of raw children that are added directly to the Scroller rather than delegating the call to the view port.
ScrollContainer
  overlayFactory : Function
[static] Creates overlays for modal alerts.
Alert
 InheritedpageHeight : Number
When set, the vertical pages snap to this height value instead of the height of the scroller.
Scroller
 InheritedpageWidth : Number
When set, the horizontal pages snap to this width value instead of the width of the scroller.
Scroller
 InheritedpreviousTabFocus : 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
 InheritedrightPullView : DisplayObject
A view that is displayed to the right of the scroller's view port when dragging to the left.
Scroller
 InheritedrightPullViewDisplayMode : String
Indicates whether the right pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
 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
 Inheritedtitle : String
The panel's title to display in the header.
Panel
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 InheritedtopPullView : DisplayObject
A view that is displayed at the top of the scroller's view port when dragging down.
Scroller
 InheritedtopPullViewDisplayMode : String
Indicates whether the top pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.
Scroller
 InheritedverticalMouseWheelScrollDirection : String
The direction of scrolling when the user scrolls the mouse wheel vertically.
Scroller
 InheritedverticalMouseWheelScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step" when using the mouse wheel.
Scroller
 InheritedverticalPageCount : int
[read-only] The number of vertical pages, if snapping is enabled.
Scroller
 InheritedverticalPageIndex : int
The index of the vertical page, if snapping is enabled.
Scroller
 InheritedverticalScrollBarFactory : Function
Creates the vertical scroll bar.
Scroller
 InheritedverticalScrollBarProperties : Object
An object that stores properties for the container's vertical scroll bar, and the properties will be passed down to the vertical scroll bar when the container validates.
Scroller
 InheritedverticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the y-axis) or not.
Scroller
 InheritedverticalScrollPosition : Number
The number of pixels the container has been scrolled vertically (on the y-axis).
Scroller
 InheritedverticalScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step".
Scroller
 InheritedviewPort : IViewPort
The display object displayed and scrolled within the Scroller.
Scroller
 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
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
  buttonGroupFooter : ButtonGroup
The button group sub-component.
Alert
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
 InheriteddisplayListBypassEnabled : Boolean = true
A flag that indicates if the display list functions like addChild() and removeChild() will be passed to the internal view port.
ScrollContainer
 InheritedfooterStyleName : String = "feathers-panel-footer"
The default value added to the styleNameList of the footer.
Panel
 InheritedhasPendingHorizontalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 InheritedhasPendingVerticalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 Inheritedheader : IFeathersControl
The header sub-component.
Panel
  headerHeader : Header
The header sub-component.
Alert
 InheritedheaderStyleName : String = "feathers-panel-header"
The default value added to the styleNameList of the header.
Panel
 InheritedhorizontalScrollBar : IScrollBar
The horizontal scrollbar instance.
Scroller
 InheritedhorizontalScrollBarStyleName : String = "feathers-scroller-horizontal-scroll-bar"
The value added to the styleNameList of the horizontal scroll bar.
Scroller
  messageStyleName : String = "feathers-alert-message"
The value added to the styleNameList of the alert's message text renderer.
Alert
  messageTextRenderer : ITextRenderer
The message text renderer sub-component.
Alert
 InheritedpendingHorizontalPageIndex : int
The pending horizontal page index to scroll to after validating.
Scroller
 InheritedpendingHorizontalScrollPosition : Number = NaN
The pending horizontal scroll position to scroll to after validating.
Scroller
 InheritedpendingScrollDuration : Number
The duration of the pending scroll action.
Scroller
 InheritedpendingVerticalPageIndex : int
The pending vertical page index to scroll to after validating.
Scroller
 InheritedpendingVerticalScrollPosition : Number = NaN
The pending vertical scroll position to scroll to after validating.
Scroller
 InheritedverticalScrollBar : IScrollBar
The vertical scrollbar instance.
Scroller
 InheritedverticalScrollBarStyleName : String = "feathers-scroller-vertical-scroll-bar"
The value added to the styleNameList of the vertical scroll bar.
Scroller
Public Methods
 MethodDefined By
  
Constructor.
Alert
 Inherited
addRawChild(child:DisplayObject):DisplayObject
Adds a child to the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
addRawChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child to the Scroller at a specific index rather than delegating the call to the view port.
ScrollContainer
  
[static] The default factory that creates alerts when Alert.show() is called.
Alert
 Inherited
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
 Inherited
getRawChildAt(index:int):DisplayObject
Gets the direct child of the Scroller at a specific index rather than delegating the call to the view port.
ScrollContainer
 Inherited
getRawChildByName(name:String):DisplayObject
Gets the name of a direct child of the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
getRawChildIndex(child:DisplayObject):int
Gets the index of a direct child of the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
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
Readjusts the layout of the container according to its current content.
ScrollContainer
 Inherited
removeRawChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
removeRawChildAt(index:int, dispose:Boolean = false):DisplayObject
Removes a child from the Scroller at a specific index rather than delegating the call to the view port.
ScrollContainer
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
If the scroll bars are floating, briefly show them as a hint to the user.
Scroller
 Inherited
scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void
After the next validation, animates the scroll position to a specific page index.
Scroller
 Inherited
scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void
After the next validation, animates the scroll positions to a specific location.
Scroller
 Inherited
setRawChildIndex(child:DisplayObject, index:int):void
Sets the index of a direct child of the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
  
show(message:String, title:String = null, buttons:IListCollection = null, icon:DisplayObject = null, isModal:Boolean = true, isCentered:Boolean = true, customAlertFactory:Function = null, customOverlayFactory:Function = null):Alert
[static] Creates an alert, sets common properties, and adds it to the PopUpManager with the specified modal and centering options.
Alert
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
sortRawChildren(compareFunction:Function):void
Sorts the children of the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
If the user is scrolling with touch or if the scrolling is animated, calling stopScrolling() will cause the scroller to ignore the drag and stop animations.
Scroller
 Inherited
swapRawChildren(child1:DisplayObject, child2:DisplayObject):void
Swaps the children of the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
swapRawChildrenAt(index1:int, index2:int):void
Swaps the children of the Scroller rather than delegating the call to the view port.
ScrollContainer
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
[override] If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
Panel
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
Prepares the scroller for normal interaction and dispatches FeathersEventType.SCROLL_COMPLETE.
Scroller
  
Creates and adds the buttonGroupFooter sub-component and removes the old instance, if one exists.
Alert
  
[override] Creates and adds the header sub-component and removes the old instance, if one exists.
Alert
  
Creates and adds the messageTextRenderer sub-component and removes the old instance, if one exists.
Alert
 Inherited
Creates and adds the horizontalScrollBar and verticalScrollBar sub-components and removes the old instances, if they exist.
Scroller
 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
Scrolls to a pending scroll position, if required.
Scroller
 Inherited
The next style that is set will not be restricted.
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 children based on the actual width and height values.
Scroller
 Inherited
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
 Inherited
Choose the appropriate background skin based on the control's current state.
Scroller
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 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
If scrolling hasn't already started, prepares the scroller to scroll and dispatches FeathersEventType.SCROLL_START.
Scroller
 Inherited
throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void
Immediately throws the scroller to the specified position, with optional animation.
Scroller
 Inherited
throwToPage(targetHorizontalPageIndex:int, targetVerticalPageIndex:int, duration:Number = 0.5):void
Immediately throws the scroller to the specified page index, with optional animation.
Scroller
Events
 Event Summary Defined By
 InheritedDispatched when the user starts dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user starts interacting with the scroll bar.Scroller
  Dispatched when the alert is closed.Alert
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched when the user stops dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user stops interacting with the scroll bar.Scroller
 InheritedDispatched when the component receives focus.Scroller
 InheritedDispatched when the component loses focus.Scroller
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed.Scroller
 InheritedDispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation.Scroller
 InheritedDispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation.Scroller
 InheritedDispatched when a pull view is activated.Scroller
Styles
 StyleDefined By
 Inherited
If true, the background's visible property will be set to false when the scroll position is greater than or equal to the minimum scroll position and less than or equal to the maximum scroll position.
Scroller
 Inherited
backgroundDisabledSkin : DisplayObject
A background to display when the container is disabled.
Scroller
 Inherited
backgroundSkin : DisplayObject
The default background to display.
Scroller
 Inherited
clipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds.
Scroller
  
A style name to add to the alert's button group sub-component.
Alert
 Inherited
A style name to add to the panel's header sub-component.
Panel
 Inherited
A style name to add to the container's horizontal scroll bar sub-component.
Scroller
  
A style name to add to the alert's message text renderer sub-component.
Alert
 Inherited
A style name to add to the container's vertical scroll bar sub-component.
Scroller
 Inherited
This value is used to decelerate the scroller when "thrown".
Scroller
  
disabledFontStyles : TextFormat
The font styles used to display the alert's message text when the alert is disabled.
Alert
 Inherited
elasticity : Number
If the scroll position goes outside the minimum or maximum bounds when the scroller's content is being actively dragged, the scrolling will be constrained using this multiplier.
Scroller
 Inherited
The duration, in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds.
Scroller
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
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 alert's message text.
Alert
  
gap : Number
The space, in pixels, between the alert's icon and its message text renderer.
Alert
 Inherited
hasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport.
Scroller
 Inherited
The duration, in seconds, of the animation when a scroll bar fades out.
Scroller
 Inherited
The easing function used for hiding the scroll bars, if applicable.
Scroller
 Inherited
Determines where the horizontal scroll bar will be positioned.
Scroller
  
icon : DisplayObject
The alert's optional icon content to display next to the text.
Alert
 Inherited
Determines how the user may interact with the scroller.
Scroller
 Inherited
layout : ILayout
Controls the way that the container's children are positioned and sized.
ScrollContainer
 Inherited
The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.
Scroller
 Inherited
outerPadding : Number
Quickly sets all outer padding properties to the same value.
Panel
 Inherited
The minimum space, in pixels, between the panel's bottom edge and the panel's footer.
Panel
 Inherited
The minimum space, in pixels, between the panel's left edge and the panel's header, middle content, and footer.
Panel
 Inherited
The minimum space, in pixels, between the panel's right edge and the panel's header, middle content, and footer.
Panel
 Inherited
The minimum space, in pixels, between the panel's top edge and the panel's header.
Panel
 Inherited
padding : Number
Quickly sets all padding properties to the same value.
Scroller
 Inherited
paddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and the container's content.
Scroller
 Inherited
paddingLeft : Number
The minimum space, in pixels, between the container's left edge and the container's content.
Scroller
 Inherited
paddingRight : Number
The minimum space, in pixels, between the container's right edge and the container's content.
Scroller
 Inherited
paddingTop : Number
The minimum space, in pixels, between the container's top edge and the container's content.
Scroller
 Inherited
The duration, in seconds, of the animation when the scroller is thrown to a page.
Scroller
 Inherited
The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars().
Scroller
 Inherited
Determines how the scroll bars are displayed.
Scroller
 Inherited
If enabled, the scroll position will always be adjusted to the nearest pixel on the physical screen.
Scroller
 Inherited
snapToPages : Boolean
Determines if scrolling will snap to the nearest page.
Scroller
 Inherited
throwEase : Object
The easing function used for "throw" animations.
Scroller
 Inherited
If the scroll position goes outside the minimum or maximum bounds when the scroller's content is "thrown", the scrolling will be constrained using this multiplier.
Scroller
 Inherited
If true, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity.
Scroller
 Inherited
Determines where the vertical scroll bar will be positioned.
Scroller
Public Constants
 ConstantDefined By
 InheritedALTERNATE_STYLE_NAME_TOOLBAR : String = "feathers-toolbar-scroll-container"
[static] An alternate style name to use with ScrollContainer to allow a theme to give it a toolbar style.
ScrollContainer
  DEFAULT_CHILD_STYLE_NAME_BUTTON_GROUP : String = "feathers-alert-button-group"
[static] The default value added to the styleNameList of the button group.
Alert
 InheritedDEFAULT_CHILD_STYLE_NAME_FOOTER : String = "feathers-panel-footer"
[static] The default value added to the styleNameList of the footer.
Panel
  DEFAULT_CHILD_STYLE_NAME_HEADER : String = "feathers-alert-header"
[static] The default value added to the styleNameList of the header.
Alert
 InheritedDEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR : String = "feathers-scroller-horizontal-scroll-bar"
[static] The default value added to the styleNameList of the horizontal scroll bar.
Scroller
  DEFAULT_CHILD_STYLE_NAME_MESSAGE : String = "feathers-alert-message"
[static] The default value added to the styleNameList of the message text renderer.
Alert
 InheritedDEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR : String = "feathers-scroller-vertical-scroll-bar"
[static] The default value added to the styleNameList of the vertical scroll bar.
Scroller
 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
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = "clipping"
[static] Flag to indicate that the clipping has changed.
Scroller
Property Detail
acceptButtonIndexproperty
acceptButtonIndex:int

The index of the button in the buttonsDataProvider to trigger when Keyboard.ENTER is pressed.

In the following example, the acceptButtonIndex is set to the first button in the data provider.

var alert:Alert = Alert.show( "This is an alert!", "Hello World", new ArrayCollection(
[
    { label: "OK" }
]));
alert.acceptButtonIndex = 0;

The default value is -1.


Implementation
    public function get acceptButtonIndex():int
    public function set acceptButtonIndex(value:int):void
alertFactoryproperty 
public static var alertFactory:Function

Returns a new Alert instance when Alert.show() is called. If one wishes to skin the alert manually, a custom factory may be provided.

This function is expected to have the following signature:

function():Alert

The following example shows how to create a custom alert factory:

Alert.alertFactory = function():Alert
{
    var alert:Alert = new Alert();
    //set properties here!
    return alert;
};

See also

buttonGroupFactoryproperty 
buttonGroupFactory:Function

A function used to generate the alerts's button group sub-component. The button group must be an instance of ButtonGroup. This factory can be used to change properties on the button group when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the button group.

The function should have the following signature:

function():ButtonGroup

In the following example, a custom button group factory is provided to the alert:

alert.buttonGroupFactory = function():ButtonGroup
{
    return new ButtonGroup();
};

The default value is null.


Implementation
    public function get buttonGroupFactory():Function
    public function set buttonGroupFactory(value:Function):void

See also

buttonGroupFooterproperty 
protected var buttonGroupFooter:ButtonGroup

The button group sub-component.

For internal use in subclasses.

buttonGroupPropertiesproperty 
buttonGroupProperties:Object

An object that stores properties for the alert's button group sub-component, and the properties will be passed down to the button group when the alert validates. For a list of available properties, refer to feathers.controls.ButtonGroup.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a buttonGroupFactory function instead of using buttonGroupProperties will result in better performance.

In the following example, the button group properties are customized:

alert.buttonGroupProperties.gap = 20;

The default value is null.


Implementation
    public function get buttonGroupProperties():Object
    public function set buttonGroupProperties(value:Object):void

See also

buttonsDataProviderproperty 
buttonsDataProvider:IListCollection

The data provider of the alert's ButtonGroup.


Implementation
    public function get buttonsDataProvider():IListCollection
    public function set buttonsDataProvider(value:IListCollection):void
cancelButtonIndexproperty 
cancelButtonIndex:int

The index of the button in the buttonsDataProvider to trigger when Keyboard.ESCAPE or Keyboard.BACK is pressed.

In the following example, the cancelButtonIndex is set to the second button in the data provider.

var alert:Alert = Alert.show( "This is an alert!", "Hello World", new ArrayCollection(
[
    { label: "OK" },
    { label: "Cancel" },
]));
alert.cancelButtonIndex = 1;

The default value is -1.


Implementation
    public function get cancelButtonIndex():int
    public function set cancelButtonIndex(value:int):void
globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all Alert components.

The default value is null.

See also

headerHeaderproperty 
protected var headerHeader:Header

The header sub-component.

For internal use in subclasses.

messageproperty 
message:String

The alert's main text content.


Implementation
    public function get message():String
    public function set message(value:String):void
messageFactoryproperty 
messageFactory:Function

A function used to instantiate the alert's message text renderer sub-component. By default, the alert will use the global text renderer factory, FeathersControl.defaultTextRendererFactory(), to create the message text renderer. The message text renderer must be an instance of ITextRenderer. This factory can be used to change properties on the message text renderer when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to style the message text renderer.

If you are not using a theme, the message factory can be used to provide skin the message text renderer with appropriate text styles.

The factory should have the following function signature:

function():ITextRenderer

In the following example, a custom message factory is passed to the alert:

alert.messageFactory = function():ITextRenderer
{
    var messageRenderer:TextFieldTextRenderer = new TextFieldTextRenderer();
    messageRenderer.textFormat = new TextFormat( "_sans", 12, 0xff0000 );
    return messageRenderer;
}

The default value is null.


Implementation
    public function get messageFactory():Function
    public function set messageFactory(value:Function):void

See also

messagePropertiesproperty 
messageProperties:Object

An object that stores properties for the alert's message text renderer sub-component, and the properties will be passed down to the text renderer when the alert validates. The available properties depend on which ITextRenderer implementation is returned by messageFactory. Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

In the following example, some properties are set for the alert's message text renderer (this example assumes that the message text renderer is a BitmapFontTextRenderer):

alert.messageProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
alert.messageProperties.wordWrap = true;

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a messageFactory function instead of using messageProperties will result in better performance.

The default value is null.


Implementation
    public function get messageProperties():Object
    public function set messageProperties(value:Object):void

See also

messageStyleNameproperty 
protected var messageStyleName:String = "feathers-alert-message"

The value added to the styleNameList of the alert's message text renderer. This variable is protected so that sub-classes can customize the message style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_MESSAGE.

See also

messageTextRendererproperty 
protected var messageTextRenderer:ITextRenderer

The message text renderer sub-component.

For internal use in subclasses.

overlayFactoryproperty 
public static var overlayFactory:Function

Creates overlays for modal alerts. When this property is null, uses the overlayFactory defined by PopUpManager instead.

Note: Specific, individual alerts may have custom overlays that are different than the default by passing a different overlay factory to Alert.show().

This function is expected to have the following signature:

function():DisplayObject

The following example uses a semi-transparent Quad as a custom overlay:

Alert.overlayFactory = function():Quad
{
    var quad:Quad = new Quad(10, 10, 0x000000);
    quad.alpha = 0.75;
    return quad;
};

The default value is null.

See also

Constructor Detail
Alert()Constructor
public function Alert()

Constructor.

Method Detail
createButtonGroup()method
protected function createButtonGroup():void

Creates and adds the buttonGroupFooter sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

createHeader()method 
override protected function createHeader():void

Creates and adds the header sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

createMessage()method 
protected function createMessage():void

Creates and adds the messageTextRenderer sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

defaultAlertFactory()method 
public static function defaultAlertFactory():Alert

The default factory that creates alerts when Alert.show() is called. To use a different factory, you need to set Alert.alertFactory to a Function instance.

Returns
Alert

See also

show()method 
public static function show(message:String, title:String = null, buttons:IListCollection = null, icon:DisplayObject = null, isModal:Boolean = true, isCentered:Boolean = true, customAlertFactory:Function = null, customOverlayFactory:Function = null):Alert

Creates an alert, sets common properties, and adds it to the PopUpManager with the specified modal and centering options.

In the following example, an alert is shown when a Button is triggered:

button.addEventListener( Event.TRIGGERED, button_triggeredHandler );
function button_triggeredHandler( event:Event ):void
{
    var alert:Alert = Alert.show( "This is an alert!", "Hello World", new ArrayCollection(
    [
        { label: "OK" }
    ]);
}

Parameters

message:String
 
title:String (default = null)
 
buttons:IListCollection (default = null)
 
icon:DisplayObject (default = null)
 
isModal:Boolean (default = true)
 
isCentered:Boolean (default = true)
 
customAlertFactory:Function (default = null)
 
customOverlayFactory:Function (default = null)

Returns
Alert
Event Detail
close Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CLOSE

Dispatched when the alert is closed. The data property of the event object will contain the item from the ButtonGroup data provider for the button that is triggered. If no button is triggered, then the data property will be null.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
datanull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

Style Detail
iconstyle
icon:DisplayObject

The alert's optional icon content to display next to the text.

In the following example, the icon is privated:

alert.icon = new Image( texture );

The default value is null.

gapstyle 
gap:Number

The space, in pixels, between the alert's icon and its message text renderer.

In the following example, the gap is set to 20 pixels:

alert.gap = 20;

The default value is 0.

fontStylesstyle 
fontStyles:TextFormat

The font styles used to display the alert's message text.

These styles will only apply to the alert's message. The header's title font styles should be set directly on the header. The button font styles should be set directly on the buttons.

In the following example, the font styles are customized:

alert.fontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the messageFactory to set more advanced styles.

The default value is null.

See also

disabledFontStylesstyle 
disabledFontStyles:TextFormat

The font styles used to display the alert's message text when the alert is disabled.

These styles will only apply to the alert's message. The header's title font styles should be set directly on the header. The button font styles should be set directly on the buttons.

In the following example, the disabled font styles are customized:

alert.disabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the messageFactory to set more advanced styles on the text renderer.

The default value is null.

See also

customMessageStyleNamestyle 
customMessageStyleName:String

A style name to add to the alert's message text renderer sub-component. Typically used by a theme to provide different styles to different alerts.

In the following example, a custom message style name is passed to the alert:

alert.customMessageStyleName = "my-custom-button-group";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-message", setCustomMessageStyles );

The default value is null.

See also

customButtonGroupStyleNamestyle 
customButtonGroupStyleName:String

A style name to add to the alert's button group sub-component. Typically used by a theme to provide different styles to different alerts.

In the following example, a custom button group style name is passed to the alert:

alert.customButtonGroupStyleName = "my-custom-button-group";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( ButtonGroup ).setFunctionForStyleName( "my-custom-button-group", setCustomButtonGroupStyles );

The default value is null.

See also

Constant Detail
DEFAULT_CHILD_STYLE_NAME_BUTTON_GROUPConstant
public static const DEFAULT_CHILD_STYLE_NAME_BUTTON_GROUP:String = "feathers-alert-button-group"

The default value added to the styleNameList of the button group.

See also

DEFAULT_CHILD_STYLE_NAME_HEADERConstant 
public static const DEFAULT_CHILD_STYLE_NAME_HEADER:String = "feathers-alert-header"

The default value added to the styleNameList of the header.

See also

DEFAULT_CHILD_STYLE_NAME_MESSAGEConstant 
public static const DEFAULT_CHILD_STYLE_NAME_MESSAGE:String = "feathers-alert-message"

The default value added to the styleNameList of the message text renderer.

See also