| Package | feathers.extensions.canvas |
| Class | public class Canvas |
| Inheritance | Canvas  ScrollContainer Scroller FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
See also
| Property | Defined By | ||
|---|---|---|---|
 | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
| alpha : Number The opacity of the object. | DisplayObject | |
| autoSizeMode : String
Determines how the container will set its own size when its
dimensions (width and height) aren't set explicitly. | ScrollContainer | |
| 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 | |
| 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 | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| 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 | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| 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 ScrollContainer
components. | ScrollContainer | |
| graphics : CanvasDisplayObject [read-only]
The display object that contains the drawing methods. | Canvas | ||
| 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 | |
| is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
| 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 | |
| mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
| maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
| 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 | |
| name : String The name of the display object (default: null). | DisplayObject | |
| 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 | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
| 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 | |
| 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 | |
| scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
| 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 | |
| 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 | |
| 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 | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| transformationMatrix3D : Matrix3D [read-only] The 3D 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 | |
| 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 | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Canvas() | Canvas | ||
| 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] Registers an event listener at a certain object. | DisplayObject | |
|
Adds a child to the Scroller rather than delegating the
call to the view port. | ScrollContainer | |
|
Adds a child to the Scroller at a specific index rather
than delegating the call to the view port. | ScrollContainer | |
| alignPivot(horizontalAlign:String = center, verticalAlign: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(eventType: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. | DisplayObjectContainer | |
| drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
| 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 | |
| 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 | |
| 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 | |
| getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
| hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
| hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
| hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
| hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
| 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 | |
| local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| 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 | |
| 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] Removes an event listener from the object. | DisplayObject | |
| removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
|
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 | |
| [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
| 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 | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| 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 | |
| setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
| 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 | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| 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 | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
|
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 | |
| graphics | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesgraphics:CanvasDisplayObject [read-only] The display object that contains the drawing methods.
public function get graphics():CanvasDisplayObject| Canvas | () | Constructor |
public function Canvas()