| Package | feathers.controls |
| Class | public class Screen |
| Inheritance | Screen  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | IScreen |
| Subclasses | ScreenBase |
ScreenNavigator.
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipRect : Rectangle [override] | FeathersControl | |
| 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 | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| 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 | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
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 | |
| 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 | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| originalDPI : int
The original intended DPI of the application. | Screen | ||
| originalHeight : Number
The original intended height of the application. | Screen | ||
| originalWidth : Number
The original intended width of the application. | Screen | ||
| owner : ScreenNavigator
The ScreenNavigator that is displaying this screen. | Screen | ||
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| screenID : String
The identifier for the screen. | Screen | ||
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| 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 | ||
| dpiScale : Number [read-only]
Uses originalDPI and DeviceCapabilities.dpi
to calculate a scale value to allow all content to be the same
physical size (in inches). | Screen | ||
| 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 | |
| menuButtonHandler : Function
Optional callback for the menu hardware key. | Screen | ||
| pixelScale : Number [read-only]
Uses originalWidth, originalHeight,
actualWidth, and actualHeight,
to calculate a scale value that will allow all content will fit
within the current stage bounds using the same relative layout. | Screen | ||
| searchButtonHandler : Function
Optional callback for the search hardware key. | Screen | ||
| Method | Defined By | ||
|---|---|---|---|
Screen()
Constructor. | Screen | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| 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 | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | 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.
| dpiScale | property |
dpiScale:Number [read-only]
Uses originalDPI and DeviceCapabilities.dpi
to calculate a scale value to allow all content to be the same
physical size (in inches). Using this value will have a much larger
effect on the layout of the content, but it can ensure that
interactive items won't be scaled too small to affect the accuracy
of touches. Likewise, it won't scale items to become ridiculously
physically large. Most useful when targeting many different platforms
with the same code.
protected function get dpiScale():Number| menuButtonHandler | property |
protected var menuButtonHandler:FunctionOptional callback for the menu hardware key. Automatically handles keyboard events to cancel the default behavior.
| originalDPI | property |
originalDPI:intThe original intended DPI of the application. This value cannot be automatically detected and it must be set manually.
public function get originalDPI():int public function set originalDPI(value:int):void| originalHeight | property |
originalHeight:Number
The original intended height of the application. If not set manually,
loaderInfo.height is automatically detected (to get
height value from [SWF] metadata.
public function get originalHeight():Number public function set originalHeight(value:Number):void| originalWidth | property |
originalWidth:Number
The original intended width of the application. If not set manually,
loaderInfo.width is automatically detected (to get
width value from [SWF] metadata.
public function get originalWidth():Number public function set originalWidth(value:Number):void| owner | property |
owner:ScreenNavigatorThe ScreenNavigator that is displaying this screen.
public function get owner():ScreenNavigator public function set owner(value:ScreenNavigator):void| pixelScale | property |
pixelScale:Number [read-only]
Uses originalWidth, originalHeight,
actualWidth, and actualHeight,
to calculate a scale value that will allow all content will fit
within the current stage bounds using the same relative layout. This
scale value does not account for differences between the original DPI
and the current device's DPI.
protected function get pixelScale():Number| 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.
| Screen | () | Constructor |
public function Screen()Constructor.