This class implements support for the backgroundImage,
* backgroundSize, and backgroundAttachment styles.
true if the RectangularBorder instance
* contains a background image.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get hasBackgroundImage():Boolean
{
return backgroundImage != null;
}
//----------------------------------
// backgroundImageBounds
//----------------------------------
/**
* @private
* Storage for backgroundImageBounds property.
*/
private var _backgroundImageBounds:Rectangle;
/**
* Rectangular area within which to draw the background image.
*
* This can be larger than the dimensions of the border
* if the parent container has scrollable content.
* If this property is null, the border can use
* the parent's size and viewMetrics property to determine its value.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get backgroundImageBounds():Rectangle
{
return _backgroundImageBounds;
}
/**
* @private
*/
public function set backgroundImageBounds(value:Rectangle):void
{
if (_backgroundImageBounds && value && _backgroundImageBounds.equals(value))
return;
_backgroundImageBounds = value;
invalidateDisplayList();
}
//--------------------------------------------------------------------------
//
// Overridden methods
//
//--------------------------------------------------------------------------
/**
* @private
*/
override protected function updateDisplayList(unscaledWidth:Number,
unscaledHeight:Number):void
{
if (!parent)
return;
// If background image has changed, then load new one.
var newStyle:Object = getStyle("backgroundImage");
if (newStyle != backgroundImageStyle)
{
// Discard old background image.
removedHandler(null);
backgroundImageStyle = newStyle;
// The code below looks a lot like Loader.loadContent().
var cls:Class;
// The "as" operator checks to see if newStyle
// can be coerced to a Class.
if (newStyle && newStyle as Class)
{
// Load background image given a class pointer
cls = Class(newStyle);
initBackgroundImage(new cls());
}
else if (newStyle && newStyle is String)
{
try
{
cls = Class(getDefinitionByName(String(newStyle)));
}
catch(e:Error)
{
// ignore
}
if (cls)
{
var newStyleObj:DisplayObject = new cls();
initBackgroundImage(newStyleObj);
}
else
{
// This code is a subset of Loader.loadContent().
// Load background image from external URL.
const loader:Loader = new FlexLoader();
loader.contentLoaderInfo.addEventListener(
Event.COMPLETE, completeEventHandler);
loader.contentLoaderInfo.addEventListener(
IOErrorEvent.IO_ERROR, errorEventHandler);
loader.contentLoaderInfo.addEventListener(
ErrorEvent.ERROR, errorEventHandler);
var loaderContext:LoaderContext = new LoaderContext();
loaderContext.applicationDomain = new ApplicationDomain(ApplicationDomain.currentDomain);
loader.load(new URLRequest(String(newStyle)), loaderContext);
}
}
else if (newStyle)
{
var message:String = resourceManager.getString(
"skins", "notLoaded", [ newStyle ]);
throw new Error(message);
}
}
if (backgroundImage)
layoutBackgroundImage();
}
//--------------------------------------------------------------------------
//
// Methods
//
//--------------------------------------------------------------------------
/**
* @private
*/
private function initBackgroundImage(image:DisplayObject):void
{
backgroundImage = image;
if (image is Loader)
{
backgroundImageWidth = Loader(image).contentLoaderInfo.width;
backgroundImageHeight = Loader(image).contentLoaderInfo.height;
}
else
{
backgroundImageWidth = backgroundImage.width;
backgroundImageHeight = backgroundImage.height;
if (image is ISimpleStyleClient)
{
// Set the image's styleName to our styleName. We
// can't set styleName to this since we aren't an
// IStyleClient.
ISimpleStyleClient(image).styleName = styleName;
}
}
// To optimize memory use, we've declared RectangularBorder to be a Shape.
// As a result, it cannot have any children.
// Make the backgroundImage a sibling of this RectangularBorder,
// which is positioned just on top of the RectangularBorder.
var childrenList:IChildList = parent is IRawChildrenContainer ?
IRawChildrenContainer(parent).rawChildren :
IChildList(parent);
const backgroundMask:Shape = new FlexShape();
backgroundMask.name = "backgroundMask";
backgroundMask.x = 0;
backgroundMask.y = 0;
childrenList.addChild(backgroundMask);
var myIndex:int = childrenList.getChildIndex(this);
childrenList.addChildAt(backgroundImage, myIndex + 1);
backgroundImage.mask = backgroundMask;
}
/**
* Layout the background image.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function layoutBackgroundImage():void
{
var p:DisplayObject = parent;
var bm:EdgeMetrics = p is IContainer ?
IContainer(p).viewMetrics :
borderMetrics;
var scrollableBk:Boolean =
getStyle("backgroundAttachment") != "fixed";
var sW:Number,
sH:Number;
if (_backgroundImageBounds)
{
sW = _backgroundImageBounds.width;
sH = _backgroundImageBounds.height;
}
else
{
sW = width - bm.left - bm.right;
sH = height - bm.top - bm.bottom;
}
// Scale according to backgroundSize.
var percentage:Number = getBackgroundSize();
var sX:Number,
sY:Number;
if (isNaN(percentage))
{
sX = 1.0;
sY = 1.0;
}
else
{
var scale:Number = percentage * 0.01;
sX = scale * sW / backgroundImageWidth;
sY = scale * sH / backgroundImageHeight;
}
backgroundImage.scaleX = sX;
backgroundImage.scaleY = sY;
// Center everything.
// Use a scrollRect to position and clip the image.
var offsetX:Number =
Math.round(0.5 * (sW - backgroundImageWidth * sX));
var offsetY:Number =
Math.round(0.5 * (sH - backgroundImageHeight * sY));
backgroundImage.x = bm.left;
backgroundImage.y = bm.top;
const backgroundMask:Shape = Shape(backgroundImage.mask);
backgroundMask.x = bm.left;
backgroundMask.y = bm.top;
// Adjust offsets by scroll positions.
if (scrollableBk && p is IContainer)
{
offsetX -= IContainer(p).horizontalScrollPosition;
offsetY -= IContainer(p).verticalScrollPosition;
}
// Adjust alpha to match backgroundAlpha
backgroundImage.alpha = getStyle("backgroundAlpha");
backgroundImage.x += offsetX;
backgroundImage.y += offsetY;
var maskWidth:Number = width - bm.left - bm.right;
var maskHeight:Number = height - bm.top - bm.bottom;
if (backgroundMask.width != maskWidth ||
backgroundMask.height != maskHeight)
{
var g:Graphics = backgroundMask.graphics;
g.clear();
g.beginFill(0xFFFFFF);
g.drawRect(0, 0, maskWidth, maskHeight);
g.endFill();
}
}
/**
* @private
*/
private function getBackgroundSize():Number
{
var percentage:Number = NaN;
var backgroundSize:Object = getStyle("backgroundSize");
if (backgroundSize && backgroundSize is String)
{
var index:int = backgroundSize.indexOf("%");
if (index != -1)
percentage = Number(backgroundSize.substr(0, index));
}
return percentage;
}
//--------------------------------------------------------------------------
//
// Event handlers
//
//--------------------------------------------------------------------------
/**
* @private
*/
private function errorEventHandler(event:Event):void
{
// Ignore errors that occure during background image loading.
}
/**
* @private
*/
private function completeEventHandler(event:Event):void
{
if (!parent)
return;
var target:DisplayObject = DisplayObject(LoaderInfo(event.target).loader);
initBackgroundImage(target);
layoutBackgroundImage();
// rebroadcast for automation support
dispatchEvent(event.clone());
}
/**
* Discard old background image.
*
* @private
*/
private function removedHandler(event:Event):void
{
if (backgroundImage)
{
var childrenList:IChildList = parent is IRawChildrenContainer ?
IRawChildrenContainer(parent).rawChildren :
IChildList(parent);
childrenList.removeChild(backgroundImage.mask);
childrenList.removeChild(backgroundImage);
backgroundImage = null;
}
}
}
}