| Package | com.greensock.loading.display |
| Class | public class FlexContentDisplay |
| Inheritance | FlexContentDisplay  mx.core.UIComponent |
loader
property for easily referencing the original loader, as well as several other useful properties for
controling the placement of rawContent and the way it is scaled to fit (if at all). That way,
you can add a FlexContentDisplay to the display list or populate an array with as many as you want and then if
you ever need to unload() the content or reload it or figure out its url, etc., you can reference your
FlexContentDisplay's loader property like myContent.loader.url or
(myContent.loader as SWFLoader).getClass("com.greensock.TweenLite");.
IMPORTANT: In order for the LoaderMax loaders to use FlexContentDisplay instead of
the regular ContentDisplay class, you must set the LoaderMax.contentDisplayClass property
to FlexContentDisplay once like:
import com.greensock.loading.*; import com.greensock.loading.display.*; LoaderMax.contentDisplayClass = FlexContentDisplay;
After that, all ImageLoaders, SWFLoaders, and VideoLoaders will return FlexContentDisplay objects
as their content instead of regular ContentDisplay objects.
Copyright 2009-2013, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for Club GreenSock members, the software agreement that was issued with the membership.
| Property | Defined By | ||
|---|---|---|---|
| bgAlpha : Number
Controls the alpha of the rectangle that is drawn when the FlexContentDisplay's fitWidth and fitHeight
properties are defined (or width and height in the loader's vars property/parameter). | FlexContentDisplay | ||
| bgColor : uint
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), a rectangle will be drawn inside the
FlexContentDisplay object immediately in order to ease the development process (for example, you can add ROLL_OVER/ROLL_OUT
event listeners immediately). | FlexContentDisplay | ||
| centerRegistration : Boolean
If true, the FlexContentDisplay's registration point will be placed in the center of the rawContent
which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center. | FlexContentDisplay | ||
| crop : Boolean
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), setting crop to
true will cause the rawContent to be cropped within that area (by applying a scrollRect
for maximum performance). | FlexContentDisplay | ||
| data : * Arbitrary data that you can associate with the FlexContentDisplay instance. | FlexContentDisplay | ||
| fitHeight : Number
The height to which the rawContent should be fit according to the FlexContentDisplay's scaleMode
(this height is figured before rotation, scaleX, and scaleY). | FlexContentDisplay | ||
| fitWidth : Number
The width to which the rawContent should be fit according to the FlexContentDisplay's scaleMode
(this width is figured before rotation, scaleX, and scaleY). | FlexContentDisplay | ||
| hAlign : String
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), the hAlign determines how
the rawContent is horizontally aligned within that area. | FlexContentDisplay | ||
| loader : LoaderItem The loader whose rawContent populates this FlexContentDisplay. | FlexContentDisplay | ||
| rawContent : * The raw content which can be a Bitmap, a MovieClip, a Loader, or a Video depending on the type of loader associated with the FlexContentDisplay. | FlexContentDisplay | ||
| scaleMode : String
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), the scaleMode controls how
the rawContent will be scaled to fit the area. | FlexContentDisplay | ||
| vAlign : String
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), the vAlign determines how
the rawContent is vertically aligned within that area. | FlexContentDisplay | ||
| Method | Defined By | ||
|---|---|---|---|
FlexContentDisplay(loader:LoaderItem)
Constructor
| FlexContentDisplay | ||
dispose(unloadLoader:Boolean = true, disposeLoader:Boolean = true):void
Removes the FlexContentDisplay from the display list (if necessary), dumps the rawContent,
and calls unload() and dispose() on the loader (unless you define otherwise with
the optional parameters). | FlexContentDisplay | ||
| bgAlpha | property |
bgAlpha:Number
Controls the alpha of the rectangle that is drawn when the FlexContentDisplay's fitWidth and fitHeight
properties are defined (or width and height in the loader's vars property/parameter).
public function get bgAlpha():Number public function set bgAlpha(value:Number):voidSee also
| bgColor | property |
bgColor:uint
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), a rectangle will be drawn inside the
FlexContentDisplay object immediately in order to ease the development process (for example, you can add ROLL_OVER/ROLL_OUT
event listeners immediately). It is transparent by default, but you may define a bgAlpha if you prefer.
public function get bgColor():uint public function set bgColor(value:uint):voidSee also
| centerRegistration | property |
centerRegistration:Boolean
If true, the FlexContentDisplay's registration point will be placed in the center of the rawContent
which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center.
public function get centerRegistration():Boolean public function set centerRegistration(value:Boolean):voidSee also
| crop | property |
crop:Boolean
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), setting crop to
true will cause the rawContent to be cropped within that area (by applying a scrollRect
for maximum performance). This is typically useful when the scaleMode is "proportionalOutside"
or "none" so that any parts of the rawContent that exceed the dimensions defined by
fitWidth and fitHeight are visually chopped off. Use the hAlign and
vAlign properties to control the vertical and horizontal alignment within the cropped area.
public function get crop():Boolean public function set crop(value:Boolean):voidSee also
| data | property |
public var data:* Arbitrary data that you can associate with the FlexContentDisplay instance. For example, you could set data to be an object containing various other properties or set it to an index number related to an array in your application. It is completely optional and arbitrary.
| fitHeight | property |
fitHeight:Number
The height to which the rawContent should be fit according to the FlexContentDisplay's scaleMode
(this height is figured before rotation, scaleX, and scaleY). When a "height" property is defined in the loader's vars
property/parameter, it is automatically applied to this fitHeight property. For example, the following code will
set the loader's FlexContentDisplay fitHeight to 80:
var loader:ImageLoader = new ImageLoader("photo.jpg", {width:100, height:80, container:this});
public function get fitHeight():Number public function set fitHeight(value:Number):voidSee also
| fitWidth | property |
fitWidth:Number
The width to which the rawContent should be fit according to the FlexContentDisplay's scaleMode
(this width is figured before rotation, scaleX, and scaleY). When a "width" property is defined in the loader's vars
property/parameter, it is automatically applied to this fitWidth property. For example, the following code will
set the loader's FlexContentDisplay fitWidth to 100:
var loader:ImageLoader = new ImageLoader("photo.jpg", {width:100, height:80, container:this});
public function get fitWidth():Number public function set fitWidth(value:Number):voidSee also
| hAlign | property |
hAlign:String
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), the hAlign determines how
the rawContent is horizontally aligned within that area. The following values are recognized (you may use the
com.greensock.layout.AlignMode constants if you prefer):
"center" (the default) - The rawContent will be centered horizontally in the FlexContentDisplay"left" - The rawContent will be aligned with the left side of the FlexContentDisplay"right" - The rawContent will be aligned with the right side of the FlexContentDisplay public function get hAlign():String public function set hAlign(value:String):voidSee also
| loader | property |
loader:LoaderItem The loader whose rawContent populates this FlexContentDisplay. If you get the loader's content, it will return this FlexContentDisplay object.
public function get loader():LoaderItem public function set loader(value:LoaderItem):void| rawContent | property |
rawContent:*The raw content which can be a Bitmap, a MovieClip, a Loader, or a Video depending on the type of loader associated with the FlexContentDisplay.
public function get rawContent():* public function set rawContent(value:any):void| scaleMode | property |
scaleMode:String
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), the scaleMode controls how
the rawContent will be scaled to fit the area. The following values are recognized (you may use the
com.greensock.layout.ScaleMode constants if you prefer):
"stretch" (the default) - The rawContent will fill the width/height exactly."proportionalInside" - The rawContent will be scaled proportionally to fit inside the area defined by the width/height"proportionalOutside" - The rawContent will be scaled proportionally to completely fill the area, allowing portions of it to exceed the bounds defined by the width/height."widthOnly" - Only the width of the rawContent will be adjusted to fit."heightOnly" - Only the height of the rawContent will be adjusted to fit."none" - No scaling of the rawContent will occur. public function get scaleMode():String public function set scaleMode(value:String):void| vAlign | property |
vAlign:String
When the FlexContentDisplay's fitWidth and fitHeight properties are defined (or width
and height in the loader's vars property/parameter), the vAlign determines how
the rawContent is vertically aligned within that area. The following values are recognized (you may use the
com.greensock.layout.AlignMode constants if you prefer):
"center" (the default) - The rawContent will be centered vertically in the FlexContentDisplay"top" - The rawContent will be aligned with the top of the FlexContentDisplay"bottom" - The rawContent will be aligned with the bottom of the FlexContentDisplay public function get vAlign():String public function set vAlign(value:String):voidSee also
| FlexContentDisplay | () | Constructor |
public function FlexContentDisplay(loader:LoaderItem)Constructor
Parametersloader:LoaderItem — The Loader object that will populate the FlexContentDisplay's rawContent.
|
| dispose | () | method |
public function dispose(unloadLoader:Boolean = true, disposeLoader:Boolean = true):void
Removes the FlexContentDisplay from the display list (if necessary), dumps the rawContent,
and calls unload() and dispose() on the loader (unless you define otherwise with
the optional parameters). This essentially destroys the FlexContentDisplay and makes it eligible for garbage
collection internally, although if you added any listeners manually, you should remove them as well.
Parameters
unloadLoader:Boolean (default = true)true, unload() will be called on the loader. It is true by default.
| |
disposeLoader:Boolean (default = true)true, dispose() will be called on the loader. It is true by default.
|