| Package | flare.util |
| Class | public class Displays |
| Method | Defined by | ||
|---|---|---|---|
|
Displays()
Constructor, throws an error if called, as this is an abstract class.
| Displays | ||
|
addStageListener(d:DisplayObject, eventType:String, listener:Function, useCapture:Boolean = false, priority:Number = 0, useWeakReference:Boolean = false):Function
[static]
Adds a listener to the stage via a given display object.
| Displays | ||
|
panBy(obj:DisplayObject, dx:Number, dy:Number, vp:IValueProxy = null):void
[static]
Pan the "camera" by the specified amount.
| Displays | ||
|
panMatrixBy(mat:Matrix, dx:Number, dy:Number):Matrix
[static]
Performs a pan (translation) on an input matrix.
| Displays | ||
|
rotateMatrixBy(mat:Matrix, angle:Number, p:Point):Matrix
[static]
Performs a rotation around a specific point on an input matrix.
| Displays | ||
|
setChildrenProperties(d:DisplayObjectContainer, vals:Object, p:IValueProxy = null):void
[static]
Sets property values on all children items.
| Displays | ||
|
sortChildren(d:DisplayObjectContainer, cmp:Function):void
[static]
Sorts the children of the given
DisplayObjectContainer
using a comparator function. | Displays | ||
|
thumbnail(src:DisplayObject, width:Number = -1, height:Number = -1, bd:BitmapData = null):BitmapData
[static]
Creates a thumbnail image of the input object using the (optional)
given size.
| Displays | ||
|
visitChildren(con:DisplayObjectContainer, visitor:Function, filter:Boolean = null, reverse:* = false):Boolean
[static]
Iterates over the children of the input display object container,
invoking a visitor function on each.
| Displays | ||
|
zoomBy(obj:DisplayObject, scale:Number, xp:Number, yp:Number, vp:IValueProxy = null):void
[static]
Zoom the "camera" by the specified scale factor.
| Displays | ||
|
zoomMatrixBy(mat:Matrix, scale:Number, p:Point):Matrix
[static]
Performs a zoom about a specific point on an input matrix.
| Displays | ||
| Displays | () | constructor |
public function Displays()Constructor, throws an error if called, as this is an abstract class.
| addStageListener | () | method |
public static function addStageListener(d:DisplayObject, eventType:String, listener:Function, useCapture:Boolean = false, priority:Number = 0, useWeakReference:Boolean = false):FunctionAdds a listener to the stage via a given display object. If the display object has already been added to the stage, the listener will be added to the stage immediately. Otherwise, the listener will be added whenever the display object is added to the stage. This method allows you to add listeners for stage events without having to explicitly manage the case where the defining elements have not yet been added to the stage.
Parametersd:DisplayObject — the display object through which to access the stage
|
|
eventType:String — the event type
|
|
listener:Function — the event listener
|
|
useCapture:Boolean (default = false) |
|
priority:Number (default = 0) |
|
useWeakReference:Boolean (default = false) |
Function — the function that will add the listener to the stage upon
an added to stage event, or null if the listener was directly
added to the stage
|
See also
| panBy | () | method |
public static function panBy(obj:DisplayObject, dx:Number, dy:Number, vp:IValueProxy = null):voidPan the "camera" by the specified amount.
Parametersobj:DisplayObject — the display object to treat as the camera
|
|
dx:Number — the change in x position, in the parent's coordinate space
|
|
dy:Number — the change in y position, in the parent's coordinate space
|
|
vp:IValueProxy (default = null)Transitioner) for storing the new transform matrix
|
| panMatrixBy | () | method |
public static function panMatrixBy(mat:Matrix, dx:Number, dy:Number):MatrixPerforms a pan (translation) on an input matrix. The result is a transformation matrix including the translation.
Parametersmat:Matrix — an input transformation matrix
|
|
dx:Number — the change in x position
|
|
dy:Number — the change in y position
|
Matrix — the resulting, panned transformation matrix
|
| rotateMatrixBy | () | method |
public static function rotateMatrixBy(mat:Matrix, angle:Number, p:Point):MatrixPerforms a rotation around a specific point on an input matrix. The result is a transformation matrix including the rotation.
Parametersmat:Matrix — an input transformation matrix
|
|
angle:Number — the rotation angle, in degrees
|
|
p:Point — the point about which to zoom in or out
|
Matrix — the resulting, rotated transformation matrix
|
| setChildrenProperties | () | method |
public static function setChildrenProperties(d:DisplayObjectContainer, vals:Object, p:IValueProxy = null):void
Sets property values on all children items. The values
within the vals argument can take a number of forms:
Function, it will be evaluated
for each element and the result will be used as the property
value for that element.IEvaluable instance, such as
flare.util.Property or
flare.query.Expression, it will be evaluated for
each element and the result will be used as the property value
for that element.d:DisplayObjectContainer — the container whose children's properties should be set.
|
|
vals:Object — an object containing the properties and values to set.
|
|
p:IValueProxy (default = null) |
| sortChildren | () | method |
public static function sortChildren(d:DisplayObjectContainer, cmp:Function):void
Sorts the children of the given DisplayObjectContainer
using a comparator function.
d:DisplayObjectContainer — a display object container to sort. The sort may change the
rendering order in which the contained display objects are drawn.
|
|
cmp:Function — a comparator Function.
|
| thumbnail | () | method |
public static function thumbnail(src:DisplayObject, width:Number = -1, height:Number = -1, bd:BitmapData = null):BitmapDataCreates a thumbnail image of the input object using the (optional) given size. If no width, height, or bitmap data parameters are provided then the natural size of the display object will be used. If no width or height values are provided (i.e., they are less than or equal to zero) but a bitmap data is provided, than the dimensions of the bitmap data will be used. If all parameters are provided but the width and height exceed the size of the bitmap data, then the object will be drawn to match the provided width and height, but the thumbnail will be clipped to the size of the bitmap data. If only one of the width or height values are provided, than the other will automatically be selected to preserve the original aspect ratio of the object.
Parameterssrc:DisplayObject — the DisplayObject to create a thumbnail image of
|
|
width:Number (default = -1) |
|
height:Number (default = -1) |
|
bd:BitmapData (default = null) |
BitmapData — the thumbnail image as a BitmapData instance
|
| visitChildren | () | method |
public static function visitChildren(con:DisplayObjectContainer, visitor:Function, filter:Boolean = null, reverse:* = false):BooleanIterates over the children of the input display object container, invoking a visitor function on each. If the visitor function returns a Boolean true value, the iteration will stop with an early exit.
Parameterscon:DisplayObjectContainer — the container to visit
|
|
visitor:Function — the visitor function to invoke on the children
|
|
filter:Boolean (default = null) |
|
reverse:* (default = false) |
Boolean — true if the visitation was interrupted with an early exit
|
| zoomBy | () | method |
public static function zoomBy(obj:DisplayObject, scale:Number, xp:Number, yp:Number, vp:IValueProxy = null):voidZoom the "camera" by the specified scale factor.
Parametersobj:DisplayObject — the display object to treat as the camera
|
|
scale:Number — a scale factor specifying the amount to zoom. A value
of 2 will zoom in such that objects are twice as large. A value of
0.5 will zoom out such that objects are half the size.
|
|
xp:Number — the x-coordinate around which to zoom, in stage
coordinates. If this value is NaN, 0 will be used.
|
|
yp:Number — the y-coordinate around which to zoom, in stage
coordinates. If this value is NaN, 0 will be used.
|
|
vp:IValueProxy (default = null)Transitioner) for storing the new transform matrix
|
| zoomMatrixBy | () | method |
public static function zoomMatrixBy(mat:Matrix, scale:Number, p:Point):MatrixPerforms a zoom about a specific point on an input matrix. The result is a transformation matrix including the zoom.
Parametersmat:Matrix — an input transformation matrix
|
|
scale:Number — a scale factor specifying the amount to zoom. A value
of 2 will zoom in such that objects are twice as large. A value of
0.5 will zoom out such that objects are half the size.
|
|
p:Point — the point about which to zoom in or out
|
Matrix — the resulting, zoomed transformation matrix
|