Packagefeathers.controls
Interfacepublic interface IScrollContainer extends IFeathersControl, IValidating, IMeasureDisplayObject, IFeathersDisplayObject, IFeathersDisplayObject
Implementors ScrollContainer

Product Version : Feathers 1.3.0

Defines functions for a Scroller subclass that delegates display list manipulations to its IViewPort.

Mainly intended for ScrollContainer, but other subclasses of Scroller could possibly implement it too.

See also

feathers.controls.Scroller
feathers.controls.ScrollContainer


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the display object.
IFeathersDisplayObject
 Inheritedbase : DisplayObject
[read-only] The top-most object of the display tree that the display object is connected to.
IFeathersDisplayObject
 InheritedblendMode : String
The blend mode used when rendering the display object.
IFeathersDisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the display object in its local coordinate space.
IFeathersDisplayObject
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
IValidating
 InheritedeffectsSuspended : Boolean
[read-only] Indicates if effects have been suspended.
IFeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
IMeasureDisplayObject
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
IMeasureDisplayObject
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
IMeasureDisplayObject
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
IMeasureDisplayObject
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
IMeasureDisplayObject
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
IMeasureDisplayObject
 Inheritedfilter : FragmentFilter
The filter used when rendering the display object.
IFeathersDisplayObject
 Inheritedheight : Number
The height of the display object in the parent's coordinate space.
IFeathersDisplayObject
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
IFeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
IFeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
IFeathersControl
 Inheritedmask : DisplayObject
The display object's mask.
IFeathersDisplayObject
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 Inheritedname : String
The name of the display object.
IFeathersDisplayObject
  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.
IScrollContainer
 Inheritedparent : DisplayObjectContainer
[read-only] The display object's parent, or null if it doesn't have a parent.
IFeathersDisplayObject
 InheritedpivotX : Number
The x coordinate of the display object's origin in its own coordinate space.
IFeathersDisplayObject
 InheritedpivotY : Number
The y coordinate of the display object's origin in its own coordinate space.
IFeathersDisplayObject
 Inheritedroot : DisplayObject
[read-only]
IFeathersDisplayObject
 Inheritedrotation : Number
The rotation of the display object, in radians.
IFeathersDisplayObject
 InheritedscaleX : Number
This horizontal scale factor.
IFeathersDisplayObject
 InheritedscaleY : Number
The vertical scale factor.
IFeathersDisplayObject
 InheritedskewX : Number
The horizontal skew, in radians.
IFeathersDisplayObject
 InheritedskewY : Number
The vertical skew, in radians.
IFeathersDisplayObject
 Inheritedstage : Stage
[read-only] The stage that the display object is connected to, or null if it is not connected to a stage.
IFeathersDisplayObject
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
IFeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
IFeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
IFeathersControl
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
IFeathersControl
 Inheritedtouchable : Boolean
Determines if the display object may be touched.
IFeathersDisplayObject
 InheritedtransformationMatrix : Matrix
[read-only] The transformation matrix of the display object, relative to its parent.
IFeathersDisplayObject
 InheriteduseHandCursor : Boolean
Determines if the mouse cursor should turn into a hand when the mouse is over the display object.
IFeathersDisplayObject
 Inheritedvisible : Boolean
Determines the visibility of the display object.
IFeathersDisplayObject
 Inheritedwidth : Number
The width of the display object in the parent's coordinate space.
IFeathersDisplayObject
 Inheritedx : Number
The x, or horizontal, position of the display object in the parent's coordinate space.
IFeathersDisplayObject
 Inheritedy : Number
The y, or vertical, position of the display object in the parent's coordinate space.
IFeathersDisplayObject
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function):void
Adds a listener for an event type.
IFeathersEventDispatcher
  
addRawChild(child:DisplayObject):DisplayObject
Adds a child to the Scroller rather than delegating the call to the view port.
IScrollContainer
  
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.
IScrollContainer
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type.
IFeathersEventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event from the pool with the specified to all listeners for the specified event type.
IFeathersEventDispatcher
 Inherited
dispose():void
Disposes the display object.
IFeathersDisplayObject
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
Gets the display object's bounds in the target coordinate space.
IFeathersDisplayObject
  
getRawChildAt(index:int):DisplayObject
Gets the direct child of the Scroller at a specific index rather than delegating the call to the view port.
IScrollContainer
  
getRawChildByName(name:String):DisplayObject
Gets the name of a direct child of the Scroller rather than delegating the call to the view port.
IScrollContainer
  
getRawChildIndex(child:DisplayObject):int
Gets the index of a direct child of the Scroller rather than delegating the call to the view port.
IScrollContainer
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Calculates a transformation matrix to convert values from the display object's coordinate space to a target coordinate space.
IFeathersDisplayObject
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Converts a point from the stage's coordinate space to the display object's coordinate space.
IFeathersDisplayObject
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type.
IFeathersEventDispatcher
 Inherited
hitTest(localPoint:Point):DisplayObject
Determines if a point exists within the display object's bounds.
IFeathersDisplayObject
 Inherited
If the component has not yet initialized, initializes immediately.
IFeathersControl
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Converts a point from the display object's coordinate space to the stage's coordinate space.
IFeathersDisplayObject
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
IFeathersControl
 Inherited
removeEventListener(type:String, listener:Function):void
Removes a listener for an event type.
IFeathersEventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all listeners for an event type.
IFeathersEventDispatcher
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes a display object from its parent.
IFeathersDisplayObject
  
removeRawChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the Scroller rather than delegating the call to the view port.
IScrollContainer
  
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.
IScrollContainer
 Inherited
render(painter:Painter):void
Renders the display object.
IFeathersDisplayObject
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
IFeathersControl
 Inherited
Indicates that effects should be re-activated after being suspended.
IFeathersControl
  
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.
IScrollContainer
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
IFeathersControl
  
sortRawChildren(compareFunction:Function):void
Sorts the children of the Scroller rather than delegating the call to the view port.
IScrollContainer
 Inherited
Indicates that effects should not be activated temporarily.
IFeathersControl
  
swapRawChildren(child1:DisplayObject, child2:DisplayObject):void
Swaps the children of the Scroller rather than delegating the call to the view port.
IScrollContainer
  
swapRawChildrenAt(index1:int, index2:int):void
Swaps the children of the Scroller rather than delegating the call to the view port.
IScrollContainer
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
IValidating
Property Detail
numRawChildrenproperty
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.


Implementation
    public function get numRawChildren():int
Method Detail
addRawChild()method
public function addRawChild(child:DisplayObject):DisplayObject

Adds a child to the Scroller rather than delegating the call to the view port.

Parameters

child:DisplayObject

Returns
DisplayObject
addRawChildAt()method 
public function 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.

Parameters

child:DisplayObject
 
index:int

Returns
DisplayObject
getRawChildAt()method 
public function getRawChildAt(index:int):DisplayObject

Gets the direct child of the Scroller at a specific index rather than delegating the call to the view port.

Parameters

index:int

Returns
DisplayObject
getRawChildByName()method 
public function getRawChildByName(name:String):DisplayObject

Gets the name of a direct child of the Scroller rather than delegating the call to the view port.

Parameters

name:String

Returns
DisplayObject
getRawChildIndex()method 
public function getRawChildIndex(child:DisplayObject):int

Gets the index of a direct child of the Scroller rather than delegating the call to the view port.

Parameters

child:DisplayObject

Returns
int
removeRawChild()method 
public function removeRawChild(child:DisplayObject, dispose:Boolean = false):DisplayObject

Removes a child from the Scroller rather than delegating the call to the view port.

Parameters

child:DisplayObject
 
dispose:Boolean (default = false)

Returns
DisplayObject
removeRawChildAt()method 
public function 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.

Parameters

index:int
 
dispose:Boolean (default = false)

Returns
DisplayObject
setRawChildIndex()method 
public function 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.

Parameters

child:DisplayObject
 
index:int

sortRawChildren()method 
public function sortRawChildren(compareFunction:Function):void

Sorts the children of the Scroller rather than delegating the call to the view port.

Parameters

compareFunction:Function

swapRawChildren()method 
public function swapRawChildren(child1:DisplayObject, child2:DisplayObject):void

Swaps the children of the Scroller rather than delegating the call to the view port.

Parameters

child1:DisplayObject
 
child2:DisplayObject

swapRawChildrenAt()method 
public function swapRawChildrenAt(index1:int, index2:int):void

Swaps the children of the Scroller rather than delegating the call to the view port.

Parameters

index1:int
 
index2:int