| Package | feathers.controls |
| Class | public class PanelScreen |
| Inheritance | PanelScreen  Panel ScrollContainer Scroller FeathersControl starling.display.Sprite |
| Implements | IScreen |
| Product Version : | Feathers 1.1.0 |
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
| Property | Defined By | ||
|---|---|---|---|
 | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
| autoSizeMode : String
Determines how the container will set its own size when its
dimensions (width and height) aren't set explicitly. | ScrollContainer | |
| bottomPullView : DisplayObject
A view that is displayed at the bottom of the scroller's view port
when dragging up. | Scroller | |
| bottomPullViewDisplayMode : String
Indicates whether the bottom pull view may be dragged with the
content, or if its position is fixed to the edge of the scroller. | Scroller | |
| defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
| defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
| depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
| effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
| explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
| explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
| explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
| explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
| explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
| explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
| 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 | |
| focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
| focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
| focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
| focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
| footerFactory : Function
A function used to generate the panel's footer sub-component. | Panel | |
| footerProperties : 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 | ||
| 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 | |
| hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
| horizontalPageCount : int [read-only]
The number of horizontal pages, if snapping is enabled. | Scroller | |
| horizontalPageIndex : int
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 | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isBottomPullViewActive : Boolean
Indicates if the bottomPullView has been activated. | 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
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isLeftPullViewActive : Boolean
Indicates if the leftPullView has been activated. | Scroller | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| isRightPullViewActive : Boolean
Indicates if the rightPullView has been activated. | Scroller | |
| isScrolling : Boolean [read-only]
Determines if the scroller is currently scrolling with user
interaction or with animation. | Scroller | |
| isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
| isTopPullViewActive : Boolean
Indicates if the topPullView has been activated. | Scroller | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| leftPullView : DisplayObject
A view that is displayed to the left of the scroller's view port
when dragging to the right. | Scroller | |
| leftPullViewDisplayMode : String
Indicates whether the left pull view may be dragged with the content,
or if its position is fixed to the edge of the scroller. | Scroller | |
| maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| 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 | |
| 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 | |
| moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
| nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
| nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| 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 | |
| owner : Object
The screen navigator that is currently displaying this screen. | PanelScreen | ||
| pageHeight : Number
When set, the vertical pages snap to this height value instead of
the height of the scroller. | Scroller | |
| pageWidth : Number
When set, the horizontal pages snap to this width value instead of
the width of the scroller. | Scroller | |
| previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
| resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
| rightPullView : DisplayObject
A view that is displayed to the right of the scroller's view port
when dragging to the left. | Scroller | |
| rightPullViewDisplayMode : String
Indicates whether the right pull view may be dragged with the
content, or if its position is fixed to the edge of the scroller. | Scroller | |
| screenID : String
The identifier for the screen. | PanelScreen | ||
| showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
| styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
| styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
| styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
| title : String
The panel's title to display in the header. | Panel | |
| toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
| topPullView : DisplayObject
A view that is displayed at the top of the scroller's view port when
dragging down. | Scroller | |
| topPullViewDisplayMode : String
Indicates whether the top pull view may be dragged with the content,
or if its position is fixed to the edge of the scroller. | Scroller | |
| 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
The index of the vertical page, if snapping is enabled. | Scroller | |
| verticalScrollBarFactory : Function
Creates the vertical scroll bar. | 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 | |
| actualMinHeight : Number = 0
The final minimum height value that should be used for layout. | FeathersControl | |
| actualMinWidth : Number = 0
The final minimum width value that should be used for layout. | FeathersControl | |
| actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
| backButtonHandler : Function
Optional callback for the back hardware key. | PanelScreen | ||
| defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
styleProvider 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 | |
| footer : IFeathersControl
The footer sub-component. | 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 | |
| headerStyleName : String = "feathers-panel-header"
The default value added to the styleNameList of the
header. | Panel | |
| horizontalScrollBar : IScrollBar
The horizontal scrollbar instance. | Scroller | |
| horizontalScrollBarStyleName : 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 | ||
| 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 | |
| searchButtonHandler : Function
Optional callback for the search hardware key. | PanelScreen | ||
| verticalScrollBar : IScrollBar
The vertical scrollbar instance. | Scroller | |
| verticalScrollBarStyleName : String = "feathers-scroller-vertical-scroll-bar"
The value added to the styleNameList of the vertical
scroll bar. | Scroller | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | PanelScreen | ||
| 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 | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
| 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
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
| initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
| readjustLayout():void
Readjusts the layout of the container according to its current
content. | ScrollContainer | |
| removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
| 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 | |
| resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
| resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
| 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 | |
| showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| 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 | |
| suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
| 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 | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the user starts dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user starts interacting with the scroll bar. | Scroller | ||
| Dispatched after the component has validated for the first time. | FeathersControl | ||
| Dispatched when the user stops dragging the scroller when ScrollInteractionMode.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 | ||
| 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 | |||
| Dispatched when a pull view is activated. | Scroller | ||
| Constant | Defined By | ||
|---|---|---|---|
| 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 | |
| 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 | ||
| 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_VERTICAL_SCROLL_BAR : String = "feathers-scroller-vertical-scroll-bar" [static]
The default value added to the styleNameList of the vertical
scroll bar. | Scroller | |
| 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 | |
| backButtonHandler | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var backButtonHandler:FunctionOptional 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.
| globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider for all PanelScreen
components.
The default value is null.
See also
| menuButtonHandler | property |
protected var menuButtonHandler:FunctionOptional 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.
| owner | property |
owner:ObjectThe screen navigator that is currently displaying this screen.
public function get owner():Object public function set owner(value:Object):void| screenID | property |
screenID:String
The identifier for the screen. This value is passed in by the
ScreenNavigator when the screen is instantiated.
public function get screenID():String public function set screenID(value:String):void| searchButtonHandler | property |
protected var searchButtonHandler:FunctionOptional 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.
| PanelScreen | () | Constructor |
public function PanelScreen()Constructor.
| transitionInComplete | Event |
starling.events.Eventfeathers.events.FeathersEventType.TRANSITION_IN_COMPLETEDispatched when the transition animation finishes as the screen is shown by the screen navigator.
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. |
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 |
starling.events.Eventfeathers.events.FeathersEventType.TRANSITION_IN_STARTDispatched when the transition animation begins as the screen is shown by the screen navigator.
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. |
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 |
starling.events.Eventfeathers.events.FeathersEventType.TRANSITION_OUT_COMPLETEDispatched 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:
| 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. |
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 |
starling.events.Eventfeathers.events.FeathersEventType.TRANSITION_OUT_STARTDispatched 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:
| 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. |
FeathersEventType.TRANSITION_OUT_START event type is
used by the ScreenNavigator to indicate to an existing
screen when it begins to transition out.
| DEFAULT_CHILD_STYLE_NAME_FOOTER | Constant |
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_HEADER | Constant |
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