mx.skins.RectangularBorder - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.skins
Class	public class RectangularBorder
Inheritance	RectangularBorder Border ProgrammaticSkin FlexShape Shape DisplayObject EventDispatcher Object
Implements	IRectangularBorder
Subclasses	HaloBorder, ToolTipBorder

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The RectangularBorder class is an abstract base class for various classes that draw rectangular borders around UIComponents.

This class implements support for the backgroundImage, backgroundSize, and backgroundAttachment styles.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		backgroundImageBounds : Rectangle Rectangular area within which to draw the background image.	RectangularBorder
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		borderMetrics : EdgeMetrics [read-only] The thickness of the border edges.	Border
		cacheAsBitmap : Boolean If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.	DisplayObject
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		graphics : Graphics [read-only] Specifies the Graphics object belonging to this Shape object, where vector drawing commands can occur.	Shape
		hasBackgroundImage : Boolean [read-only] Contains true if the RectangularBorder instance contains a background image.	RectangularBorder
		height : Number Indicates the height of the display object, in pixels.	DisplayObject
		initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).	ProgrammaticSkin
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		measuredHeight : Number [read-only] The measured height of this object.	ProgrammaticSkin
		measuredWidth : Number [read-only] The measured width of this object.	ProgrammaticSkin
		mouseX : Number [read-only] Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		nestLevel : int Depth of this object in the containment hierarchy.	ProgrammaticSkin
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens.	ProgrammaticSkin
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point.	DisplayObject
		scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		styleName : Object A parent component used to obtain style values.	ProgrammaticSkin
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required).	ProgrammaticSkin
		visible : Boolean Whether or not the display object is visible.	DisplayObject
		width : Number Indicates the width of the display object, in pixels.	DisplayObject
		x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	DisplayObject
		y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	DisplayObject
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		RectangularBorder() Constructor.	RectangularBorder
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		getStyle(styleProp:String):* Returns the value of the specified style property.	ProgrammaticSkin
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update.	ProgrammaticSkin
		invalidateProperties():void Calling this method results in a call to the component's validateProperties() method before the display list is rendered.	ProgrammaticSkin
		invalidateSize():void Calling this method results in a call to the component's validateSize() method before the display list is rendered.	ProgrammaticSkin
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		layoutBackgroundImage():void Layout the background image.	RectangularBorder
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		move(x:Number, y:Number):void Moves this object to the specified x and y coordinates.	ProgrammaticSkin
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setActualSize(newWidth:Number, newHeight:Number):void Sets the height and width of this object.	ProgrammaticSkin
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		styleChanged(styleProp:String):void Whenever any style changes, redraw this skin.	ProgrammaticSkin
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.	FlexShape
		validateDisplayList():void This function is called by the LayoutManager when it's time for this control to draw itself.	ProgrammaticSkin
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	ProgrammaticSkin
		validateProperties():void This function is an empty stub so that ProgrammaticSkin can implement the ILayoutManagerClient interface.	ProgrammaticSkin
		validateSize(recursive:Boolean = false):void This function is an empty stub so that ProgrammaticSkin can implement the ILayoutManagerClient interface.	ProgrammaticSkin
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void Programatically draws a rectangle into this skin's Graphics object.	ProgrammaticSkin
		horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Utility function to create a horizontal gradient matrix.	ProgrammaticSkin
		rotatedGradientMatrix(x:Number, y:Number, width:Number, height:Number, rotation:Number):Matrix Utility function to create a rotated gradient matrix.	ProgrammaticSkin
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Programmatically draws the graphics for this skin.	ProgrammaticSkin
		verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Utility function to create a vertical gradient matrix.	ProgrammaticSkin

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject

Property Detail

backgroundImageBounds

property

backgroundImageBounds:Rectangle

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Implementation
public function get backgroundImageBounds():Rectangle
public function set backgroundImageBounds(value:Rectangle):void

hasBackgroundImage

property

hasBackgroundImage:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Contains true if the RectangularBorder instance contains a background image.

Implementation
public function get hasBackgroundImage():Boolean

Constructor Detail

RectangularBorder

()

Constructor

public function RectangularBorder()

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Method Detail

layoutBackgroundImage

()

method

public function layoutBackgroundImage():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Layout the background image.