The ElementFormat used for the element.

The default value is null.

Changing the properties of an ElementFormat object that has been applied to a TextElement does not invalidate the corresponding lines in a text block to which the TextElement belongs. Directly setting the ElementFormat object of the TextElement does invalidate those lines.

See also

The EventDispatcher object that receives copies of every event dispatched to text lines based on this content element. The specified object can be used to set up listeners for a text link or other interactive piece of text, as it can be difficult to determine at runtime which parts of which lines have resulted from which content elements. You can also use listeners to apply decorations such as underlines, the metrics of which you cannot determine until after the text is laid out. The default value is null, which means no mirrored events will be dispatched.

Event mirrors manifest themselves in text lines as instances of the TextLineMirrorRegion class. Depending on bidirectional processing and line breaking, one or more mirror regions can be produced.

The default value is null.

See also

The GroupElement which contains this element, or null if it is not in a group.

The default value is null.

See also

A copy of the text in the element, including the U+FDEF characters representing graphic elements.

A copy of the text in the element, not including the U+FDEF characters representing graphic elements.

See also

The TextBlock to which this element belongs.

The default value is null.

See also

The index in the text block of the first character of this element. Note this value is not cached - it is calculated whenever this method is called.

The default value is 0.

The rotation to apply to the element as a unit. Use TextRotation constants for this property.

The default value is TextRotation.ROTATE_0.

The final rotation of any glyph is the sum of TextBlock.glyphRotation, ElementFormat.textRotation, ContentElement.textRotation, and TextBlock.lineRotation.

ContentElement.textRotation is used to create a short run of text whose rotation differs from the containing line. TCY runs in Japanese text are an example. To create a Paragraph of vertical Japanese text containing a TCY run, do the following:

1. Set TextBlock.glyphRotation=GlyphRotation.FULL_AND_WIDE
2. Set TextBlock.lineRotation=TextRotation.ROTATE_90
3. Set TextBlock.content to a GroupElement, consisting of three TextElement objects. The first of these elements is the Japanese text before the TCY run, the second is the Latin text of the TCY run, and the third is the Japanese text after the TCY run.
4. Set the textRotation property of the TCY TextElement to TextRotation.ROTATE_270. The TCY text element rotates as a unit. It starts with a 90 degree rotation inherited from the line. Adding another 270 degrees takes it around to horizontal.

Rotated content elements cannot be nested. In any hierarchy of content elements, no matter how complex, only one content element can have its textRotation property set. The following methods and property setters throw an argument error if nested rotations are detected:

1. ContentElement.textRotation
2. GroupElement.setElements
3. GroupElement.replaceElements

To set values for this property, use the following string values:

See also

Provides a way for the author to associate arbitrary data with the element.

The default value is null.

Calling the new ContentElement() constructor throws an ArgumentError exception. You can, however, call constructors for the following subclasses of ContentElement:

• new GraphicElement()
• new GroupElement()
• new TextElement()

Used to indicate the presence a graphic element in the text.

See also