Package | feathers.controls |
Class | public class Screen |
Inheritance | Screen ![]() ![]() ![]() |
Implements | IScreen |
ScreenNavigator
. Provides
layout capabilities, but no scrolling.
The following example provides a basic framework for a new screen:
package { import feathers.controls.Screen; public class CustomScreen extends Screen { 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 | ||
---|---|---|---|
![]() | autoSizeMode : String
Determines how the layout group will set its own size when its
dimensions (width and height) aren't set explicitly. | LayoutGroup | |
![]() | backgroundDisabledSkin : DisplayObject
The background to display behind all content when the layout group is
disabled. | LayoutGroup | |
![]() | backgroundSkin : DisplayObject
The default background to display behind all content. | LayoutGroup | |
![]() | clipContent : Boolean
If true, the group will be clipped to its bounds. | LayoutGroup | |
![]() | 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 | |
![]() | 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 | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all Screen
components. | Screen | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | 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 | |
![]() | layout : ILayout
Controls the way that the group's children are positioned and sized. | LayoutGroup | |
![]() | 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 | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
owner : Object
The screen navigator that is currently displaying this screen. | Screen | ||
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
screenID : String
The identifier for the screen. | Screen | ||
![]() | 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 | |
![]() | 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 | |
backButtonHandler : Function
Optional callback for the back hardware key. | Screen | ||
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
globalStyleProvider property is set to this value. | FeathersControl | |
![]() | 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 | |
![]() | items : Vector.<DisplayObject>
The items added to the group. | LayoutGroup | |
menuButtonHandler : Function
Optional callback for the menu hardware key. | Screen | ||
searchButtonHandler : Function
Optional callback for the search hardware key. | Screen | ||
![]() | viewPortBounds : ViewPortBounds
The view port bounds result object passed to the layout. | LayoutGroup |
Method | Defined By | ||
---|---|---|---|
Screen()
Constructor. | Screen | ||
![]() | 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 group according to its current content. | LayoutGroup | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | 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 transition animation finishes as the screen is shown by the screen navigator. | Screen | |||
Dispatched when the transition animation begins as the screen is shown by the screen navigator. | Screen | |||
Dispatched when the transition animation finishes as a different screen is shown by the screen navigator and this screen is hidden. | Screen | |||
Dispatched when the transition animation begins as a different screen is shown by the screen navigator and this screen is hidden. | Screen |
Constant | Defined By | ||
---|---|---|---|
![]() | ALTERNATE_STYLE_NAME_TOOLBAR : String = feathers-toolbar-layout-group [static]
An alternate style name to use with LayoutGroup to
allow a theme to give it a toolbar style. | LayoutGroup | |
AUTO_SIZE_MODE_CONTENT : String = content [static]
The layout group will auto size itself to fit its content. | Screen | ||
AUTO_SIZE_MODE_STAGE : String = stage [static]
The layout group will auto size itself to fill the entire stage. | Screen | ||
![]() | 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 |
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
.
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all Screen
components.
The default value is null
.
See also
menuButtonHandler | property |
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
.
owner | property |
owner:Object
The 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: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
.
Screen | () | Constructor |
public function Screen()
Constructor.
transitionInComplete | Event |
starling.events.Event
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:
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.Event
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:
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.Event
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:
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.Event
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:
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.
AUTO_SIZE_MODE_CONTENT | Constant |
public static const AUTO_SIZE_MODE_CONTENT:String = content
The layout group will auto size itself to fit its content.
See also
AUTO_SIZE_MODE_STAGE | Constant |
public static const AUTO_SIZE_MODE_STAGE:String = stage
The layout group will auto size itself to fill the entire stage.
See also