Packagefeathers.controls
Classpublic class PanelScreen
InheritancePanelScreen Inheritance Panel Inheritance ScrollContainer Inheritance Scroller Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IScreen

A screen for use with ScreenNavigator, based on Panel in order to provide a header and layout.

This component is generally not instantiated directly. Instead it is typically used as a super class for concrete implementations of screens. With that in mind, no code example is included here.

The following example provides a basic framework for a new panel screen:

     package
     {
         import feathers.controls.PanelScreen;
         
         public class CustomScreen extends PanelScreen
         {
             public function CustomScreen()
             {
                 super();
             }
             
             override protected function initialize():void
             {
                 //runs once when screen is first added to the stage
                 //a good place to add children and customize the layout
                 
                 //don't forget to call this!
                 super.initialize()
             }
         }
     }

See also

How to use the Feathers PanelScreen component
feathers.controls.StackScreenNavigator
feathers.controls.ScreenNavigator


Public Properties
 PropertyDefined By
 InheritedautoHideBackground : 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
 InheritedautoSizeMode : String
Determines how the container will set its own size when its dimensions (width and height) aren't set explicitly.
ScrollContainer
 InheritedbackgroundDisabledSkin : DisplayObject
A background to display when the container is disabled.
Scroller
 InheritedbackgroundSkin : DisplayObject
The default background to display.
Scroller
 InheritedclipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds.
Scroller
 InheritedcustomFooterName : String
DEPRECATED: Replaced by customFooterStyleName.
Panel
 InheritedcustomFooterStyleName : String
A style name to add to the panel's footer sub-component.
Panel
 InheritedcustomHeaderName : String
DEPRECATED: Replaced by customHeaderStyleName.
Panel
 InheritedcustomHeaderStyleName : String
A style name to add to the panel's header sub-component.
Panel
 InheritedcustomHorizontalScrollBarName : String
DEPRECATED: Replaced by customHorizontalScrollBarName.
Scroller
 InheritedcustomHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar sub-component.
Scroller
 InheritedcustomVerticalScrollBarName : String
DEPRECATED: Replaced by customVerticalScrollBarStyleName.
Scroller
 InheritedcustomVerticalScrollBarStyleName : String
A style name to add to the container's vertical scroll bar sub-component.
Scroller
 InheriteddecelerationRate : Number
This value is used to decelerate the scroller when "thrown".
Scroller
 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
 Inheritedelasticity : 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
 InheritedelasticSnapDuration : 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
 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
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
 InheritedfooterFactory : Function
A function used to generate the panel's footer sub-component.
Panel
 InheritedfooterProperties : Object
An object that stores properties for the container's footer sub-component, and the properties will be passed down to the footer when the container validates.
Panel
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all PanelScreen components.
PanelScreen
 InheritedhasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport.
Scroller
 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
 InheritedhideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades out.
Scroller
 InheritedhideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable.
Scroller
 InheritedhorizontalPageCount : int
[read-only] The number of horizontal pages, if snapping is enabled.
Scroller
 InheritedhorizontalPageIndex : int
[read-only] 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
 InheritedinteractionMode : String
Determines how the user may interact with the scroller.
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
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisScrolling : Boolean
[read-only] Determines if the scroller is currently scrolling with user interaction or with animation.
Scroller
 Inheritedlayout : ILayout
Controls the way that the container's children are positioned and sized.
ScrollContainer
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
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
 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
 InheritedmouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.
Scroller
 InheritednextTabFocus : IFocusDisplayObject
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
 InheritedouterPadding : Number
Quickly sets all outer padding properties to the same value.
Panel
 InheritedouterPaddingBottom : Number
The minimum space, in pixels, between the panel's bottom edge and the panel's footer.
Panel
 InheritedouterPaddingLeft : Number
The minimum space, in pixels, between the panel's left edge and the panel's header, middle content, and footer.
Panel
 InheritedouterPaddingRight : Number
The minimum space, in pixels, between the panel's right edge and the panel's header, middle content, and footer.
Panel
 InheritedouterPaddingTop : Number
The minimum space, in pixels, between the panel's top edge and the panel's header.
Panel
  owner : Object
The screen navigator that is currently displaying this screen.
PanelScreen
 Inheritedpadding : Number
Quickly sets all padding properties to the same value.
Scroller
 InheritedpaddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and the container's content.
Scroller
 InheritedpaddingLeft : Number
The minimum space, in pixels, between the container's left edge and the container's content.
Scroller
 InheritedpaddingRight : Number
The minimum space, in pixels, between the container's right edge and the container's content.
Scroller
 InheritedpaddingTop : Number
The minimum space, in pixels, between the container's top edge and the container's content.
Scroller
 InheritedpageHeight : Number
When set, the vertical pages snap to this height value instead of the height of the scroller.
Scroller
 InheritedpageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is thrown to a page.
Scroller
 InheritedpageWidth : Number
When set, the horizontal pages snap to this width value instead of the width of the scroller.
Scroller
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
 InheritedrevealScrollBarsDuration : Number
The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars()
Scroller
  screenID : String
The identifier for the screen.
PanelScreen
 InheritedscrollBarDisplayMode : String
Determines how the scroll bars are displayed.
Scroller
 InheritedsnapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole pixels.
Scroller
 InheritedsnapToPages : Boolean
Determines if scrolling will snap to the nearest page.
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
 InheritedthrowEase : Object
The easing function used for "throw" animations.
Scroller
 InheritedthrowElasticity : 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
 Inheritedtitle : String
The panel's title to display in the header.
Panel
 InheriteduseFixedThrowDuration : Boolean
If true, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity.
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
[read-only] The index of the vertical page, if snapping is enabled.
Scroller
 InheritedverticalScrollBarFactory : Function
Creates the vertical scroll bar.
Scroller
 InheritedverticalScrollBarPosition : String
Determines where the vertical scroll bar will be positioned.
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
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
  backButtonHandler : Function
Optional callback for the back hardware key.
PanelScreen
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider 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
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
 Inheritedfooter : IFeathersControl
The footer sub-component.
Panel
 InheritedfooterName : String
DEPRECATED: Replaced by footerStyleName.
Panel
 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
 InheritedheaderName : String
DEPRECATED: Replaced by headerStyleName.
Panel
 InheritedheaderStyleName : String = feathers-panel-header
The default value added to the styleNameList of the header.
Panel
 InheritedhorizontalScrollBar : IScrollBar
The horizontal scrollbar instance.
Scroller
 InheritedhorizontalScrollBarName : String
DEPRECATED: Replaced by horizontalScrollBarStyleName.
Scroller
 InheritedhorizontalScrollBarStyleName : String = feathers-scroller-horizontal-scroll-bar
The value added to the styleNameList of the horizontal scroll bar.
Scroller
  menuButtonHandler : Function
Optional callback for the menu hardware key.
PanelScreen
 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
  searchButtonHandler : Function
Optional callback for the search hardware key.
PanelScreen
 InheritedverticalScrollBar : IScrollBar
The vertical scrollbar instance.
Scroller
 InheritedverticalScrollBarName : String
DEPRECATED: Replaced by verticalScrollBarStyleName.
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.
PanelScreen
 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
 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
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
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
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
 Inherited
showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
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
 Inherited
Creates and adds the footer sub-component and removes the old instance, if one exists.
Panel
 Inherited
Creates and adds the header sub-component and removes the old instance, if one exists.
Panel
 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
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
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
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 INTERACTION_MODE_TOUCH is enabled or when the user starts interacting with the scroll bar.Scroller
 InheritedDispatched when the container is scrolled.ScrollContainer
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched when the user stops dragging the scroller when INTERACTION_MODE_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
  Dispatched when the transition animation finishes as the screen is shown by the screen navigator.PanelScreen
  Dispatched when the transition animation begins as the screen is shown by the screen navigator.PanelScreen
  Dispatched when the transition animation finishes as a different screen is shown by the screen navigator and this screen is hidden.PanelScreen
  Dispatched when the transition animation begins as a different screen is shown by the screen navigator and this screen is hidden.PanelScreen
Public Constants
 ConstantDefined By
 InheritedALTERNATE_NAME_TOOLBAR : String = feathers-toolbar-scroll-container
[static] DEPRECATED: Replaced by ScrollContainer.ALTERNATE_STYLE_NAME_TOOLBAR.
ScrollContainer
 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
  AUTO_SIZE_MODE_CONTENT : String = content
[static] The container will auto size itself to fit its content.
PanelScreen
  AUTO_SIZE_MODE_STAGE : String = stage
[static] The container will auto size itself to fill the entire stage.
PanelScreen
  DECELERATION_RATE_FAST : Number = 0.99
[static] Decelerates a bit faster per millisecond than the default.
PanelScreen
  DECELERATION_RATE_NORMAL : Number = 0.998
[static] The default deceleration rate per millisecond.
PanelScreen
 InheritedDEFAULT_CHILD_NAME_FOOTER : String = feathers-panel-footer
[static] DEPRECATED: Replaced by Panel.DEFAULT_CHILD_STYLE_NAME_FOOTER.
Panel
  DEFAULT_CHILD_NAME_HEADER : String = feathers-panel-screen-header
[static] DEPRECATED: Replaced by PanelScreen.DEFAULT_CHILD_STYLE_NAME_HEADER.
PanelScreen
 InheritedDEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar
[static] DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR.
Scroller
 InheritedDEFAULT_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_FOOTER : String = feathers-panel-screen-footer
[static] The default value added to the styleNameList of the footer.
PanelScreen
  DEFAULT_CHILD_STYLE_NAME_HEADER : String = feathers-panel-screen-header
[static] The default value added to the styleNameList of the header.
PanelScreen
 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
 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
  INTERACTION_MODE_MOUSE : String = mouse
[static] The user may only interact with the scroll bars to scroll.
PanelScreen
  INTERACTION_MODE_TOUCH : String = touch
[static] The user may touch anywhere on the scroller and drag to scroll.
PanelScreen
  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.
PanelScreen
 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
  MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL : String = horizontal
[static] The scroller will scroll horizontally when the mouse wheel is scrolled.
PanelScreen
  MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL : String = vertical
[static] The scroller will scroll vertically when the mouse wheel is scrolled.
PanelScreen
  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.
PanelScreen
 InheritedSCROLL_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.
PanelScreen
  SCROLL_BAR_DISPLAY_MODE_NONE : String = none
[static] The scroll bars are never visible.
PanelScreen
  SCROLL_POLICY_AUTO : String = auto
[static] The scroller may scroll if the view port is larger than the scroller's bounds.
PanelScreen
  SCROLL_POLICY_OFF : String = off
[static] The scroller does not scroll at all.
PanelScreen
  SCROLL_POLICY_ON : String = on
[static] The scroller will always scroll.
PanelScreen
  VERTICAL_SCROLL_BAR_POSITION_LEFT : String = left
[static] The vertical scroll bar will be positioned on the left.
PanelScreen
  VERTICAL_SCROLL_BAR_POSITION_RIGHT : String = right
[static] The vertical scroll bar will be positioned on the right.
PanelScreen
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = clipping
[static] Flag to indicate that the clipping has changed.
Scroller
Property Detail
backButtonHandlerproperty
protected var backButtonHandler:Function

Optional callback for the back hardware key. Automatically handles keyboard events to cancel the default behavior.

This function has the following signature:

function():void

In the following example, a function will dispatch Event.COMPLETE when the back button is pressed:

         this.backButtonHandler = onBackButton;
                  private function onBackButton():void
         {
             this.dispatchEvent( Event.COMPLETE );
         };

The default value is null.

globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all PanelScreen components.

The default value is null.

See also

menuButtonHandlerproperty 
protected var menuButtonHandler:Function

Optional callback for the menu hardware key. Automatically handles keyboard events to cancel the default behavior.

This function has the following signature:

function():void

In the following example, a function will be called when the menu button is pressed:

         this.menuButtonHandler = onMenuButton;
                  private function onMenuButton():void
         {
             //do something with the menu button
         };

The default value is null.

ownerproperty 
owner:Object

The screen navigator that is currently displaying this screen.


Implementation
    public function get owner():Object
    public function set owner(value:Object):void
screenIDproperty 
screenID:String

The identifier for the screen. This value is passed in by the ScreenNavigator when the screen is instantiated.


Implementation
    public function get screenID():String
    public function set screenID(value:String):void
searchButtonHandlerproperty 
protected var searchButtonHandler:Function

Optional callback for the search hardware key. Automatically handles keyboard events to cancel the default behavior.

This function has the following signature:

function():void

In the following example, a function will be called when the search button is pressed:

         this.searchButtonHandler = onSearchButton;
                  private function onSearchButton():void
         {
             //do something with the search button
         };

The default value is null.

Constructor Detail
PanelScreen()Constructor
public function PanelScreen()

Constructor.

Event Detail
transitionInComplete Event
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.TRANSITION_IN_COMPLETE

Dispatched when the transition animation finishes as the screen is shown by the screen navigator.

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.

The FeathersEventType.TRANSITION_IN_COMPLETE event type is used by the ScreenNavigator to indicate to a new screen when it has completed transitioning in.
transitionInStart Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.TRANSITION_IN_START

Dispatched when the transition animation begins as the screen is shown by the screen navigator.

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.

The FeathersEventType.TRANSITION_IN_START event type is used by the ScreenNavigator to indicate to a new screen when it begins to transition in.
transitionOutComplete Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.TRANSITION_OUT_COMPLETE

Dispatched when the transition animation finishes as a different screen is shown by the screen navigator and this screen is hidden.

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.

The FeathersEventType.TRANSITION_OUT_COMPLETE event type is used by the ScreenNavigator to indicate to an existing screen when it has completed transitioning out.
transitionOutStart Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.TRANSITION_OUT_START

Dispatched when the transition animation begins as a different screen is shown by the screen navigator and this screen is hidden.

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.

The FeathersEventType.TRANSITION_OUT_START event type is used by the ScreenNavigator to indicate to an existing screen when it begins to transition out.
Constant Detail
AUTO_SIZE_MODE_CONTENTConstant
public static const AUTO_SIZE_MODE_CONTENT:String = content

The container will auto size itself to fit its content.

See also

AUTO_SIZE_MODE_STAGEConstant 
public static const AUTO_SIZE_MODE_STAGE:String = stage

The container will auto size itself to fill the entire stage.

See also

DECELERATION_RATE_FASTConstant 
public static const DECELERATION_RATE_FAST:Number = 0.99

Decelerates a bit faster per millisecond than the default.

See also

DECELERATION_RATE_NORMALConstant 
public static const DECELERATION_RATE_NORMAL:Number = 0.998

The default deceleration rate per millisecond.

See also

DEFAULT_CHILD_NAME_HEADERConstant 
public static const DEFAULT_CHILD_NAME_HEADER:String = feathers-panel-screen-header

DEPRECATED: Replaced by PanelScreen.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_STYLE_NAME_FOOTERConstant 
public static const DEFAULT_CHILD_STYLE_NAME_FOOTER:String = feathers-panel-screen-footer

The default value added to the styleNameList of the footer.

See also

DEFAULT_CHILD_STYLE_NAME_HEADERConstant 
public static const DEFAULT_CHILD_STYLE_NAME_HEADER:String = feathers-panel-screen-header

The default value added to the styleNameList of the header.

See also

INTERACTION_MODE_MOUSEConstant 
public static const INTERACTION_MODE_MOUSE:String = mouse

The user may only interact with the scroll bars to scroll. The user cannot touch anywhere in the scroller's content and drag like a touch interface.

See also

INTERACTION_MODE_TOUCHConstant 
public static const INTERACTION_MODE_TOUCH:String = touch

The user may touch anywhere on the scroller and drag to scroll. The scroll bars will be visual indicator of position, but they will not be interactive.

See also

INTERACTION_MODE_TOUCH_AND_SCROLL_BARSConstant 
public static const INTERACTION_MODE_TOUCH_AND_SCROLL_BARS:String = touchAndScrollBars

The user may touch anywhere on the scroller and drag to scroll, and the scroll bars may be dragged separately. For most touch interfaces, this is not a common behavior. The scroll bar on touch interfaces is often simply a visual indicator and non-interactive.

One case where this mode might be used is a "scroll bar" that displays a tappable alphabetical index to navigate a GroupedList with alphabetical categories.

See also

MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTALConstant 
public static const MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL:String = horizontal

The scroller will scroll horizontally when the mouse wheel is scrolled.

See also

MOUSE_WHEEL_SCROLL_DIRECTION_VERTICALConstant 
public static const MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL:String = vertical

The scroller will scroll vertically when the mouse wheel is scrolled.

See also

SCROLL_BAR_DISPLAY_MODE_FIXEDConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FIXED:String = fixed

The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.

See also

SCROLL_BAR_DISPLAY_MODE_FLOATConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FLOAT:String = float

The scroll bars appear above the scroller's view port, overlapping the content, and they fade out when not in use.

See also

SCROLL_BAR_DISPLAY_MODE_NONEConstant 
public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = none

The scroll bars are never visible.

See also

SCROLL_POLICY_AUTOConstant 
public static const SCROLL_POLICY_AUTO:String = auto

The scroller may scroll if the view port is larger than the scroller's bounds. If the interaction mode is touch, the elastic edges will only be active if the maximum scroll position is greater than zero. If the scroll bar display mode is fixed, the scroll bar will only be visible when the maximum scroll position is greater than zero.

See also

SCROLL_POLICY_OFFConstant 
public static const SCROLL_POLICY_OFF:String = off

The scroller does not scroll at all. If the scroll bar display mode is fixed or float, the scroll bar will never be visible.

See also

SCROLL_POLICY_ONConstant 
public static const SCROLL_POLICY_ON:String = on

The scroller will always scroll. If the interaction mode is touch, elastic edges will always be active, even when the maximum scroll position is zero. If the scroll bar display mode is fixed, the scroll bar will always be visible.

See also

VERTICAL_SCROLL_BAR_POSITION_LEFTConstant 
public static const VERTICAL_SCROLL_BAR_POSITION_LEFT:String = left

The vertical scroll bar will be positioned on the left.

See also

VERTICAL_SCROLL_BAR_POSITION_RIGHTConstant 
public static const VERTICAL_SCROLL_BAR_POSITION_RIGHT:String = right

The vertical scroll bar will be positioned on the right.

See also