Package | feathers.controls |
Class | public class Alert |
Inheritance | Alert ![]() ![]() ![]() ![]() ![]() |
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 ListCollection( [ { label: "OK" } ])); }
See also
Property | Defined By | ||
---|---|---|---|
alertFactory : Function [static]
Returns a new Alert instance when Alert.show()
is called. | Alert | ||
![]() | autoHideBackground : Boolean
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 | |
![]() | autoSizeMode : String
Determines how the container will set its own size when its
dimensions (width and height) aren't set explicitly. | ScrollContainer | |
![]() | backgroundDisabledSkin : DisplayObject
A background to display when the container is disabled. | Scroller | |
![]() | backgroundSkin : DisplayObject
The default background to display. | 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 : ListCollection
The data provider of the alert's ButtonGroup. | Alert | ||
![]() | clipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds. | Scroller | |
customButtonGroupName : String
DEPRECATED: Replaced by customButtonGroupStyleName. | Alert | ||
customButtonGroupStyleName : String
A style name to add to the alert's button group sub-component. | Alert | ||
![]() | customHeaderName : String
DEPRECATED: Replaced by customHeaderStyleName. | Panel | |
![]() | customHeaderStyleName : String
A style name to add to the panel's header sub-component. | Panel | |
![]() | customHorizontalScrollBarName : String
DEPRECATED: Replaced by customHorizontalScrollBarName. | Scroller | |
![]() | customHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar
sub-component. | Scroller | |
customMessageStyleName : String
A style name to add to the alert's message text renderer
sub-component. | Alert | ||
![]() | customVerticalScrollBarName : String
DEPRECATED: Replaced by customVerticalScrollBarStyleName. | Scroller | |
![]() | customVerticalScrollBarStyleName : String
A style name to add to the container's vertical scroll bar
sub-component. | Scroller | |
![]() | decelerationRate : Number
This value is used to decelerate the scroller when "thrown". | Scroller | |
![]() | 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 | |
![]() | 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 | |
![]() | elasticSnapDuration : Number
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 | |
![]() | focusExtrasAfter : 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 | |
![]() | focusExtrasBefore : 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 | |
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
gap : Number
The space, in pixels, between the alert's icon and its message text
renderer. | Alert | ||
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all Alert
components. | Alert | ||
![]() | hasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport. | Scroller | |
![]() | headerFactory : Function
A function used to generate the panel's header sub-component. | Panel | |
![]() | headerProperties : 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 | |
![]() | headerTitleField : String
A property of the header that should be used to display the panel's
title. | Panel | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades
out. | Scroller | |
![]() | hideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable. | Scroller | |
![]() | horizontalPageCount : int [read-only]
The number of horizontal pages, if snapping is enabled. | Scroller | |
![]() | horizontalPageIndex : int [read-only]
The index of the horizontal page, if snapping is enabled. | Scroller | |
![]() | horizontalScrollBarFactory : Function
Creates the horizontal scroll bar. | Scroller | |
![]() | horizontalScrollBarProperties : 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 | |
![]() | horizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the
x-axis) or not. | Scroller | |
![]() | horizontalScrollPosition : Number
The number of pixels the container has been scrolled horizontally (on
the x-axis). | Scroller | |
![]() | horizontalScrollStep : Number
The number of pixels the horizontal scroll position can be adjusted
by a "step". | Scroller | |
icon : DisplayObject
The alert's optional icon content to display next to the text. | Alert | ||
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | interactionMode : String
Determines how the user may interact with the scroller. | Scroller | |
![]() | isChildFocusEnabled : Boolean
Determines if this component's children can receive focus. | ScrollContainer | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isScrolling : Boolean [read-only]
Determines if the scroller is currently scrolling with user
interaction or with animation. | Scroller | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxHorizontalPageIndex : int [read-only]
The maximum horizontal page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | maxHorizontalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled horizontally to the
right. | Scroller | |
![]() | maxVerticalPageIndex : int [read-only]
The maximum vertical page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | maxVerticalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled vertically beyond
the bottom edge. | Scroller | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | measureViewPort : 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 | ||
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHorizontalPageIndex : int [read-only]
The minimum horizontal page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | minHorizontalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled horizontally to the
left. | Scroller | |
![]() | minimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move
before the scroller starts scrolling. | Scroller | |
![]() | minimumPageThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch
must move before the scroller will "throw" to the next page. | Scroller | |
![]() | 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 | |
![]() | minVerticalPageIndex : int [read-only]
The minimum vertical page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | minVerticalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled vertically beyond
the top edge. | Scroller | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | mouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel
initiates a scroll action. | Scroller | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | numRawChildren : 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 | |
![]() | outerPadding : Number
Quickly sets all outer padding properties to the same value. | Panel | |
![]() | outerPaddingBottom : Number
The minimum space, in pixels, between the panel's bottom edge and the
panel's footer. | Panel | |
![]() | outerPaddingLeft : Number
The minimum space, in pixels, between the panel's left edge and the
panel's header, middle content, and footer. | Panel | |
![]() | outerPaddingRight : Number
The minimum space, in pixels, between the panel's right edge and the
panel's header, middle content, and footer. | Panel | |
![]() | outerPaddingTop : Number
The minimum space, in pixels, between the panel's top edge and the
panel's header. | Panel | |
overlayFactory : Function [static]
Returns an overlay to display with a alert that is modal. | Alert | ||
![]() | padding : Number
Quickly sets all padding properties to the same value. | Scroller | |
![]() | paddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and
the container's content. | Scroller | |
![]() | paddingLeft : Number
The minimum space, in pixels, between the container's left edge and the
container's content. | Scroller | |
![]() | paddingRight : Number
The minimum space, in pixels, between the container's right edge and
the container's content. | Scroller | |
![]() | paddingTop : Number
The minimum space, in pixels, between the container's top edge and the
container's content. | Scroller | |
![]() | pageHeight : Number
When set, the vertical pages snap to this height value instead of
the height of the scroller. | Scroller | |
![]() | pageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is
thrown to a page. | Scroller | |
![]() | pageWidth : Number
When set, the horizontal pages snap to this width value instead of
the width of the scroller. | Scroller | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | revealScrollBarsDuration : Number
The duration, in seconds, that the scroll bars will be shown when
calling revealScrollBars()
| Scroller | |
![]() | scrollBarDisplayMode : String
Determines how the scroll bars are displayed. | Scroller | |
![]() | snapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole
pixels. | Scroller | |
![]() | snapToPages : Boolean
Determines if scrolling will snap to the nearest page. | Scroller | |
![]() | 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 | |
![]() | throwEase : Object
The easing function used for "throw" animations. | Scroller | |
![]() | throwElasticity : Number
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 | |
![]() | title : String
The panel's title to display in the header. | Panel | |
![]() | useFixedThrowDuration : Boolean
If true, the duration of a "throw" animation will be the
same no matter the value of the throw's initial velocity. | Scroller | |
![]() | verticalMouseWheelScrollDirection : String
The direction of scrolling when the user scrolls the mouse wheel
vertically. | Scroller | |
![]() | verticalMouseWheelScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by
a "step" when using the mouse wheel. | Scroller | |
![]() | verticalPageCount : int [read-only]
The number of vertical pages, if snapping is enabled. | Scroller | |
![]() | verticalPageIndex : int [read-only]
The index of the vertical page, if snapping is enabled. | Scroller | |
![]() | verticalScrollBarFactory : Function
Creates the vertical scroll bar. | Scroller | |
![]() | verticalScrollBarPosition : String
Determines where the vertical scroll bar will be positioned. | Scroller | |
![]() | verticalScrollBarProperties : 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 | |
![]() | verticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the
y-axis) or not. | Scroller | |
![]() | verticalScrollPosition : Number
The number of pixels the container has been scrolled vertically (on
the y-axis). | Scroller | |
![]() | verticalScrollStep : Number
The number of pixels the vertical scroll position can be adjusted
by a "step". | Scroller | |
![]() | viewPort : IViewPort
The display object displayed and scrolled within the Scroller. | Scroller | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
![]() | actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
buttonGroupFooter : ButtonGroup
The button group sub-component. | Alert | ||
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
globalStyleProvider property is set to this value. | FeathersControl | |
![]() | displayListBypassEnabled : Boolean = true
A flag that indicates if the display list functions like addChild()
and removeChild() will be passed to the internal view
port. | ScrollContainer | |
![]() | explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
![]() | explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
![]() | footerName : String
DEPRECATED: Replaced by footerStyleName. | Panel | |
![]() | footerStyleName : String = feathers-panel-footer
The default value added to the styleNameList of the
footer. | Panel | |
![]() | hasPendingHorizontalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page
when it validates. | Scroller | |
![]() | hasPendingVerticalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page
when it validates. | Scroller | |
![]() | header : IFeathersControl
The header sub-component. | Panel | |
headerHeader : Header
The header sub-component. | Alert | ||
![]() | headerName : String
DEPRECATED: Replaced by headerStyleName. | Panel | |
![]() | headerStyleName : String = feathers-panel-header
The default value added to the styleNameList of the
header. | Panel | |
![]() | horizontalScrollBar : IScrollBar
The horizontal scrollbar instance. | Scroller | |
![]() | horizontalScrollBarName : String
DEPRECATED: Replaced by horizontalScrollBarStyleName. | Scroller | |
![]() | horizontalScrollBarStyleName : String = feathers-scroller-horizontal-scroll-bar
The value added to the styleNameList of the horizontal
scroll bar. | Scroller | |
messageName : String
DEPRECATED: Replaced by messageStyleName. | Alert | ||
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 | ||
![]() | pendingHorizontalPageIndex : int
The pending horizontal page index to scroll to after validating. | Scroller | |
![]() | pendingHorizontalScrollPosition : Number = NaN
The pending horizontal scroll position to scroll to after validating. | Scroller | |
![]() | pendingScrollDuration : Number
The duration of the pending scroll action. | Scroller | |
![]() | pendingVerticalPageIndex : int
The pending vertical page index to scroll to after validating. | Scroller | |
![]() | pendingVerticalScrollPosition : Number = NaN
The pending vertical scroll position to scroll to after validating. | Scroller | |
![]() | verticalScrollBar : IScrollBar
The vertical scrollbar instance. | Scroller | |
![]() | verticalScrollBarName : String
DEPRECATED: Replaced by verticalScrollBarStyleName. | Scroller | |
![]() | verticalScrollBarStyleName : String = feathers-scroller-vertical-scroll-bar
The value added to the styleNameList of the vertical
scroll bar. | Scroller |
Method | Defined By | ||
---|---|---|---|
Alert()
Constructor. | Alert | ||
![]() | addRawChild(child:DisplayObject):DisplayObject
Adds a child to the Scroller rather than delegating the
call to the view port. | ScrollContainer | |
![]() | 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 | ||
![]() | 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 | |
![]() | getRawChildByName(name:String):DisplayObject
Gets the name of a direct child of the Scroller rather
than delegating the call to the view port. | ScrollContainer | |
![]() | getRawChildIndex(child:DisplayObject):int
Gets the index of a direct child of the Scroller rather
than delegating the call to the view port. | ScrollContainer | |
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | readjustLayout():void
Readjusts the layout of the container according to its current
content. | ScrollContainer | |
![]() | removeRawChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the Scroller rather than delegating
the call to the view port. | ScrollContainer | |
![]() | 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 | |
![]() | revealScrollBars():void
If the scroll bars are floating, briefly show them as a hint to the
user. | Scroller | |
![]() | scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void
After the next validation, animates the scroll position to a specific
page index. | Scroller | |
![]() | scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void
After the next validation, animates the scroll positions to a
specific location. | Scroller | |
![]() | 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 | |
![]() | 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:ListCollection = 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 | ||
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | sortRawChildren(compareFunction:Function):void
Sorts the children of the Scroller rather than
delegating the call to the view port. | ScrollContainer | |
![]() | stopScrolling():void
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 | |
![]() | swapRawChildren(child1:DisplayObject, child2:DisplayObject):void
Swaps the children of the Scroller rather than
delegating the call to the view port. | ScrollContainer | |
![]() | swapRawChildrenAt(index1:int, index2:int):void
Swaps the children of the Scroller rather than
delegating the call to the view port. | ScrollContainer | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
![]() | autoSizeIfNeeded():Boolean [override]
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | Panel | |
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
![]() | completeScroll():void
Prepares the scroller for normal interaction and dispatches
FeathersEventType.SCROLL_COMPLETE. | Scroller | |
createButtonGroup():void
Creates and adds the buttonGroupFooter sub-component and
removes the old instance, if one exists. | Alert | ||
createHeader():void [override]
Creates and adds the header sub-component and
removes the old instance, if one exists. | Alert | ||
createMessage():void
Creates and adds the messageTextRenderer sub-component and
removes the old instance, if one exists. | Alert | ||
![]() | createScrollBars():void
Creates and adds the horizontalScrollBar and
verticalScrollBar sub-components and removes the old
instances, if they exist. | Scroller | |
![]() | 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 | |
![]() | handlePendingScroll():void
Scrolls to a pending scroll position, if required. | Scroller | |
![]() | 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 | |
![]() | layoutChildren():void
Positions and sizes children based on the actual width and height
values. | Scroller | |
![]() | refreshBackgroundSkin():void
Choose the appropriate background skin based on the control's current
state. | Scroller | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | 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 | |
![]() | startScroll():void
If scrolling hasn't already started, prepares the scroller to scroll
and dispatches FeathersEventType.SCROLL_START. | Scroller | |
![]() | throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void
Immediately throws the scroller to the specified position, with
optional animation. | Scroller | |
![]() | throwToPage(targetHorizontalPageIndex:int, targetVerticalPageIndex:int, duration:Number = 0.5):void
Immediately throws the scroller to the specified page index, with
optional animation. | Scroller |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when the user starts dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user starts interacting with the scroll bar. | Scroller | ||
![]() | Dispatched when the container is scrolled. | ScrollContainer | ||
Dispatched when the alert is closed. | Alert | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched when the user stops dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user stops interacting with the scroll bar. | Scroller | ||
![]() | Dispatched when the component receives focus. | Scroller | ||
![]() | Dispatched when the component loses focus. | Scroller | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
![]() | Dispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed. | Scroller | ||
![]() | Dispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation. | Scroller | ||
![]() | Dispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation. | Scroller |
Constant | Defined By | ||
---|---|---|---|
![]() | ALTERNATE_NAME_TOOLBAR : String = feathers-toolbar-scroll-container [static]
DEPRECATED: Replaced by ScrollContainer.ALTERNATE_STYLE_NAME_TOOLBAR. | ScrollContainer | |
![]() | ALTERNATE_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 | |
![]() | AUTO_SIZE_MODE_CONTENT : String = content [static]
The container will auto size itself to fit its content. | Panel | |
![]() | AUTO_SIZE_MODE_STAGE : String = stage [static]
The container will auto size itself to fill the entire stage. | Panel | |
![]() | DECELERATION_RATE_FAST : Number = 0.99 [static]
Decelerates a bit faster per millisecond than the default. | Panel | |
![]() | DECELERATION_RATE_NORMAL : Number = 0.998 [static]
The default deceleration rate per millisecond. | Panel | |
DEFAULT_CHILD_NAME_BUTTON_GROUP : String = feathers-alert-button-group [static]
DEPRECATED: Replaced by Alert.DEFAULT_CHILD_STYLE_NAME_BUTTON_GROUP. | Alert | ||
![]() | DEFAULT_CHILD_NAME_FOOTER : String = feathers-panel-footer [static]
DEPRECATED: Replaced by Panel.DEFAULT_CHILD_STYLE_NAME_FOOTER. | Panel | |
DEFAULT_CHILD_NAME_HEADER : String = feathers-alert-header [static]
DEPRECATED: Replaced by Alert.DEFAULT_CHILD_STYLE_NAME_HEADER. | Alert | ||
![]() | DEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar [static]
DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR. | Scroller | |
DEFAULT_CHILD_NAME_MESSAGE : String = feathers-alert-message [static]
DEPRECATED: Replaced by Alert.DEFAULT_CHILD_STYLE_NAME_MESSAGE. | Alert | ||
![]() | DEFAULT_CHILD_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar [static]
DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR. | Scroller | |
DEFAULT_CHILD_STYLE_NAME_BUTTON_GROUP : String = feathers-alert-button-group [static]
The default value added to the styleNameList of the button group. | Alert | ||
![]() | DEFAULT_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 | ||
![]() | DEFAULT_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. | Alert | ||
![]() | DEFAULT_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 | |
![]() | INTERACTION_MODE_MOUSE : String = mouse [static]
The user may only interact with the scroll bars to scroll. | Panel | |
![]() | INTERACTION_MODE_TOUCH : String = touch [static]
The user may touch anywhere on the scroller and drag to scroll. | Panel | |
![]() | INTERACTION_MODE_TOUCH_AND_SCROLL_BARS : String = touchAndScrollBars [static]
The user may touch anywhere on the scroller and drag to scroll, and
the scroll bars may be dragged separately. | Panel | |
![]() | 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 | |
![]() | MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL : String = horizontal [static]
The scroller will scroll horizontally when the mouse wheel is scrolled. | Panel | |
![]() | MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL : String = vertical [static]
The scroller will scroll vertically when the mouse wheel is scrolled. | Panel | |
![]() | SCROLL_BAR_DISPLAY_MODE_FIXED : String = fixed [static]
The scroll bars are always visible and appear next to the scroller's
view port, making the view port smaller than the scroller. | Panel | |
![]() | SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT : String = fixedFloat [static]
The scroll bars appear above the scroller's view port, overlapping
the content, but they do not fade out when not in use. | ScrollContainer | |
![]() | SCROLL_BAR_DISPLAY_MODE_FLOAT : String = float [static]
The scroll bars appear above the scroller's view port, overlapping
the content, and they fade out when not in use. | Panel | |
![]() | SCROLL_BAR_DISPLAY_MODE_NONE : String = none [static]
The scroll bars are never visible. | Panel | |
![]() | SCROLL_POLICY_AUTO : String = auto [static]
The scroller may scroll if the view port is larger than the
scroller's bounds. | Panel | |
![]() | SCROLL_POLICY_OFF : String = off [static]
The scroller does not scroll at all. | Panel | |
![]() | SCROLL_POLICY_ON : String = on [static]
The scroller will always scroll. | Panel | |
![]() | VERTICAL_SCROLL_BAR_POSITION_LEFT : String = left [static]
The vertical scroll bar will be positioned on the left. | Panel | |
![]() | VERTICAL_SCROLL_BAR_POSITION_RIGHT : String = right [static]
The vertical scroll bar will be positioned on the right. | Panel |
alertFactory | property |
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
buttonGroupFactory | property |
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
.
public function get buttonGroupFactory():Function
public function set buttonGroupFactory(value:Function):void
See also
buttonGroupFooter | property |
protected var buttonGroupFooter:ButtonGroup
The button group sub-component.
For internal use in subclasses.
buttonGroupProperties | property |
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
.
public function get buttonGroupProperties():Object
public function set buttonGroupProperties(value:Object):void
See also
buttonsDataProvider | property |
buttonsDataProvider:ListCollection
The data provider of the alert's ButtonGroup
.
public function get buttonsDataProvider():ListCollection
public function set buttonsDataProvider(value:ListCollection):void
customButtonGroupName | property |
customButtonGroupName:String
DEPRECATED: Replaced by customButtonGroupStyleName
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
public function get customButtonGroupName():String
public function set customButtonGroupName(value:String):void
See also
customButtonGroupStyleName | property |
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
.
public function get customButtonGroupStyleName():String
public function set customButtonGroupStyleName(value:String):void
See also
customMessageStyleName | property |
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
.
public function get customMessageStyleName():String
public function set customMessageStyleName(value:String):void
See also
gap | property |
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
.
public function get gap():Number
public function set gap(value:Number):void
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all Alert
components.
The default value is null
.
See also
headerHeader | property |
icon | property |
icon:DisplayObject
The alert's optional icon content to display next to the text.
public function get icon():DisplayObject
public function set icon(value:DisplayObject):void
message | property |
message:String
The alert's main text content.
public function get message():String
public function set message(value:String):void
messageFactory | property |
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
.
public function get messageFactory():Function
public function set messageFactory(value:Function):void
See also
messageName | property |
messageName:String
DEPRECATED: Replaced by messageStyleName
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
protected function get messageName():String
protected function set messageName(value:String):void
See also
messageProperties | property |
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
.
public function get messageProperties():Object
public function set messageProperties(value:Object):void
See also
messageStyleName | property |
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
messageTextRenderer | property |
protected var messageTextRenderer:ITextRenderer
The message text renderer sub-component.
For internal use in subclasses.
overlayFactory | property |
public static var overlayFactory:Function
Returns an overlay to display with a alert that is modal. Uses the
standard overlayFactory
of the PopUpManager
by default, but you can use this property to provide your own custom
overlay, if you prefer.
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; };
See also
Alert | () | Constructor |
public function Alert()
Constructor.
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.
Alert |
See also
show | () | method |
public static function show(message:String, title:String = null, buttons:ListCollection = 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 ListCollection( [ { label: "OK" } ]); }
Parameters
message:String | |
title:String (default = null )
| |
buttons:ListCollection (default = null )
| |
icon:DisplayObject (default = null )
| |
isModal:Boolean (default = true )
| |
isCentered:Boolean (default = true )
| |
customAlertFactory:Function (default = null )
| |
customOverlayFactory:Function (default = null )
|
Alert |
close | Event |
starling.events.Event
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:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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. |
DEFAULT_CHILD_NAME_BUTTON_GROUP | Constant |
public static const DEFAULT_CHILD_NAME_BUTTON_GROUP:String = feathers-alert-button-group
DEPRECATED: Replaced by Alert.DEFAULT_CHILD_STYLE_NAME_BUTTON_GROUP
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
See also
DEFAULT_CHILD_NAME_HEADER | Constant |
public static const DEFAULT_CHILD_NAME_HEADER:String = feathers-alert-header
DEPRECATED: Replaced by Alert.DEFAULT_CHILD_STYLE_NAME_HEADER
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
See also
DEFAULT_CHILD_NAME_MESSAGE | Constant |
public static const DEFAULT_CHILD_NAME_MESSAGE:String = feathers-alert-message
DEPRECATED: Replaced by Alert.DEFAULT_CHILD_STYLE_NAME_MESSAGE
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
See also
DEFAULT_CHILD_STYLE_NAME_BUTTON_GROUP | Constant |
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_HEADER | Constant |
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_MESSAGE | Constant |
public static const DEFAULT_CHILD_STYLE_NAME_MESSAGE:String = feathers-alert-message
The default value added to the styleNameList
of the message.
See also