| Package | feathers.controls |
| Class | public class Screen |
| Inheritance | Screen  LayoutGroup FeathersControl starling.display.Sprite |
| Implements | IScreen |
| Product Version : | Feathers 1.0.0 |
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 | ||
|---|---|---|---|
 | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
| autoSizeMode : String
Determines how the layout group will set its own size when its
dimensions (width and height) aren't set explicitly. | 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 | |
| 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 | |
| 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 | |
| globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all Screen
components. | Screen | ||
| 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 | |
| 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
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 | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| 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 | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| 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 | |
| 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 | |
| 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 | |
| owner : Object
The screen navigator that is currently displaying this screen. | Screen | ||
| 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 | |
| screenID : String
The identifier for the screen. | Screen | ||
| 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 | |
| toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | 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 | |
| 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. | Screen | ||
| defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
styleProvider property is set to this value. | 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 | ||
| 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 | |
| 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 group according to its current content. | LayoutGroup | |
| removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
| 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 | |
| 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 | |
| suspendEffects():void
Indicates that effects should not be activated temporarily. | 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 | |||
| 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 Screen
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.
| Screen | () | Constructor |
public function Screen()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.