BreakOpportunity - Adobe ActionScript® 3 (AS3 ) API Reference

Package	flash.text.engine
Class	public final class BreakOpportunity
Inheritance	BreakOpportunity Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5, Flash Lite 4

The BreakOpportunity class is an enumeration of constant values that you can use to set the breakOpportunity property of the ElementFormat class. This property determines which characters can be used for breaking when wrapping text is broken into multiple lines.

Related API Elements

ElementFormat.breakOpportunity

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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
		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

Public Constants

	Constant		Defined By
		ALL : String = "all" [static] Treats all characters in the ContentElement object as line break opportunities, meaning that a line break will occur afer each character.	BreakOpportunity
		ANY : String = "any" [static] Treats any character in the ContentElement object as a line break opportunity.	BreakOpportunity
		AUTO : String = "auto" [static] Bases line break opportunities on Unicode character properties.	BreakOpportunity
		NONE : String = "none" [static] Treats no characters in the ContentElement object as line break opportunities.	BreakOpportunity

Constant Detail

ALL

Constant

public static const ALL:String = "all"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5, Flash Lite 4

Treats all characters in the ContentElement object as line break opportunities, meaning that a line break will occur afer each character. You can use this option to generate the shortest possible lines, which you can use to create text on a line or similar effects.

ANY

Constant

public static const ANY:String = "any"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5, Flash Lite 4

Treats any character in the ContentElement object as a line break opportunity. This value is typically used when Roman text is embedded in Asian text and it is desirable for breaks to happen in the middle of words.

AUTO

Constant

public static const AUTO:String = "auto"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5, Flash Lite 4

Bases line break opportunities on Unicode character properties. This setting implements the Unicode line breaking properties defined by the Unicode Standard Annex #14.

Learn more

Article on Unicode line breaking properties.

NONE

Constant

public static const NONE:String = "none"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5, Flash Lite 4

Treats no characters in the ContentElement object as line break opportunities.

BreakOpportunity - AS3

Classes x

ALL

ANY

AUTO

NONE

flash.text.engine BreakOpportunity - AS3		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples