LayoutRendererBase

Package	org.osmf.layout
Class	public class LayoutRendererBase
Inheritance	LayoutRendererBase EventDispatcher Object
Subclasses	LayoutRenderer

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

LayoutRendererBase is the base class for custom layout renderers.

Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		container : org.osmf.layout:ILayoutTarget Defines the container against which the renderer will calculate the size and position values of its targets.	LayoutRendererBase
		measuredHeight : Number [read-only] Defines the height that the layout renderer measured on its last rendering pass.	LayoutRendererBase
		measuredWidth : Number [read-only] Defines the width that the layout renderer measured on its last rendering pass.	LayoutRendererBase
		parent : LayoutRendererBase [read-only] Defines the renderer that this renderer is a child of.	LayoutRendererBase

Public Methods

	Method		Defined By
		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
		addTarget(target:org.osmf.layout:ILayoutTarget):org.osmf.layout:ILayoutTarget Method for adding a target to the layout renderer's list of objects that it calculates the size and position for.	LayoutRendererBase
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		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
		hasTarget(target:org.osmf.layout:ILayoutTarget):Boolean Method for querying if a layout target is currently a target of this layout renderer.	LayoutRendererBase
		invalidate():void Method that will mark the renderer's last rendering pass invalid.	LayoutRendererBase
		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
		removeTarget(target:org.osmf.layout:ILayoutTarget):org.osmf.layout:ILayoutTarget Method for removing a target from the layout render's list of objects that it will render.	LayoutRendererBase
		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
		validateNow():void Method ordering the direct recalculation of the position and size of all of the renderer's assigned targets.	LayoutRendererBase
		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

	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

container

property

container:org.osmf.layout:ILayoutTarget

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Defines the container against which the renderer will calculate the size and position values of its targets. The renderer additionally manages targets being added and removed as children of the set container's display list.

Implementation
public function get container():org.osmf.layout:ILayoutTarget
public function set container(value:org.osmf.layout:ILayoutTarget):void

measuredHeight

property

measuredHeight:Number [read-only]

Defines the height that the layout renderer measured on its last rendering pass.

Implementation
public function get measuredHeight():Number

measuredWidth

property

measuredWidth:Number [read-only]

Defines the width that the layout renderer measured on its last rendering pass.

Implementation
public function get measuredWidth():Number

parent

property

parent:LayoutRendererBase [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Defines the renderer that this renderer is a child of.

Implementation
public function get parent():LayoutRendererBase

Method Detail

addTarget

()

method

public final function addTarget(target:org.osmf.layout:ILayoutTarget):org.osmf.layout:ILayoutTarget

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Method for adding a target to the layout renderer's list of objects that it calculates the size and position for. Adding a target will result the associated display object to be placed on the display list of the renderer's container.

Parameters

target:org.osmf.layout:ILayoutTarget — The target to add.

Returns

org.osmf.layout:ILayoutTarget

Throws

IllegalOperationError — when the specified target is null, or already a target of the renderer.

hasTarget

()

method

public final function hasTarget(target:org.osmf.layout:ILayoutTarget):Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Method for querying if a layout target is currently a target of this layout renderer.

Parameters

target:org.osmf.layout:ILayoutTarget

Returns

Boolean — True if the specified target is a target of this renderer.

invalidate

()

method

public final function invalidate():void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Method that will mark the renderer's last rendering pass invalid. At the descretion of the implementing instance, the renderer may either directly re-render, or do so at a later time.

removeTarget

()

method

public final function removeTarget(target:org.osmf.layout:ILayoutTarget):org.osmf.layout:ILayoutTarget

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Method for removing a target from the layout render's list of objects that it will render. See addTarget for more information.

Parameters

target:org.osmf.layout:ILayoutTarget — The target to remove.

Returns

org.osmf.layout:ILayoutTarget

Throws

Error — when the specified target is null, or not a target of the renderer.

validateNow

()

method

public final function validateNow():void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Method ordering the direct recalculation of the position and size of all of the renderer's assigned targets. The implementing class may still skip recalculation if the renderer has not been invalidated since the last rendering pass.

Legal Notices | Online Privacy Policy

LayoutRendererBase - AS3 OSMF

Classes x

container

measuredHeight

measuredWidth

parent

addTarget

hasTarget

invalidate

removeTarget

validateNow