flashx.textLayout.elements.InlineGraphicElement (Flex 4 Beta)

Package	flashx.textLayout.elements
Class	public final class InlineGraphicElement
Inheritance	InlineGraphicElement FlowLeafElement FlowElement Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The InlineGraphicElement class handles graphic objects that display inline in the text.

You can embed a graphic or any DisplayObject or specify a URl for the location of the graphic. The height and width properties of InlineGraphicElement control the actual size of the graphic to display. These values also control how much space to allocate for the graphic in the TextLine object that contains the graphic. The height and width properties each can be one of:

A number of pixels
A percent of the measured size of the image
The constant, "auto", which computes the size (Default value)

There are three properties, or accessors, pertaining to the width and height of a graphic:

The width and height properties
The measuredWidth and measuredHeight properties, which are the width or height of the graphic at load time
The actualWidth and actualHeight properties, which are the actual display and compose width and height of the graphic as computed from width or height and measuredWidth or measuredHeight

The values of the actualWidth and actualHeight properties are always zero until the graphic is loaded.

If source is specified as a URI, the graphic is loaded asynchronously. If it's a DisplayObject, TextLayout uses the width and height at the time the graphic is set into the InlineGraphicElement object as measuredHeight and measuredWidth; its width and height are read immediately.

Notes: For graphics that are loaded asynchronously the user must listen for a StatusChangeEvent.INLINE_GRAPHIC_STATUS_CHANGE event on the TextFlow and call IFlowComposer.updateAllControllers() to have the graphic appear. The value of measuredWidth and measuredHeight for graphics that are in the process of loading is zero.

Some inline graphics are animations or videos that possibly have audio. They begin to run the first time they are composed after they finish loading. They don't stop running until the flowComposer on the TextFlow is set to null. At that time they are stopped and unloaded.

View the examples

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		actualHeight : Number [read-only] The actual height in effect.	InlineGraphicElement
		actualWidth : Number [read-only] The actual width in effect.	InlineGraphicElement
		alignmentBaseline : * TextLayoutFormat: Specifies the baseline to which the dominant baseline aligns.	FlowElement
		backgroundAlpha : * TextLayoutFormat: Alpha (transparency) value for the background (adopts default value if undefined during cascade).	FlowElement
		backgroundColor : * TextLayoutFormat: Background color of the text (adopts default value if undefined during cascade).	FlowElement
		baselineShift : * TextLayoutFormat: Amount to shift the baseline from the dominantBaseline value.	FlowElement
		blockProgression : * TextLayoutFormat: Specifies a vertical or horizontal progression of line placement.	FlowElement
		breakOpportunity : * TextLayoutFormat: Controls where lines are allowed to break when breaking wrapping text into multiple lines.	FlowElement
		cffHinting : * TextLayoutFormat: The type of CFF hinting used for this text.	FlowElement
		color : * TextLayoutFormat: Color of the text.	FlowElement
		columnCount : * TextLayoutFormat: Number of text columns (adopts default value if undefined during cascade).	FlowElement
		columnGap : * TextLayoutFormat: Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade).	FlowElement
		columnWidth : * TextLayoutFormat: Column width in pixels (adopts default value if undefined during cascade).	FlowElement
		computedFormat : flashx.textLayout.formats:ITextLayoutFormat [override] [read-only] Returns the computed character format attributes that are in effect for this element.	FlowLeafElement
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		coreStyles : Object [read-only] Returns the core styles on a FlowElement instance.	FlowElement
		digitCase : * TextLayoutFormat: The type of digit case used for this text.	FlowElement
		digitWidth : * TextLayoutFormat: Type of digit width used for this text.	FlowElement
		direction : * TextLayoutFormat: Specifies the default bidirectional embedding level of the text in the text block.	FlowElement
		dominantBaseline : * TextLayoutFormat: Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.	FlowElement
		firstBaselineOffset : * TextLayoutFormat: Specifies the baseline position of the first line in the container.	FlowElement
		fontFamily : * TextLayoutFormat: The name of the font to use, or a comma-separated list of font names.	FlowElement
		fontLookup : * TextLayoutFormat: Font lookup to use.	FlowElement
		fontSize : * TextLayoutFormat: The size of the text in pixels.	FlowElement
		fontStyle : * TextLayoutFormat: Style of text.	FlowElement
		fontWeight : * TextLayoutFormat: Weight of text.	FlowElement
		format : flashx.textLayout.formats:ITextLayoutFormat TextLayoutFormat properties applied directly to this element.	FlowElement
		graphic : DisplayObject [read-only] The embedded graphic.	InlineGraphicElement
		height : Object The height of the image.	InlineGraphicElement
		id : String Assigns an identifying name to the element, making it possible to set a style for the element by referencing the id.	FlowElement
		justificationRule : * TextLayoutFormat: Rule used to justify text in a paragraph.	FlowElement
		justificationStyle : * TextLayoutFormat: The style used for justification of the paragraph.	FlowElement
		kerning : * TextLayoutFormat: Kerning adjusts the pixels between certain character pairs to improve readability.	FlowElement
		leadingModel : * TextLayoutFormat: Specifies the leading model, which is a combination of leading basis and leading direction.	FlowElement
		ligatureLevel : * TextLayoutFormat: Controls which of the ligatures that are defined in the font may be used in the text.	FlowElement
		lineBreak : * TextLayoutFormat: Controls word wrapping within the container (adopts default value if undefined during cascade).	FlowElement
		lineHeight : * TextLayoutFormat: Leading controls for the text.	FlowElement
		lineThrough : * TextLayoutFormat: If true, applies strikethrough, a line drawn through the middle of the text.	FlowElement
		linkActiveFormat : * equivalent to setStyle(linkActiveFormat,value).	FlowElement
		linkHoverFormat : * equivalent to setStyle(linkHoverFormat,value).	FlowElement
		linkNormalFormat : * equivalent to setStyle(linkNormalFormat,value).	FlowElement
		locale : * TextLayoutFormat: The locale of the text.	FlowElement
		measuredHeight : Number [read-only] The natural height of the graphic.	InlineGraphicElement
		measuredWidth : Number [read-only] The natural width of the graphic.	InlineGraphicElement
		paddingBottom : * TextLayoutFormat: Botttom inset in pixels (adopts default value if undefined during cascade).	FlowElement
		paddingLeft : * TextLayoutFormat: Left inset in pixels (adopts default value if undefined during cascade).	FlowElement
		paddingRight : * TextLayoutFormat: Right inset in pixels (adopts default value if undefined during cascade).	FlowElement
		paddingTop : * TextLayoutFormat: Top inset in pixels (adopts default value if undefined during cascade).	FlowElement
		paragraphEndIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's end edge.	FlowElement
		paragraphSpaceAfter : * TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave after the paragraph.	FlowElement
		paragraphSpaceBefore : * TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave before the paragraph.	FlowElement
		paragraphStartIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's start edge.	FlowElement
		parent : FlowGroupElement [read-only] Returns the parent of this FlowElement object.	FlowElement
		parentRelativeEnd : int [read-only] Returns the relative end of this FlowElement object in the parent.	FlowElement
		parentRelativeStart : int [read-only] Returns the relative start of this FlowElement object in the parent.	FlowElement
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		renderingMode : * TextLayoutFormat: The rendering mode used for this text.	FlowElement
		source : Object Sets the source for the graphic.	InlineGraphicElement
		status : String [read-only] The current status of the image.	InlineGraphicElement
		styleName : String	FlowElement
		tabStops : * TextLayoutFormat: Specifies the tab stops associated with the paragraph.	FlowElement
		text : String [read-only] The text associated with the FlowLeafElement: The value for SpanElement subclass will be one character less than textLength if this is the last span in a ParagraphELement. The value for BreakElement subclass is a U+2028 The value for TabElement subclass is a tab The value for InlineGraphicElement subclass is U+FDEF	FlowLeafElement
		textAlign : * TextLayoutFormat: Alignment of lines in the paragraph relative to the container.	FlowElement
		textAlignLast : * TextLayoutFormat: Alignment of the last (or only) line in the paragraph relative to the container in justified text.	FlowElement
		textAlpha : * TextLayoutFormat: Alpha (transparency) value for the text.	FlowElement
		textDecoration : * TextLayoutFormat: Decoration on text.	FlowElement
		textIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the first line of the paragraph.	FlowElement
		textJustify : * TextLayoutFormat: Specifies options for justifying text.	FlowElement
		textLength : int [read-only] Returns the total length of text owned by this FlowElement object and its children.	FlowElement
		textRotation : * TextLayoutFormat: Determines the number of degrees to rotate this text.	FlowElement
		tracking : Object [write-only] Sets the tracking and is synonymous with the trackingRight property.	FlowElement
		trackingLeft : * TextLayoutFormat: Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character.	FlowElement
		trackingRight : * TextLayoutFormat: Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character.	FlowElement
		typographicCase : * TextLayoutFormat: The type of typographic case used for this text.	FlowElement
		userStyles : Object Allows you to read and write user styles on a FlowElement object.	FlowElement
		verticalAlign : * TextLayoutFormat: Vertical alignment or justification (adopts default value if undefined during cascade).	FlowElement
		whiteSpaceCollapse : * TextLayoutFormat: Collapses or preserves whitespace when importing text into a TextFlow.	FlowElement
		width : Object The width of the graphic.	InlineGraphicElement

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		InlineGraphicElement() Constructor - create new InlineGraphicElement object	InlineGraphicElement
		clearStyle(styleProp:String):void Clears the style specified by the styleProp parameter from this FlowElement object.	FlowElement
		deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Makes a deep copy of this FlowElement object, including any children, copying the content between the two specified character positions and returning the copy as a FlowElement object.	FlowElement
		equalUserStyles(otherElement:FlowElement):Boolean Compare the userStyles of this with elem.	FlowElement
		getAbsoluteStart():int Returns the start location of the element in the text flow as an absolute index.	FlowElement
		getCharAtPosition(relativePosition:int):String Returns the character at the specified position, relative to this FlowElement object.	FlowElement
		getCharCodeAtPosition(relativePosition:int):int Returns the character code at the specified position, relative to this FlowElement.	FlowElement
		getComputedFontMetrics():FontMetrics Returns the FontMetrics object for the span.	FlowLeafElement
		getElementRelativeStart(ancestorElement:FlowElement):int Returns the start of this element relative to an ancestor element.	FlowElement
		getNextLeaf(limitElement:FlowGroupElement = null):FlowLeafElement Returns the next FlowLeafElement object.	FlowLeafElement
		getNextSibling():FlowElement Returns the next FlowElement sibling in the text flow hierarchy.	FlowElement
		getParagraph():ParagraphElement Returns the ParagraphElement object associated with this element.	FlowElement
		getPreviousLeaf(limitElement:FlowGroupElement = null):FlowLeafElement Returns the previous FlowLeafElement object.	FlowLeafElement
		getPreviousSibling():FlowElement Returns the previous FlowElement sibling in the text flow hierarchy.	FlowElement
		getStyle(styleProp:String):* Returns the value of the style specified by the styleProp parameter, which specifies the style name and can include any user style name.	FlowElement
		getTextFlow():flashx.textLayout.elements:TextFlow Climbs the text flow hierarchy to return the root TextFlow object for the element.	FlowElement
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setStyle(styleProp:String, newValue:*):void Sets the style specified by the styleProp parameter to the value specified by the newValue parameter.	FlowElement
		shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Makes a copy of this FlowElement object, copying the content between two specified character positions.	FlowElement
		splitAtPosition(relativePosition:int):FlowElement Splits this FlowElement object at the position specified by the relativePosition parameter, which is a relative position in the text for this element.	FlowElement
		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

Property Detail

actualHeight

property

actualHeight:Number [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The actual height in effect. This is the display and compose height that's computed from the height and measuredHeight properties.

The values of the actualHeight property are computed according to the following table:

height property	actualHeight
auto	measuredheight
h a Percent	h percent of measuredheight
h a Number	h

Notes: If the inline graphic is a DisplayObject, its width and height are read immmediately. If measuredWidth or measuredHeight are zero, then any auto calculations that would cause a divide by zero sets the result to zero.

Implementation
public function get actualHeight():Number

See also

height
measuredHeight

actualWidth

property

actualWidth:Number [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The actual width in effect. This is the display and compose width that's computed from the width and measuredWidth properties.

The values of the actualWidthproperty are computed according to the following table:

width property	actualWidth
auto	measuredWidth
w a Percent	w percent of measuredWidth
w a Number	w

Notes: If the inline graphic is a DisplayObject, its width and height are read immediately. If measuredWidth or measuredHeight are zero, then any auto calculations that would cause a divide by zero sets the result to zero.

Implementation
public function get actualWidth():Number

See also

measuredWidth
width

graphic

property

graphic:DisplayObject [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The embedded graphic.

Implementation
public function get graphic():DisplayObject

height

property

height:Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The height of the image. May be 'auto', a number of pixels or a percent of the measured height.

Implementation
public function get height():Object
public function set height(value:Object):void

See also

actualHeight
measuredHeight

measuredHeight

property

measuredHeight:Number [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The natural height of the graphic. This is the height of the graphic at load time.

Implementation
public function get measuredHeight():Number

See also

actualHeight
height

measuredWidth

property

measuredWidth:Number [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The natural width of the graphic. This is the width of the graphic at load time.

Implementation
public function get measuredWidth():Number

See also

actualWidth
width

source

property

source:Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Sets the source for the graphic. The value can be either a String that is interpreted as a URI, a Class that's interpreted as the class of an embeddded DisplayObject, a DisplayObject instance, or a URLRequest. Creates a DisplayObject and, if the InlineGraphicElement object is added into a ParagraphElement in a TextFlow object, causes it to appear inline in the text.

Implementation
public function get source():Object
public function set source(value:Object):void

Example ( How to use this example )

This example displays a span of text followed by an InlineGraphicElement object.


// create a container and a controller for it
var container:Sprite = new Sprite();
this.stage.addChild(container);
// create the TextFlow, ParagraphElement, SpanElement, and InlineGraphicElement objects    
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var inlineGraphicElement:InlineGraphicElement = new InlineGraphicElement();
var span:SpanElement = new SpanElement();
// add the graphic
inlineGraphicElement.source = drawRect();
// add text to the spans, spans and graphic to paragraph        
span.text = "Too much depends upon a ";
span.fontSize = 48;
p.addChild(span); 
p.addChild(inlineGraphicElement);
// add paragraph to text flow and update controller to display
textFlow.addChild(p);
textFlow.flowComposer = new StandardFlowComposer();
var controller:ContainerController = new ContainerController(container, 400, 300 );
textFlow.flowComposer.addController(controller);
textFlow.flowComposer.updateAllControllers(); 
public function drawRect():Sprite
{
    var redRect:Sprite = new Sprite();
    redRect.graphics.beginFill(0xff0000);    // red
    redRect.graphics.drawRect(0,0,30, 30);
    redRect.graphics.endFill();
    return redRect;
}

status

property

status:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The current status of the image. On each status change the owning TextFlow sends a StatusChangeEvent.

Implementation
public function get status():String

width

property

width:Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The width of the graphic. The value can be 'auto', a number of pixels or a percent of the measured width of the image.

Implementation
public function get width():Object
public function set width(value:Object):void

See also

actualWidth
measuredWidth

Constructor Detail

InlineGraphicElement

()

Constructor

public function InlineGraphicElement()

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor - create new InlineGraphicElement object

Examples ( How to use this example )

InlineGraphicElementExample.as

This example displays an inline graphic element between two spans of text.


// create a container and a controller for it
var container:Sprite = new Sprite();
this.stage.addChild(container);
var controller:ContainerController = new ContainerController(container, 400, 200 );
// create the TextFlow, ParagraphElement, SpanElement, and InlineGraphicElement objects    
var textFlow:TextFlow = new TextFlow();
var p:ParagraphElement = new ParagraphElement();
var span1:SpanElement = new SpanElement();
var span2:SpanElement = new SpanElement();
var inlineGraphicElement:InlineGraphicElement = new InlineGraphicElement();
// add the graphic
inlineGraphicElement.source = drwCircle();
// add text to the spans, spans and graphic to paragraph        
span1.text = "You can draw a happy face here ";
span2.text = " if you like."
p.fontSize = 16;
p.addChild(span1);
p.addChild(inlineGraphicElement);
p.addChild(span2); 
// add paragraph to text flow and update controller to display
textFlow.addChild(p);
textFlow.flowComposer = new StandardFlowComposer();
textFlow.flowComposer.addController(controller);
textFlow.flowComposer.updateAllControllers(); 
        
// draw a yellow circle for the graphic element
public function drwCircle():Sprite
{
    var yellowCircle:Sprite = new Sprite();
    yellowCircle.graphics.beginFill(0xFFFF33);    // yellow
    yellowCircle.graphics.drawCircle(10,12,10);
    yellowCircle.graphics.endFill();
    return yellowCircle;
}

Adobe® Flex® 4 Beta Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Show Frames Hide Frames
InlineGraphicElement	Properties \| Methods \| Examples