mx.graphics.SolidColor - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.graphics
Class	public class SolidColor
Inheritance	SolidColor EventDispatcher Object
Implements	IFill

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Defines a representation for a color, including a color and an alpha value.

Default MXML Propertycolor

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		alpha : Number The transparency of a color.	SolidColor
		color : uint A color value.	SolidColor
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SolidColor(color:uint = 0x000000, alpha:Number = 1.0) Constructor.	SolidColor
		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
		begin(target:Graphics, targetBounds:Rectangle, targetOrigin:Point):void Starts the fill.	SolidColor
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end(target:Graphics):void Ends the fill.	SolidColor
		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
		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
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

alpha

property

alpha:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The transparency of a color. Possible values are 0.0 (invisible) through 1.0 (opaque).

The default value is 1.0.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get alpha():Number
public function set alpha(value:Number):void

color

property

color:uint

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

A color value.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get color():uint
public function set color(value:uint):void

Constructor Detail

SolidColor

()

Constructor

public function SolidColor(color:uint = 0x000000, alpha:Number = 1.0)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`color:uint` (default = `0x000000`) — Specifies the color. The default value is 0x000000 (black).

	`alpha:Number` (default = `1.0`) — Specifies the level of transparency. Valid values range from 0.0 (completely transparent) to 1.0 (completely opaque). The default value is 1.0.

Method Detail

begin

()

method

public function begin(target:Graphics, targetBounds:Rectangle, targetOrigin:Point):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Starts the fill.

Parameters

	`target:Graphics` — The target Graphics object that is being filled.

	`targetBounds:Rectangle` — The Rectangle object that defines the size of the fill inside the `target`. If the dimensions of the Rectangle are larger than the dimensions of the `target`, the fill is clipped. If the dimensions of the Rectangle are smaller than the dimensions of the `target`, the fill expands to fill the entire `target`.

	`targetOrigin:Point` — The Point that defines the origin (0,0) of the shape in the coordinate system of target.

end

()

method

public function end(target:Graphics):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Ends the fill.

Parameters

target:Graphics — The Graphics object that is being filled.