| <?xml version="1.0" encoding="UTF-8"?><apiPackage xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="flash.text.engine" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiPackage/apiPackage "><apiName class="- topic/title reference/title apiRef/apiName ">flash.text.engine</apiName><apiDetail class="- topic/body reference/refbody apiRef/apiDetail "/><apiClassifier languages="" id="flash.text.engine:TextLine" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextLine</apiName><shortdesc class="- topic/shortdesc "> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
| --> |
| The TextLine class is used to display text on the display list.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.display:DisplayObjectContainer</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextLine class is used to display text on the display list. |
| |
| <p class="- topic/p ">You cannot create a TextLine object directly from ActionScript code. |
| If you call <codeph class="+ topic/ph pr-d/codeph ">new TextLine()</codeph>, an exception is thrown. |
| To create a TextLine object, call the <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph> method of a TextBlock.</p> |
| |
| <p class="- topic/p ">The TextLine encapsulates the minimum information necessary to render its contents |
| and to provide interactivity through some methods that describe the properties |
| of the atoms of the line. The term atom refers to both graphic elements and characters (including groups of combining characters), |
| the indivisible entities that make up a text line.</p> |
| |
| <p class="- topic/p ">After normal event-dispatching for a text line finishes, if the line is valid, events are mirrored to the event dispatchers that are |
| specified in the <codeph class="+ topic/ph pr-d/codeph ">eventMirror</codeph> properties of the content element objects that contributed to the text line. These objects are recorded in the |
| <codeph class="+ topic/ph pr-d/codeph ">TextLine.mirrorRegions</codeph> property. The events are not mirrored if event propagation failed or was stopped, or if the text line is not valid.</p> |
| |
| <p class="- topic/p ">Mirroring of mouse events is a special case. Because mirror regions aren't actually display objects, <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> and <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph> |
| events are simulated for them. <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> and <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> events are not simulated. All naturally occurring |
| <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph>, <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph>, <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> and <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> events (whether targeted at the |
| text line or at children of the text line) are ignored - they are not mirrored.</p> |
| |
| <p class="- topic/p ">The origin of a text line object is the beginning of the baseline. If you don't set the vertical position (<codeph class="+ topic/ph pr-d/codeph ">y</codeph> property) |
| of a line that contains Latin text on a Roman baseline, only the descenders of the text appear below the top of the Sprite to which |
| you add the text line. See the following diagram:</p> |
| |
| <p class="- topic/p "><adobeimage alt="Text baselines" href="../../../images/TextLine.gif" placement="inline" class="+ topic/image adobe-d/adobeimage "/></p> |
| |
| <p class="- topic/p ">The TextLine class has several ancestor classes — DisplayObjectContainer, InteractiveObject, |
| DisplayObject, and EventDispatcher — from which it inherits properties and methods. |
| The following inherited properties are inapplicable to TextLine objects: </p> |
| |
| <ul class="- topic/ul "><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">contextMenu</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">focusRect</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">tabChildren</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">tabEnabled</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph></li></ul> |
| |
| <p class="- topic/p ">If you try to set these properties, the text engine throws the error: IllegalOperationError. You can read these properties, but they |
| always contain default values.</p> |
| |
| </apiDesc><example conref="examples\TextLineExample.as" class="- topic/example "> This example displays various text lines and steps through the atoms in a text |
| block, using <codeph class="+ topic/ph pr-d/codeph ">getAtomBounds()</codeph> to frame each one. |
| <ol class="- topic/ol "><li class="- topic/li ">Add the NumericStepper component to the library.</li><li class="- topic/li ">Save this code as TextLineExample.as in the same directory as your FLA.</li><li class="- topic/li ">Set the Class in the Properties window of the FLA to TextLineExample.</li></ol> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| package { |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.FontPosture; |
| import flash.text.engine.FontWeight; |
| import fl.controls.NumericStepper; |
| import flash.events.Event; |
| import flash.geom.Rectangle; |
| |
| public class TextLineExample extends Sprite { |
| |
| private var atomStepper:NumericStepper = new NumericStepper(); |
| private var atomDataContainer:Sprite; |
| private var fontDescriptionItalic:FontDescription = new FontDescription("Arial", FontWeight.NORMAL, FontPosture.ITALIC); |
| private var fontDescriptionNormal:FontDescription = new FontDescription("Arial", FontWeight.NORMAL , FontPosture.NORMAL); |
| private var textBlock:TextBlock = new TextBlock(); |
| private var textLine:TextLine; |
| |
| public function TextLineExample():void { |
| |
| var myText:String = "I am a TextElement, created from a String and assigned " + |
| "to the content property of a TextBlock. From the text block, " + |
| "the createTextLine() method created these lines, 300 pixels wide, " + |
| "for display." ; |
| |
| atomStepper.minimum = 0; |
| atomStepper.value = 0; |
| atomStepper.width = 50; |
| addChild(atomStepper); |
| atomStepper.x = 20; |
| atomStepper.y = 120; |
| atomStepper.addEventListener(Event.CHANGE, nsChange); |
| |
| var directions:String = "Click up / down arrows to frame atoms in text block above."; |
| |
| var formatItalic:ElementFormat = new ElementFormat(fontDescriptionItalic); |
| formatItalic.fontSize = 12; |
| var textElement1:TextElement = new TextElement(directions, formatItalic); |
| textBlock.content = textElement1; |
| createLines(textBlock, 15, 160, 400, this); |
| |
| var formatNormal:ElementFormat = new ElementFormat(fontDescriptionNormal); |
| formatNormal.fontSize = 16; |
| var textElement2:TextElement = new TextElement(myText, formatNormal); |
| textBlock.content = textElement2; |
| createLines(textBlock, 15.0, 20.0, 300, this); |
| textLine = textBlock.firstLine; |
| atomStepper.maximum = textLine.atomCount - 1; |
| showAtom(textLine, 0); |
| } |
| |
| private function nsChange(event:Event):void |
| { |
| removeAtom(textLine); |
| if (atomStepper.value == textLine.atomCount - 1) |
| { |
| if(textLine != textBlock.lastLine) |
| { |
| textLine = textLine.nextLine; |
| atomStepper.maximum = textLine.atomCount - 1; |
| atomStepper.value = 0; |
| } |
| } |
| showAtom(textLine, atomStepper.value); |
| } |
| |
| private function createLines(textBlock, startX, startY, width, container) |
| { |
| var textLine:TextLine = textBlock.createTextLine (null, width); |
| while (textLine) |
| { |
| textLine.x = startX; |
| textLine.y = startY; |
| startY += textLine.height + 2; |
| container.addChild(textLine); |
| textLine = textBlock.createTextLine (textLine, width); |
| } |
| } |
| |
| private function showAtom(textLine, i):void |
| { |
| var box:Sprite = new Sprite(); |
| var mcGraphics = box.graphics; |
| var bounds:Rectangle = textLine.getAtomBounds(i); |
| mcGraphics.lineStyle(1, 0xFF0000, 1.0); |
| mcGraphics.drawRect(bounds.left, bounds.top, bounds.width, bounds.height); |
| textLine.userData = textLine.addChild(box); |
| displayAtomData(textLine,i); |
| } |
| |
| private function displayAtomData(textLine, i) |
| { |
| if(atomDataContainer != null) |
| removeChild(atomDataContainer); |
| atomDataContainer=new Sprite(); |
| var format = new ElementFormat(fontDescriptionNormal); |
| format.color = 0x00000FF; |
| var n:int = 0; |
| var nxtY:Number = 0; |
| var atomInfo:String = "value of getAtomBidiLevel() is: " + textLine.getAtomBidiLevel(i)+"\n" |
| +"value of getAtomCenter() is: " + textLine.getAtomCenter(i)+"\n" |
| +"value of getAtomIndexAtCharIndex() is: " + textLine.getAtomIndexAtCharIndex(i)+"\n" |
| +"value of getAtomTextBlockBeginIndex() is: " + textLine.getAtomTextBlockBeginIndex(i)+"\n" |
| +"value of getAtomTextBlockEndIndex() is: " + textLine.getAtomTextBlockEndIndex(i)+"\n" |
| +"value of getAtomTextRotation() is: " + textLine.getAtomTextRotation(i)+"\n"; |
| var atomtextBlock:TextBlock = new TextBlock(); |
| var textElement3:TextElement = new TextElement(atomInfo, format); |
| atomtextBlock.content = textElement3; |
| createLines(atomtextBlock,20,200,500, atomDataContainer) |
| addChild(atomDataContainer); |
| } |
| |
| private function removeAtom(textLine):void |
| { |
| textLine.removeChild(textLine.userData); |
| } |
| } |
| } |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/eventMirror" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.eventMirror</linktext></link><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link><link href="flash.text.engine.xml#TextLineValidity" class="- topic/link "><linktext class="- topic/linktext ">TextLineValidity</linktext></link></related-links><apiOperation id="flash.text.engine:TextLine:dump" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">dump</apiName><shortdesc class="- topic/shortdesc "> |
| Dumps the underlying contents of the TextLine as an XML string.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Dumps the underlying contents of the TextLine as an XML string. |
| This can be useful in automated testing, and includes text, formatting, and layout information. |
| |
| <p class="- topic/p ">The following describes the output:</p> |
| |
| <pre xml:space="preserve" class="- topic/pre "> |
| [LINE] |
| <line ascent=[Number] descent=[Number] rotation=[int]> |
| <elements> |
| [0-N ELEMENT] |
| </elements> |
| <clusters> |
| [0-N CLUSTER] |
| </clusters> |
| </line> |
| |
| [ELEMENT] |
| <glyph isEmbedded=[Boolean] fontName=[String] isBold=[Boolean] isItalic=[Boolean] gid=[int] pointSize=[Number] x=[Number] y=[Number] rotation=[int]/> |
| or |
| <graphic child=[int] x=[Number] y=[Number] rotation=[int]/> |
| or |
| <embeddedRun x=[Number] y=[Number]> |
| [LINE] |
| </embeddedRun> |
| |
| [CLUSTER] |
| <cluster xLeft=[Number] xCenter=[Number] xRight=[Number] cursorOnLeft=[Boolean] cursorOnRight=[Boolean] wordBoundaryOnLeft=[Boolean] wordBoundaryOnRight=[Boolean]/> |
| </pre> |
| |
| <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> The content and format of the output from this method could change in the future. Adobe does not guarantee backward |
| compatibility for this method.</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/dump()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.dump()</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextLine:flushAtomData" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">flushAtomData</apiName><shortdesc class="- topic/shortdesc "> |
| This method is deprecated and has no effect.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn><apiDeprecated sinceVersion="Flash Player 10.1"><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Now does nothing</apiDesc></apiDeprecated></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| This method is deprecated and has no effect. Atom data is compressed and is not a factor in managing memory efficiency. |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/dump()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.dump()</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomBidiLevel" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomBidiLevel</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the bidirectional level of the atom at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The specified atom index is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The bidirectional level of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the bidirectional level of the atom at the specified index. Determined by a combination of |
| <codeph class="+ topic/ph pr-d/codeph ">TextBlock.bidiLevel</codeph> and the Unicode bidirectional properties of the characters that |
| form the line. |
| |
| <p class="- topic/p ">For example, if you start a text block with some Hebrew text, you set <codeph class="+ topic/ph pr-d/codeph ">TextBlock.bidiLevel</codeph> to 1, establishing |
| a default of right to left. If within the text you have a quote in English (left to right), that text has an <codeph class="+ topic/ph pr-d/codeph ">AtomBidiLevel</codeph> of |
| 2. If within the English you have a bit of Arabic (right to left), <codeph class="+ topic/ph pr-d/codeph ">AtomBidiLevel</codeph> for that run goes to 3. If within the |
| Arabic a number (left to right) occurs, the <codeph class="+ topic/ph pr-d/codeph ">AtomBidiLevel</codeph> setting for the number is 4. It does not matter in which line the |
| atoms end up; the Hebrew atoms are <codeph class="+ topic/ph pr-d/codeph ">AtomBidiLevel</codeph> 1, the English atoms are <codeph class="+ topic/ph pr-d/codeph ">AtomBidiLevel</codeph> 2, Arabic atoms |
| are <codeph class="+ topic/ph pr-d/codeph ">AtomBidiLevel</codeph> 3, and the number atoms are <codeph class="+ topic/ph pr-d/codeph ">AtomBidiLevel</codeph> 4.</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/bidiLevel" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.bidiLevel</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomBounds" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomBounds</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the bounds of the atom at the specified index relative to the text line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The atom index specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The bounds of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Rectangle</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the bounds of the atom at the specified index relative to the text line. The bounds of the specified atom consist of |
| its horizontal position (<codeph class="+ topic/ph pr-d/codeph ">x</codeph>) in the line, its vertical position in the line (<codeph class="+ topic/ph pr-d/codeph ">y</codeph>), its width (<codeph class="+ topic/ph pr-d/codeph ">w</codeph>), |
| and its height (<codeph class="+ topic/ph pr-d/codeph ">h</codeph>). All values are in pixels. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomCenter" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomCenter</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the center of the atom as measured along the baseline at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The atom index specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The center of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the center of the atom as measured along the baseline at the specified index. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomGraphic" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomGraphic</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the graphic of the atom at the specified index, or null if the atom is a character.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The atom index specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The graphic of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.display:DisplayObject</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the graphic of the atom at the specified index, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if the atom is a character. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomIndexAtCharIndex" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomIndexAtCharIndex</apiName><shortdesc class="- topic/shortdesc "> |
| Returns the index of the atom containing the character specified by the charIndex parameter, |
| or -1 if the character does not contribute to any atom in the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the atom containing the character at <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph>. |
| Returns -1 if the character does not contribute to any atom in the line. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">charIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the character (for example, the first character is 0, |
| the second character is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns the index of the atom containing the character specified by the <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph> parameter, |
| or -1 if the character does not contribute to any atom in the line. |
| The <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph> is relative to the entire contents of the text block containing the line. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomIndexAtPoint" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomIndexAtPoint</apiName><shortdesc class="- topic/shortdesc "> |
| Returns the index of the atom at the point specified by the x |
| and y parameters, or -1 if no atom exists at that point.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the atom under the point. Returns -1 if the point is not over any atom. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">stageX</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The global <i class="+ topic/ph hi-d/i ">x</i> coordinate of the point to test. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">stageY</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The global <i class="+ topic/ph hi-d/i ">y</i> coordinate of the point to test. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns the index of the atom at the point specified by the <codeph class="+ topic/ph pr-d/codeph ">x</codeph> |
| and <codeph class="+ topic/ph pr-d/codeph ">y</codeph> parameters, or -1 if no atom exists at that point. |
| |
| <p class="- topic/p ">This method takes global coordinates so that you can easily use it with <codeph class="+ topic/ph pr-d/codeph ">MouseEvent.stageX</codeph> |
| and <codeph class="+ topic/ph pr-d/codeph ">MouseEvent.stageY</codeph> properties.</p> |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomTextBlockBeginIndex" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomTextBlockBeginIndex</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the text block begin index of the atom at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The atom index specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The text block begin index of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the text block begin index of the atom at the specified index. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomTextBlockEndIndex" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomTextBlockEndIndex</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the text block end index of the atom at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The atom index specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The text block end index of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the text block end index of the atom at the specified index. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomTextRotation" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomTextRotation</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the rotation of the atom at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The specified atom index is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rotation of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the rotation of the atom at the specified index. TextRotation constants are used for this property. |
| The rotation of the atom is the cumulative rotations of the element and the line. Its primary use is for |
| setting the orientation of the caret (cursor) when interacting with a TextLine. |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/textRotation" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.textRotation</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextLine:getAtomWordBoundaryOnLeft" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getAtomWordBoundaryOnLeft</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates whether a word boundary occurs to the left of the atom at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The atom index specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Boolean value that indicates whether a word boundary occurs to the left of the atom at <codeph class="+ topic/ph pr-d/codeph ">atomIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">atomIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the atom (for example, the first atom is 0, |
| the second atom is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates whether a word boundary occurs to the left of the atom at the specified index. |
| Word boundaries are determined based on the Unicode properties of the characters which contributed to the line. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextLine:getBaselinePosition" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getBaselinePosition</apiName><shortdesc class="- topic/shortdesc "> |
| Gets the position of the specified baseline, relative to TextBlock.baselineZero.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the <codeph class="+ topic/ph pr-d/codeph ">baseline</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The position of the specified baseline relative to <codeph class="+ topic/ph pr-d/codeph ">TextBlock.baselineZero</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">baseline</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The baseline for which to retrieve the position. Use <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph> values. |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Gets the position of the specified baseline, relative to <codeph class="+ topic/ph pr-d/codeph ">TextBlock.baselineZero</codeph>. |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link><link href="flash.text.engine.xml#TextBaseline" class="- topic/link "><linktext class="- topic/linktext ">TextBaseline</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextLine:getMirrorRegion" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getMirrorRegion</apiName><shortdesc class="- topic/shortdesc "> |
| Returns the first TextLineMirrorRegion on the line whose mirror property matches |
| that specified by the mirror parameter, or null if no match exists.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The first <codeph class="+ topic/ph pr-d/codeph ">TextLineMirrorRegion</codeph> on the line whose <codeph class="+ topic/ph pr-d/codeph ">mirror</codeph> property matches |
| the specified value, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if no match exists. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLineMirrorRegion</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">mirror</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.events:EventDispatcher</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">EventDispatcher</codeph> mirror object to search for. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns the first <codeph class="+ topic/ph pr-d/codeph ">TextLineMirrorRegion</codeph> on the line whose <codeph class="+ topic/ph pr-d/codeph ">mirror</codeph> property matches |
| that specified by the <codeph class="+ topic/ph pr-d/codeph ">mirror</codeph> parameter, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if no match exists. |
| <p class="- topic/p ">Even a single <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> can produce multiple <codeph class="+ topic/ph pr-d/codeph ">TextLineMirrorRegion</codeph> |
| objects on one or more lines, depending on bidirectional level and line breaking. The <codeph class="+ topic/ph pr-d/codeph ">nextRegion</codeph> and |
| <codeph class="+ topic/ph pr-d/codeph ">previousRegion</codeph> properties link all the mirror regions generated from one text element.</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLineMirrorRegion" class="- topic/link "><linktext class="- topic/linktext ">TextLineMirrorRegion</linktext></link><link href="flash.text.engine.xml#ContentElement/eventMirror" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.eventMirror</linktext></link></related-links></apiOperation><apiValue id="flash.text.engine:TextLine:MAX_LINE_WIDTH" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">MAX_LINE_WIDTH</apiName><shortdesc class="- topic/shortdesc "> |
| The maximum requested width of a text line, in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">1000000</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The maximum requested width of a text line, in pixels. The <codeph class="+ topic/ph pr-d/codeph ">TextBlock.createTextLine()</codeph> method uses this constant |
| as the default value for the <codeph class="+ topic/ph pr-d/codeph ">width</codeph> parameter, if you do not specify a value. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:userData" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">userData</apiName><shortdesc class="- topic/shortdesc "> |
| Provides a way for the application to associate arbitrary data with the text line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiType value="" name="type" class="- topic/state reference/state apiRef/apiType "/></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Provides a way for the application to associate arbitrary data with the text line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:ascent:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ascent</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the number of pixels from the baseline to the top of the tallest characters in the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the number of pixels from the baseline to the top of the tallest characters in the line. For a TextLine that contains only a |
| graphic element, <codeph class="+ topic/ph pr-d/codeph ">ascent</codeph> is set to 0. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:atomCount:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">atomCount</apiName><shortdesc class="- topic/shortdesc "> |
| The number of atoms in the line, which is the number of indivisible elements, including spaces and graphic |
| elements.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The number of atoms in the line, which is the number of indivisible elements, including spaces and graphic |
| elements. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:descent:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">descent</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the number of pixels from the baseline to the bottom of the lowest-descending characters in the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the number of pixels from the baseline to the bottom of the lowest-descending characters in the line. For a TextLine that |
| contains only a graphic element, <codeph class="+ topic/ph pr-d/codeph ">descent</codeph> is set to 0. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:hasGraphicElement:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">hasGraphicElement</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates whether the text line contains any graphic elements.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates whether the text line contains any graphic elements. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#GraphicElement" class="- topic/link "><linktext class="- topic/linktext ">GraphicElement</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:hasTabs:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">hasTabs</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates whether the text line contains any tabs.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates whether the text line contains any tabs. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:mirrorRegions:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">mirrorRegions</apiName><shortdesc class="- topic/shortdesc "> |
| A Vector containing the TextLineMirrorRegion objects associated with the line, or null if none exist.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiType value="Vector$flash.text.engine:TextLineMirrorRegion" name="type" class="- topic/state reference/state apiRef/apiType "/></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| A Vector containing the <codeph class="+ topic/ph pr-d/codeph ">TextLineMirrorRegion</codeph> objects associated with the line, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if none exist. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/eventMirror" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.eventMirror</linktext></link><link href="flash.text.engine.xml#TextLineMirrorRegion" class="- topic/link "><linktext class="- topic/linktext ">TextLineMirrorRegion</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:nextLine:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">nextLine</apiName><shortdesc class="- topic/shortdesc "> |
| The next TextLine in the TextBlock, or null if the current line is the last line in the block |
| or the validity of the line is TextLineValidity.STATIC.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLine</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The next TextLine in the TextBlock, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if the current line is the last line in the block |
| or the validity of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine/previousLine" class="- topic/link "><linktext class="- topic/linktext ">previousLine</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:previousLine:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">previousLine</apiName><shortdesc class="- topic/shortdesc "> |
| The previous TextLine in the TextBlock, or null if the line is the first line in the block |
| or the validity of the line is TextLineValidity.STATIC.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLine</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The previous TextLine in the TextBlock, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if the line is the first line in the block |
| or the validity of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine/nextLine" class="- topic/link "><linktext class="- topic/linktext ">nextLine</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:rawTextLength:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">rawTextLength</apiName><shortdesc class="- topic/shortdesc "> |
| The length of the raw text in the text block that became the line, |
| including the U+FDEF characters representing graphic elements |
| and any trailing spaces, which are part of the line but not are displayed.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The length of the raw text in the text block that became the line, |
| including the U+FDEF characters representing graphic elements |
| and any trailing spaces, which are part of the line but not are displayed. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link><link href="flash.text.engine.xml#ContentElement/rawText" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.rawText</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:specifiedWidth:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">specifiedWidth</apiName><shortdesc class="- topic/shortdesc "> |
| The width that was specified to the TextBlock.createTextLine() method when it created the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The width that was specified to the <codeph class="+ topic/ph pr-d/codeph ">TextBlock.createTextLine()</codeph> method when it created the line. |
| This value is useful when deciding if a change requires rebreaking the line. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link><link href="flash.text.engine.xml#TextLine/textWidth" class="- topic/link "><linktext class="- topic/linktext ">textWidth</linktext></link><link href="flash.text.engine.xml#TextLine/unjustifiedTextWidth" class="- topic/link "><linktext class="- topic/linktext ">unjustifiedTextWidth</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:textBlockBeginIndex:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textBlockBeginIndex</apiName><shortdesc class="- topic/shortdesc "> |
| The index of the first character of the line in the raw text of the text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The index of the first character of the line in the raw text of the text block. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:textBlock:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textBlock</apiName><shortdesc class="- topic/shortdesc "> |
| The TextBlock containing this text line, or null if the validity of the line is TextLineValidity.STATIC, |
| meaning that the connection between the line and the TextBlock has been severed.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextBlock</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextBlock containing this text line, or null if the validity of the line is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>, |
| meaning that the connection between the line and the TextBlock has been severed. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link><link href="flash.text.engine.xml#TextLineValidity" class="- topic/link "><linktext class="- topic/linktext ">TextLineValidity</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:textHeight:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textHeight</apiName><shortdesc class="- topic/shortdesc "> |
| The logical height of the text line, which is equal to ascent + descent.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The logical height of the text line, which is equal to <codeph class="+ topic/ph pr-d/codeph ">ascent</codeph> + <codeph class="+ topic/ph pr-d/codeph ">descent</codeph>. |
| To get the inked height, access the inherited <codeph class="+ topic/ph pr-d/codeph ">height</codeph> property. |
| |
| <p class="- topic/p ">The value is calculated based on the difference between the baselines that bound the line, |
| either ideo top/bottom or ascent/descent depending on whether TextBlock.baselineZero is ideo or not. |
| Graphic elements are not considered when computing these baselines.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/height" class="- topic/link "><linktext class="- topic/linktext ">DisplayObject.height</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:textWidth:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textWidth</apiName><shortdesc class="- topic/shortdesc "> |
| The logical width of the text line, which is the width that the text engine uses to lay out the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The logical width of the text line, which is the width that the text engine uses to lay out the line. Access the inherited |
| <codeph class="+ topic/ph pr-d/codeph ">width</codeph> property to get the actual width of the bounding box of all the drawn pixels. |
| |
| </apiDesc><example conref="examples\TextLine_textWidthExample.as" class="- topic/example "> This example displays a line once in normal posture and once in |
| italic, and traces the values of the <codeph class="+ topic/ph pr-d/codeph ">specifiedWidth</codeph>, <codeph class="+ topic/ph pr-d/codeph ">textWidth</codeph> |
| and <codeph class="+ topic/ph pr-d/codeph ">width</codeph> properties in each case. |
| The trace output is: |
| <ul class="- topic/ul "><li class="- topic/li ">specifiedWidth is: 500</li><li class="- topic/li ">textWidth is: 268.9921875</li><li class="- topic/li ">width is: 269</li><li class="- topic/li ">specifiedWidth is: 500</li><li class="- topic/li ">textWidth is: 267.52734375</li><li class="- topic/li ">width is: 267.55</li></ul> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.FontPosture; |
| |
| public class TextLine_textWidthExample extends Sprite { |
| |
| public function TextLine_textWidthExample() { |
| |
| var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, "; |
| var yPos:Number = 20; |
| var fontDescription:FontDescription = new FontDescription(); |
| var textBlock:TextBlock = new TextBlock(); |
| fontDescription.fontPosture = FontPosture.NORMAL; |
| var format:ElementFormat = new ElementFormat(fontDescription, 12); |
| var textElement:TextElement = new TextElement(str, format); |
| textBlock.content = textElement; |
| createLine(textBlock, yPos); |
| var fontDescriptionItalic = fontDescription.clone(); |
| fontDescriptionItalic.fontPosture = FontPosture.ITALIC; |
| var formatItalic = new ElementFormat(fontDescriptionItalic, 12); |
| textElement = new TextElement(str, formatItalic); |
| textBlock.content = textElement; |
| createLine(textBlock, yPos + 20); |
| } |
| |
| private function createLine(textBlock:TextBlock, yPos:Number):void { |
| var textLine:TextLine = textBlock.createTextLine (null, 500); |
| trace("specifiedWidth is: " + textLine.specifiedWidth); |
| trace("textWidth is: " + textLine.textWidth); |
| trace("width is: " + textLine.width); |
| addChild(textLine); |
| textLine.x = 15; |
| textLine.y = yPos; |
| } |
| } |
| } |
| |
| </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine/specifiedWidth" class="- topic/link "><linktext class="- topic/linktext ">specifiedWidth</linktext></link><link href="flash.display.xml#DisplayObject/width" class="- topic/link "><linktext class="- topic/linktext ">DisplayObject.width</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:totalAscent:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">totalAscent</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the number of pixels from the baseline to the top of the tallest character or graphic in the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the number of pixels from the baseline to the top of the tallest character or graphic in the line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:totalDescent:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">totalDescent</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the number of pixels from the baseline to the bottom of the lowest-descending character or graphic in the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the number of pixels from the baseline to the bottom of the lowest-descending character or graphic in the line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:totalHeight:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">totalHeight</apiName><shortdesc class="- topic/shortdesc "> |
| The total logical height of the text line, which is equal to totalAscent + totalDescent.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The total logical height of the text line, which is equal to <codeph class="+ topic/ph pr-d/codeph ">totalAscent</codeph> + <codeph class="+ topic/ph pr-d/codeph ">totalDescent</codeph>. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLine:unjustifiedTextWidth:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">unjustifiedTextWidth</apiName><shortdesc class="- topic/shortdesc "> |
| The width of the line if it was not justified.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The width of the line if it was not justified. For unjustified text, this value is the same as <codeph class="+ topic/ph pr-d/codeph ">textWidth</codeph>. For |
| justified text, this value is what the length would have been without justification, and <codeph class="+ topic/ph pr-d/codeph ">textWidth</codeph> represents |
| the actual line width. For example, when the following String is justified and submitted to <codeph class="+ topic/ph pr-d/codeph ">TextBlock.createTextLine()</codeph> |
| with a width of 500, it has an actual width of 500 but an unjustified width of 268.9921875. |
| |
| </apiDesc><example class="- topic/example ">When the String in the following example is justified and submitted to TextBlock.createTextLine() with a width of 500, |
| it gets an actual width of 500 but has an unjustified width of 268.9921875. |
| <codeblock rev="3.0" xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.SpaceJustifier; |
| import flash.text.engine.LineJustification; |
| |
| var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, "; |
| var fontDescription:FontDescription = new FontDescription(); |
| var textBlock:TextBlock = new TextBlock(); |
| var format:ElementFormat = new ElementFormat(fontDescription, 12); |
| var textElement:TextElement = new TextElement(str, format); |
| textBlock.content = textElement; |
| var spaceJustifier:SpaceJustifier = new SpaceJustifier("en", LineJustification.ALL_INCLUDING_LAST); |
| textBlock.textJustifier = spaceJustifier; |
| var textLine:TextLine = textBlock.createTextLine(null, 500); |
| textLine.y = 20; |
| |
| addChild(textLine); |
| trace("textWidth value is: " + textLine.textWidth); // 500.00244140625 |
| trace("unjustifiedTextWidth is: " + textLine.unjustifiedTextWidth); // 268.9921875 |
| </codeblock> |
| |
| </example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#EastAsianJustifier" class="- topic/link "><linktext class="- topic/linktext ">EastAsianJustifier</linktext></link><link href="flash.text.engine.xml#LineJustification" class="- topic/link "><linktext class="- topic/linktext ">LineJustification</linktext></link><link href="flash.text.engine.xml#SpaceJustifier" class="- topic/link "><linktext class="- topic/linktext ">SpaceJustifier</linktext></link><link href="flash.text.engine.xml#TextLine/specifiedWidth" class="- topic/link "><linktext class="- topic/linktext ">specifiedWidth</linktext></link><link href="flash.text.engine.xml#TextLine/textWidth" class="- topic/link "><linktext class="- topic/linktext ">textWidth</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextLine:validity:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">validity</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the current validity of the text line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If current value is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.STATIC</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If current value is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.INVALID</codeph> and new value is anything other than |
| <codeph class="+ topic/ph pr-d/codeph ">TextValidity.STATIC</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If current value is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.POSSIBLY_INVALID</codeph> and new value is |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.VALID</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If new value is <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.POSSIBLY_INVALID</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the current validity of the text line. |
| Values for this property are found in the members of the |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity</codeph> class. |
| The rules for setting this property are as follows: |
| |
| <p class="- topic/p ">A line is considered USER_INVALID if validity is set to any string which is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity</codeph>. |
| USER_INVALID is an abstraction used here to represent any such value.</p> |
| |
| <p class="- topic/p ">When the contents of the TextBlock are modified, the Flash runtime marks affected text lines, the previous line, and all following lines as INVALID. |
| The previous line must be marked invalid when a change allows the previous line to absorb part of the content that was |
| originally on the first affected line.</p> |
| |
| <p class="- topic/p ">Newly broken lines are always VALID. The Flash runtime may change lines that follow from VALID to POSSIBLY_INVALID or INVALID. |
| It may change POSSIBLY_INVALID lines to VALID if the line breaks match up, or to INVALID if they don't.</p> |
| |
| <p class="- topic/p ">Application code can mark VALID lines as INVALID or USER_INVALID, and can mark USER_INVALID lines as VALID. Application code cannot mark lines POSSIBLY_INVALID.</p> |
| |
| <p class="- topic/p ">Application code can mark any line STATIC. Doing so causes the <codeph class="+ topic/ph pr-d/codeph ">block</codeph> member to become <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| Any graphic elements in a STATIC text line are removed and reparented if they are part of a new text line broken |
| from the text block from which the STATIC text line originally derived.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/firstInvalidLine" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.firstInvalidLine</linktext></link><link href="flash.text.engine.xml#TextLineValidity" class="- topic/link "><linktext class="- topic/linktext ">TextLineValidity</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TabStop" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TabStop</apiName><shortdesc class="- topic/shortdesc "> |
| The TabStop class represents the properties of a tab stop in a text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TabStop class represents the properties of a tab stop in a text block. You assign tab stops as a Vector of TabStop objects |
| to the <codeph class="+ topic/ph pr-d/codeph ">TextBlock.tabStops</codeph> property. |
| |
| <p class="- topic/p ">Setting the properties of a TabStop object after you apply it to a TextBlock does not invalidate the TextBlock.</p> |
| |
| </apiDesc><example conref="examples\TabStopExample.as" class="- topic/example "> This example illustrates the effects of the four tab stop alignment settings - START, |
| CENTER, DECIMAL, and END. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| package { |
| |
| import flash.text.engine.*; |
| import flash.display.Sprite; |
| |
| public class TabStopExample extends Sprite { |
| |
| public function TabStopExample():void { |
| var container:Sprite = new Sprite(); |
| |
| var english:ElementFormat = new ElementFormat(); |
| english.fontDescription = new FontDescription("Arial"); |
| english.fontSize = 16; |
| english.locale = "en"; |
| |
| var tabStops:Vector.<TabStop> = new Vector.<TabStop>(); |
| tabStops.push( |
| new TabStop(TabAlignment.START, 20), |
| new TabStop(TabAlignment.CENTER, 120), |
| new TabStop(TabAlignment.DECIMAL, 220, "."), |
| new TabStop(TabAlignment.END, 320) |
| ); |
| |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = new TextElement( |
| "\tstart\tcenter\tdeci.mal\tend\n" + |
| "\tl\tl\t3.4\tl\n" + |
| "\tlm\tlm\t234.56\tlm\n" + |
| "\tlmn\tlmn\t12345678.34567\tlmn\n" |
| , english); |
| textBlock.tabStops = tabStops; |
| var y:Number = 60; |
| var previousTextLine:TextLine = null; |
| var textLine:TextLine; |
| var i:int; |
| var tabOrigin:Number = 100; |
| for (i = 0; i < 4; i++) { |
| textLine = textBlock.createTextLine(previousTextLine, 1000, 0); |
| textLine.x = 20; |
| textLine.y = y; |
| |
| container.addChild(textLine); |
| |
| y += 25; |
| previousTextLine = textLine; |
| } |
| addChild(container); |
| } |
| } |
| } |
| |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/tabStops" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.tabStops</linktext></link><link href="flash.text.engine.xml#TabAlignment" class="- topic/link "><linktext class="- topic/linktext ">TabAlignment</linktext></link></related-links><apiConstructor id="flash.text.engine:TabStop:TabStop" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">TabStop</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a new TabStop.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">alignment</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TabAlignment</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">alignment</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">start</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The tab alignment type of this tab stop. |
| Valid values for this property are found in the members of the <codeph class="+ topic/ph pr-d/codeph ">TabAlignment</codeph> class. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">TabAlignment.START</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">position</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The position of the tab stop, in pixels. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">0.0</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">decimalAlignmentToken</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData "/><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The alignment token to be used if the <codeph class="+ topic/ph pr-d/codeph ">alignment</codeph> is <codeph class="+ topic/ph pr-d/codeph ">TabAlignment.DECIMAL</codeph>, |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">""</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a new TabStop. |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TabAlignment" class="- topic/link "><linktext class="- topic/linktext ">TabAlignment</linktext></link></related-links></apiConstructor><apiValue id="flash.text.engine:TabStop:alignment:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">alignment</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the tab alignment for this tab stop.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value that is not a member of <codeph class="+ topic/ph pr-d/codeph ">TabAlignment</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the tab alignment for this tab stop. Use the constants in the TabAlignment class to |
| set this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">TabAlignment.START</codeph>.</p> |
| |
| <p class="- topic/p ">Use the <codeph class="+ topic/ph pr-d/codeph ">lineOffset</codeph> argument to <codeph class="+ topic/ph pr-d/codeph ">TextBlock.createTextLine()</codeph> |
| to adjust the tabs if the origin of the line does not align with other lines that |
| share the same tab stops.</p> |
| |
| <p class="- topic/p ">Use the following constants from the TabAlignment class to set the value for this property:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TabAlignment.START</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">position</codeph> property specifies the number of pixels that the <i class="+ topic/ph hi-d/i ">start</i> of the tabbed text is from the start of the text line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TabAlignment.CENTER</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">position</codeph> property specifies the number of pixels that the <i class="+ topic/ph hi-d/i ">center</i> of the tabbed text is from the start of the text line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TabAlignment.END</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">position</codeph> property specifies the number of pixels that the <i class="+ topic/ph hi-d/i ">end</i> of the tabbed text is from the start of the text line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TabAlignment.DECIMAL</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">position</codeph> property specifies the number of pixels that the alignment token is from the start of the text line.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TabAlignment" class="- topic/link "><linktext class="- topic/linktext ">TabAlignment</linktext></link><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TabStop:decimalAlignmentToken:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">decimalAlignmentToken</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the alignment token to use when you set the alignment property to TabAlignment.DECIMAL.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the alignment token to use when you set the <codeph class="+ topic/ph pr-d/codeph ">alignment</codeph> property to <codeph class="+ topic/ph pr-d/codeph ">TabAlignment.DECIMAL</codeph>. The value |
| is a String that occurs in the text line. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">""</codeph>.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TabAlignment/DECIMAL" class="- topic/link "><linktext class="- topic/linktext ">TabAlignment.DECIMAL</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TabStop:position:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">position</apiName><shortdesc class="- topic/shortdesc "> |
| The position of the tab stop, in pixels, relative to the start of the text line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to a value less than 0.0. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The position of the tab stop, in pixels, relative to the start of the text line. |
| |
| <p class="- topic/p ">The default value is 0.0.</p> |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:FontLookup" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">FontLookup</apiName><shortdesc class="- topic/shortdesc "> |
| The FontLookup class is an enumeration of constant values used with FontDescription.fontLookup.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The FontLookup class is an enumeration of constant values used with <codeph class="+ topic/ph pr-d/codeph ">FontDescription.fontLookup</codeph>. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/fontLookup" class="- topic/link "><linktext class="- topic/linktext ">FontDescription.fontLookup</linktext></link></related-links><apiValue id="flash.text.engine:FontLookup:DEVICE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">DEVICE</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate device font lookup.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">device</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate device font lookup. |
| The Flash runtime uses the fonts installed on the system that is running application. |
| |
| <p class="- topic/p ">Using device fonts results in a smaller movie size, because font data |
| is not included in the file.</p> |
| |
| <p class="- topic/p ">Text rendered with device fonts is not always displayed the same across different |
| systems and platforms, because the Flash runtime uses the fonts that are installed on the system.</p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontLookup:EMBEDDED_CFF" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">EMBEDDED_CFF</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate embedded CFF (Compact Font Format) font lookup.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">embeddedCFF</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate embedded CFF (Compact Font Format) font lookup. |
| The Flash runtime uses font outlines embedded in the published application. |
| |
| <p class="- topic/p ">Text rendered with embedded fonts is always displayed |
| in the chosen font, whether that font is installed |
| on the playback system or not.</p> |
| |
| <p class="- topic/p ">One drawback to embedded fonts is that they increase the size of the application.</p> |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:DigitCase" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">DigitCase</apiName><shortdesc class="- topic/shortdesc "> |
| The DigitCase class is an enumeration of constant values used in setting the digitCase property |
| of the ElementFormat class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The DigitCase class is an enumeration of constant values used in setting the <codeph class="+ topic/ph pr-d/codeph ">digitCase</codeph> property |
| of the ElementFormat class. |
| |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/digitCase" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.ElementFormat.digitCase</linktext></link></related-links><apiValue id="flash.text.engine:DigitCase:DEFAULT" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">DEFAULT</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify default digit case.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">default</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify default digit case. The results are font-dependent; characters use the settings specified by the font designer |
| without any features applied. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:DigitCase:LINING" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">LINING</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify lining digit case.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">lining</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify lining digit case. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:DigitCase:OLD_STYLE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">OLD_STYLE</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify old style digit case.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">oldStyle</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify old style digit case. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TypographicCase" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TypographicCase</apiName><shortdesc class="- topic/shortdesc "> |
| The TypographicCase class is an enumeration of constant values for setting the typographicCase property |
| of the ElementFormat class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TypographicCase class is an enumeration of constant values for setting the <codeph class="+ topic/ph pr-d/codeph ">typographicCase</codeph> property |
| of the ElementFormat class. |
| |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/typographicCase" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.typographicCase</linktext></link></related-links><apiValue id="flash.text.engine:TypographicCase:CAPS_AND_SMALL_CAPS" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">CAPS_AND_SMALL_CAPS</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that all lowercase characters use small-caps glyphs on output.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">capsAndSmallCaps</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that all lowercase characters use small-caps glyphs on output. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TypographicCase:CAPS" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">CAPS</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that spacing is adjusted for uppercase characters on output.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">caps</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that spacing is adjusted for uppercase characters on output. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TypographicCase:DEFAULT" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">DEFAULT</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies default typographic case.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">default</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies default typographic case. The results are font-dependent; characters use the settings specified by the font designer |
| without any features applied. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TypographicCase:LOWERCASE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">LOWERCASE</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that all characters use lowercase glyphs on output.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">lowercase</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that all characters use lowercase glyphs on output. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TypographicCase:SMALL_CAPS" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">SMALL_CAPS</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that uppercase characters use small-caps glyphs on output.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">smallCaps</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that uppercase characters use small-caps glyphs on output. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TypographicCase:TITLE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">TITLE</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that uppercase characters use title glyphs on output.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">title</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that uppercase characters use title glyphs on output. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TypographicCase:UPPERCASE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">UPPERCASE</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that all characters use uppercase glyphs on output.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">uppercase</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that all characters use uppercase glyphs on output. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextElement</apiName><shortdesc class="- topic/shortdesc "> |
| The TextElement class represents a string of formatted text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.text.engine:ContentElement</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextElement class represents a string of formatted text. Assign a TextElement object to the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> |
| property of a TextBlock object to create a block of text. Assign it to a GroupElement object to combine it with other text |
| and graphic elements as a unit. Use the ElementFormat class to format the text. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement" class="- topic/link "><linktext class="- topic/linktext ">ContentElement</linktext></link><link href="flash.text.engine.xml#ElementFormat" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat</linktext></link><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link></related-links><apiConstructor id="flash.text.engine:TextElement:TextElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">TextElement</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a new TextElement instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">text</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The text for the element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elementFormat</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ElementFormat</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The element format for the text in the element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">eventMirror</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.events:EventDispatcher</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">EventDispatcher</codeph> object that receives copies of every |
| event dispatched to text lines based on this content element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">textRotation</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rotation applied the element as a unit. Use <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph> |
| constants for this property. The default value is <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a new TextElement instance. |
| |
| </apiDesc><example conref="examples\TextElementExample.as" class="- topic/example "> The following example creates a TextElement object from a string of text, formats |
| it using a font size of 12 and the color red (0xCC0000), and assigns it to the |
| <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property of a TextBlock. It calls the createLines() function to break the |
| block of text into lines of 150 pixels each. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.ElementFormat; |
| |
| public class TextElementExample extends Sprite { |
| |
| public function TextElementExample():void { |
| |
| var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " + |
| "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut " + |
| "enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut " + |
| "aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit " + |
| "in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur " + |
| "sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt " + |
| "mollit anim id est laborum."; |
| |
| var format:ElementFormat = new ElementFormat(null, 12, 0xCC0000); |
| var textElement:TextElement = new TextElement(str, format); |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = textElement; |
| createLines(textBlock); |
| } |
| |
| private function createLines(textBlock:TextBlock):void { |
| |
| var yPos = 20; |
| var textLine:TextLine = textBlock.createTextLine (null, 150); |
| |
| while (textLine) |
| { |
| addChild(textLine); |
| textLine.x = 15; |
| yPos += textLine.textHeight+2; |
| textLine.y = yPos; |
| textLine = textBlock.createTextLine(textLine, 150); |
| } |
| } |
| } |
| } |
| </codeblock></example></apiConstructorDetail></apiConstructor><apiOperation id="flash.text.engine:TextElement:replaceText" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">replaceText</apiName><shortdesc class="- topic/shortdesc "> |
| Replaces the range of characters that the beginIndex and |
| endIndex parameters specify with the contents |
| of the newText parameter.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> or <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> specified is out of range. |
| |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">beginIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the start position of the replacement range. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">endIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value following the end position of the replacement range. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">newText</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The text to use to replace the specified range of characters. |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Replaces the range of characters that the <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and |
| <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> parameters specify with the contents |
| of the <codeph class="+ topic/ph pr-d/codeph ">newText</codeph> parameter. The <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and |
| <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> values refer to the current contents of <codeph class="+ topic/ph pr-d/codeph ">text</codeph>. |
| <p class="- topic/p ">To delete text, pass <codeph class="+ topic/ph pr-d/codeph ">null</codeph> for <codeph class="+ topic/ph pr-d/codeph ">newText</codeph>.</p> |
| <p class="- topic/p ">To insert text, pass the same value for <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph>. |
| The new text is inserted before the specified index.</p> |
| <p class="- topic/p ">To append text, pass <codeph class="+ topic/ph pr-d/codeph ">text.length</codeph> for <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph>.</p> |
| <p class="- topic/p ">To set all the text, pass 0 for <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and <codeph class="+ topic/ph pr-d/codeph ">text.length</codeph> for <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph>.</p> |
| |
| </apiDesc><example conref="examples\TextElement_replaceTextExample.as" class="- topic/example "> This example calls <codeph class="+ topic/ph pr-d/codeph ">replaceText()</codeph> several times to do the following: |
| <ul class="- topic/ul "><li class="- topic/li "> insert a string at the beginning of text</li><li class="- topic/li "> append a string to the end of text</li><li class="- topic/li "> insert a string in the middle of text</li><li class="- topic/li "> replace text entirely with new text</li></ul> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| import flash.display.Sprite; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextLine; |
| |
| |
| public class TextElement_replaceTextExample extends Sprite { |
| public function TextElement_replaceTextExample():void { |
| |
| var str:String = "0123456"; |
| var fontDescription:FontDescription = new FontDescription("Arial"); |
| var format:ElementFormat = new ElementFormat(fontDescription); |
| format.fontSize = 14; |
| var textElement:TextElement = new TextElement(str, format); |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = textElement; |
| textElement.replaceText(0, 0, "abc"); |
| createLine(textBlock, 20); //"abc0123456" |
| textElement.replaceText(10, 10, "abc"); |
| createLine(textBlock, 40); // "abc0123456abc" |
| textElement.replaceText(5, 8, "abc"); |
| createLine(textBlock, 60); // "abc01abc56abc" |
| textElement.replaceText(0, 13, "abc"); |
| createLine(textBlock, 80); // "abc" |
| textElement.replaceText(0, 3, "That's all she wrote!"); |
| createLine(textBlock, 100); // "That's all she wrote" */ |
| } |
| |
| private function createLine(textBlock:TextBlock, y:Number):void { |
| var textLine:TextLine = textBlock.createTextLine(null, 150); |
| textLine.x = 10; |
| textLine.y = y; |
| addChild(textLine); |
| } |
| } |
| } |
| </codeblock></example></apiOperationDetail></apiOperation><apiValue id="flash.text.engine:TextElement:text:set" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">text</apiName><shortdesc class="- topic/shortdesc "> |
| Receives the text that is the content of the element.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Receives the text that is the content of the element. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextLineValidity" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextLineValidity</apiName><shortdesc class="- topic/shortdesc "> |
| The TextLineValidity class is an enumeration of constant values for setting the validity property |
| of the TextLine class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextLineValidity class is an enumeration of constant values for setting the <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> property |
| of the TextLine class. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/firstInvalidLine" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.firstInvalidLine</linktext></link><link href="flash.text.engine.xml#TextLine/validity" class="- topic/link "><linktext class="- topic/linktext ">TextLine.validity</linktext></link></related-links><apiValue id="flash.text.engine:TextLineValidity:INVALID" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">INVALID</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that the line is invalid.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">invalid</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that the line is invalid. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineValidity:POSSIBLY_INVALID" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">POSSIBLY_INVALID</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that the text line is possibly invalid.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">possiblyInvalid</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that the text line is possibly invalid. The Flash runtime uses this validity during rebreaking of a previously broken text |
| block whose content has not changed. You cannot set this value. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineValidity:STATIC" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">STATIC</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that the line is static, and that the connection between the line and the text block has been severed.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">static</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that the line is static, and that the connection between the line and the text block has been severed. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineValidity:VALID" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">VALID</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that the text line is valid.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">valid</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that the text line is valid. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:FontPosture" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">FontPosture</apiName><shortdesc class="- topic/shortdesc "> |
| The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture to |
| set text to italic or normal.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The FontPosture class is an enumeration of constant values used with <codeph class="+ topic/ph pr-d/codeph ">FontDescription.fontPosture</codeph> to |
| set text to italic or normal. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/fontPosture" class="- topic/link "><linktext class="- topic/linktext ">FontDescription.fontPosture</linktext></link></related-links><apiValue id="flash.text.engine:FontPosture:ITALIC" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ITALIC</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate italic font posture.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">italic</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate italic font posture. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontPosture:NORMAL" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">NORMAL</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate normal font posture.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">normal</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate normal font posture. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:JustificationStyle" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">JustificationStyle</apiName><shortdesc class="- topic/shortdesc "> |
| The JustificationStyle class is an enumeration of constant values for setting the justificationStyle property |
| of the EastAsianJustifier class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The JustificationStyle class is an enumeration of constant values for setting the <codeph class="+ topic/ph pr-d/codeph ">justificationStyle</codeph> property |
| of the EastAsianJustifier class. These constants specify options for handling kinsoku characters, which are Japanese characters that cannot |
| appear at either the beginning or end of a line. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#EastAsianJustifier/justificationStyle" class="- topic/link "><linktext class="- topic/linktext ">EastAsianJustifier.justificationStyle</linktext></link></related-links><apiValue id="flash.text.engine:JustificationStyle:PRIORITIZE_LEAST_ADJUSTMENT" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">PRIORITIZE_LEAST_ADJUSTMENT</apiName><shortdesc class="- topic/shortdesc "> |
| Bases justification on either expanding or compressing |
| the line, whichever gives a result closest to the desired width.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">prioritizeLeastAdjustment</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Bases justification on either expanding or compressing |
| the line, whichever gives a result closest to the desired width. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:JustificationStyle:PUSH_IN_KINSOKU" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">PUSH_IN_KINSOKU</apiName><shortdesc class="- topic/shortdesc "> |
| Bases justification on compressing kinsoku at the end of the line, |
| or expanding it if no kinsoku occurs or if that space is insufficient.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">pushInKinsoku</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Bases justification on compressing kinsoku at the end of the line, |
| or expanding it if no kinsoku occurs or if that space is insufficient. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:JustificationStyle:PUSH_OUT_ONLY" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">PUSH_OUT_ONLY</apiName><shortdesc class="- topic/shortdesc "> |
| Bases justification on expanding the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">pushOutOnly</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Bases justification on expanding the line. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:EastAsianJustifier" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">EastAsianJustifier</apiName><shortdesc class="- topic/shortdesc "> |
| The EastAsianJustifier class has properties to control the justification options for text lines whose |
| content is primarily East Asian text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.text.engine:TextJustifier</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The EastAsianJustifier class has properties to control the justification options for text lines whose |
| content is primarily East Asian text. |
| |
| <p class="- topic/p "> Use the constructor <codeph class="+ topic/ph pr-d/codeph ">new EastAsianJustifier()</codeph> to create an EastAsianJustifier object |
| before setting its properties. Setting the properties of an EastAsianJustifier object after it has been applied to a TextBlock does |
| not invalidate the TextBlock.</p> |
| |
| </apiDesc><example conref="examples\EastAsianJustifierExample.as" class="- topic/example "> This example displays a block of Japanese text vertically, |
| using EastAsianJustifier properties to justify the text. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextBaseline; |
| import flash.text.engine.EastAsianJustifier; |
| import flash.text.engine.LineJustification; |
| import flash.text.engine.TextRotation; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.ElementFormat; |
| import flash.display.Stage; |
| import flash.display.Sprite; |
| import flash.system.Capabilities; |
| |
| public class EastAsianJustifierExample extends Sprite { |
| |
| public function EastAsianJustifierExample():void { |
| |
| var Japanese_txt:String = String.fromCharCode( |
| 0x5185, 0x95A3, 0x5E9C, 0x304C, 0x300C, 0x653F, 0x5E9C, 0x30A4, |
| 0x30F3, 0x30BF, 0x30FC, 0x30CD, 0x30C3, 0x30C8, 0x30C6, 0x30EC, |
| 0x30D3, 0x300D, 0x306E, 0x52D5, 0x753B, 0x914D, 0x4FE1, 0x5411, |
| 0x3051, 0x306B, 0x30A2, 0x30C9, 0x30D3, 0x30B7, 0x30B9, 0x30C6, |
| 0x30E0, 0x30BA, 0x793E, 0x306E |
| ) + |
| "FMS 2" + |
| String.fromCharCode(0x3092, 0x63A1, 0x7528, 0x3059, 0x308B, 0x3068, |
| 0x767a, 0x8868, 0x3057, 0x307e, 0x3057, 0x305F, 0x3002); |
| |
| var textBlock:TextBlock = new TextBlock(); |
| var font:FontDescription = new FontDescription(); |
| var format:ElementFormat = new ElementFormat(); |
| format.fontSize = 12; |
| format.locale = "ja"; |
| format.color = 0xCC0000; |
| textBlock.baselineZero = TextBaseline.IDEOGRAPHIC_CENTER; |
| textBlock.textJustifier = new EastAsianJustifier("ja", LineJustification.ALL_INCLUDING_LAST); |
| textBlock.lineRotation = TextRotation.ROTATE_90; |
| var linePosition:Number = this.stage.stageWidth - 75; |
| if (Capabilities.os.search("Mac OS") > -1) |
| // set fontName: Kozuka Mincho Pro R |
| font.fontName = String.fromCharCode(0x5C0F, 0x585A, 0x660E, 0x671D) + " Pro R"; |
| else |
| font.fontName = "Kozuka Mincho Pro R"; |
| textBlock.content = new TextElement(Japanese_txt, format); |
| var previousLine:TextLine = null; |
| |
| while (true) |
| { |
| var textLine:TextLine = textBlock.createTextLine(previousLine, 320); |
| if (textLine == null) |
| break; |
| textLine.y = 20; |
| textLine.x = linePosition; |
| linePosition -= 25; |
| addChild(textLine); |
| previousLine = textLine; |
| } |
| } |
| } |
| } |
| |
| |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#JustificationStyle" class="- topic/link "><linktext class="- topic/linktext ">JustificationStyle</linktext></link><link href="flash.text.engine.xml#LineJustification" class="- topic/link "><linktext class="- topic/linktext ">LineJustification</linktext></link><link href="flash.text.engine.xml#TextBlock/textJustifier" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.textJustifier</linktext></link></related-links><apiConstructor id="flash.text.engine:EastAsianJustifier:EastAsianJustifier" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">EastAsianJustifier</apiName><shortdesc class="- topic/shortdesc "> |
| Creates an EastAsianJustifier object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">locale</codeph> specified is <codeph class="+ topic/ph pr-d/codeph ">null</codeph> or too short to represent a valid locale. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">lineJustification</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">LineJustification</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">justificationStyle</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">JustificationStyle</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">locale</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">ja</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The locale to determine the justification rules. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">"ja"</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">lineJustification</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">allButLast</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The type of line justification for the paragraph. |
| Use <codeph class="+ topic/ph pr-d/codeph ">LineJustification</codeph> constants for this property. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">LineJustification.ALL_BUT_LAST</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">justificationStyle</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">pushInKinsoku</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The justification style for the text in a text block using an East Asian justifier. |
| Use <codeph class="+ topic/ph pr-d/codeph ">JustificationStyle</codeph> constants for this property. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">JustificationStyle.PUSH_IN_KINSOKU</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates an EastAsianJustifier object. |
| |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#JustificationStyle" class="- topic/link "><linktext class="- topic/linktext ">JustificationStyle</linktext></link><link href="flash.text.engine.xml#LineJustification" class="- topic/link "><linktext class="- topic/linktext ">LineJustification</linktext></link></related-links></apiConstructor><apiOperation id="flash.text.engine:EastAsianJustifier:clone" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">clone</apiName><shortdesc class="- topic/shortdesc "> |
| Constructs a cloned copy of the EastAsianJustifier.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata><asCustoms class="+ topic/metadata adobe-api-d/asCustoms "><internal>In the Flash Player 10 release, this method is for internal use. In future releases, |
| users will be able to subclass this class and will then need to use this method. This class is |
| currently stored as a live reference, but there is no way to track when its properties change. |
| This means that when changes are made, text blocks are not invalidated, which in the current |
| implementation can lead to player crashes. Even from the API perspective its wrong, as the affected |
| text lines should be marked INVALID when format changes are made, but they�re not. The solution is |
| to use a copy-on-set model. When the object is passed in, the player copies it, so later changes to |
| the object that was passed in have no effect. The setter makes an internal copy of the array; the |
| getter returns a copy of the internal copy. Operations like |
| myBlock.textJustifier.justificationStyle = JustificationStyle.PUSH_IN_KINSOKU will have no effect. |
| Users who subclass this class in the future will need to use the clone() method to |
| implement this technique of 'locking' the format once it has been set. |
| |
| </internal></asCustoms></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiIsOverride class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiIsOverride "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A copy of the <codeph class="+ topic/ph pr-d/codeph ">EastAsianJustifier</codeph> object. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextJustifier</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Constructs a cloned copy of the EastAsianJustifier. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiValue id="flash.text.engine:EastAsianJustifier:justificationStyle:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">justificationStyle</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the justification style for the text in a text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the justification style for the text in a text block. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">JustificationStyle.PUSH_IN_KINSOKU</codeph>.</p> |
| |
| <p class="- topic/p ">Use one of the constants in the JustificationStyle class to set the value for this |
| property. The following table lists the possible values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">JustificationStyle.PUSH_IN_KINSOKU</codeph></entry><entry class="- topic/entry ">Specifies push in justification.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">JustificationStyle.PUSH_OUT_ONLY</codeph></entry><entry class="- topic/entry ">Specifies push out justification.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT</codeph></entry><entry class="- topic/entry ">Specifies justification wherein the least adjustment is prioritized.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#JustificationStyle" class="- topic/link "><linktext class="- topic/linktext ">JustificationStyle</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:RenderingMode" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">RenderingMode</apiName><shortdesc class="- topic/shortdesc "> |
| The RenderingMode class provides values for rendering mode in the FontDescription class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The RenderingMode class provides values for rendering mode in the FontDescription class. |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription" class="- topic/link "><linktext class="- topic/linktext ">FontDescription</linktext></link></related-links><apiValue id="flash.text.engine:RenderingMode:CFF" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">CFF</apiName><shortdesc class="- topic/shortdesc "> |
| Sets rendering mode to CFF (Compact Font Format).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">cff</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Sets rendering mode to CFF (Compact Font Format). CFF rendering improves readability of text on a display. |
| This setting is recommended for applications that have a lot of small text. |
| This constant is used for the <codeph class="+ topic/ph pr-d/codeph ">renderingMode</codeph> property in the FontDescription |
| class. |
| Use the syntax <codeph class="+ topic/ph pr-d/codeph ">RenderingMode.CFF</codeph>. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/renderingMode" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.FontDescription.renderingMode</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:RenderingMode:NORMAL" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">NORMAL</apiName><shortdesc class="- topic/shortdesc "> |
| Sets rendering mode to the rendering mode that is used in Flash Player 7 and earlier.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">normal</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Sets rendering mode to the rendering mode that is used in Flash Player 7 and earlier. |
| This setting is recommended for animated text. |
| This constant is used for the <codeph class="+ topic/ph pr-d/codeph ">renderingMode</codeph> property in the FontDescription |
| class. |
| Use the syntax <codeph class="+ topic/ph pr-d/codeph ">RenderingMode.NORMAL</codeph>. |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/renderingMode" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.FontDescription.renderingMode</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:FontMetrics" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">FontMetrics</apiName><shortdesc class="- topic/shortdesc "> |
| The FontMetrics class contains measurement and offset information about a font.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The FontMetrics class contains measurement and offset information about a font. |
| The <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.getFontMetrics()</codeph> method returns objects of this class. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/getFontMetrics()" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.getFontMetrics()</linktext></link></related-links><apiConstructor id="flash.text.engine:FontMetrics:FontMetrics" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">FontMetrics</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a FontMetrics object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">emBox</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Rectangle</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The emBox of the font in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">strikethroughOffset</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The offset for a strikethrough in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">strikethroughThickness</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The thickness for a strikethrough in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">underlineOffset</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The offset for an underline in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">underlineThickness</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The thickness for an underline in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">subscriptOffset</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The offset for a subscript in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">subscriptScale</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The scale to apply to the point size of a subscript. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">superscriptOffset</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The offset for a superscript in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">superscriptScale</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The scale to apply to the point size of a superscript. |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a FontMetrics object. The FontMetrics object contains information about |
| the metrics of a font in an element format. |
| The <codeph class="+ topic/ph pr-d/codeph ">flash.text.engine.ElementFormat.getFontMetrics()</codeph> method returns objects of this class. |
| |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/getFontMetrics()" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.getFontMetrics()</linktext></link></related-links></apiConstructor><apiValue id="flash.text.engine:FontMetrics:emBox" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">emBox</apiName><shortdesc class="- topic/shortdesc "> |
| The emBox value represents the design space of the font and is used to place Chinese, |
| Korean, or Japanese glyphs relative to the Roman baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.geom:Rectangle</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The emBox value represents the design space of the font and is used to place Chinese, |
| Korean, or Japanese glyphs relative to the Roman baseline. |
| Typically a square, sized to the point size of the font. The origin (coordinate 0,0) |
| of the emBox is set to the left edge and Roman baseline of the rect. |
| For example, for a 10-point font, the emBox can be a rect [L,T,R,B] of [0, -8.8, 10, 1.2]. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontMetrics:strikethroughOffset" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">strikethroughOffset</apiName><shortdesc class="- topic/shortdesc "> |
| The strikethroughOffset value is the suggested vertical offset from the Roman baseline for a strikethrough.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The strikethroughOffset value is the suggested vertical offset from the Roman baseline for a strikethrough. |
| |
| <p class="- topic/p ">Note that depending on the rotation of the line, this value is either added or subtracted from the |
| position of the line to find the position for the strikethrough. In a line with <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph>, |
| <codeph class="+ topic/ph pr-d/codeph ">strikethrough.y = line.y + strikethroughOffset</codeph>. In a line |
| with <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_90</codeph>, <codeph class="+ topic/ph pr-d/codeph ">strikethrough.x = line.x - strikethroughOffset</codeph>.</p> |
| |
| <p class="- topic/p ">When applying decorations such as strikethroughs to a <codeph class="+ topic/ph pr-d/codeph ">TextLine</codeph>, the recommended procedure is to specify |
| an <codeph class="+ topic/ph pr-d/codeph ">eventMirror</codeph> on the <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph> which is to receive the decoration. |
| In response to the <codeph class="+ topic/ph pr-d/codeph ">Event.ADDED</codeph> event, the <codeph class="+ topic/ph pr-d/codeph ">bounds</codeph> of the |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineMirrorRegion</codeph> can be used in conjunction |
| with the <codeph class="+ topic/ph pr-d/codeph ">strikethroughOffset</codeph> to place the strikethrough.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/eventMirror" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.eventMirror</linktext></link><link href="flash.text.engine.xml#TextLineMirrorRegion" class="- topic/link "><linktext class="- topic/linktext ">TextLineMirrorRegion</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontMetrics:strikethroughThickness" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">strikethroughThickness</apiName><shortdesc class="- topic/shortdesc "> |
| The strikethroughThickness value is the suggested thickness for a strikethrough.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The strikethroughThickness value is the suggested thickness for a strikethrough. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontMetrics:subscriptOffset" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">subscriptOffset</apiName><shortdesc class="- topic/shortdesc "> |
| The subscriptOffset value is the suggested vertical offset from the Roman baseline for a subscript.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The subscriptOffset value is the suggested vertical offset from the Roman baseline for a subscript. |
| |
| <p class="- topic/p ">The subscriptOffset value is used with <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.baselineShift</codeph> to position the subscript.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/baselineShift" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.baselineShift</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontMetrics:subscriptScale" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">subscriptScale</apiName><shortdesc class="- topic/shortdesc "> |
| The subscriptScale value is the suggested scale factor to apply to the point size for a subscript.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The subscriptScale value is the suggested scale factor to apply to the point size for a subscript. |
| A scale factor of 1.0 means no scaling. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontMetrics:superscriptOffset" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">superscriptOffset</apiName><shortdesc class="- topic/shortdesc "> |
| The superscriptOffset value is the suggested vertical offset from the Roman baseline for a superscript.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The superscriptOffset value is the suggested vertical offset from the Roman baseline for a superscript. |
| |
| <p class="- topic/p ">The superscriptOffset value is used with <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.baselineShift</codeph> to position the superscript.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/baselineShift" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.baselineShift</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontMetrics:superscriptScale" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">superscriptScale</apiName><shortdesc class="- topic/shortdesc "> |
| The superscriptScale value is the suggested scale factor to apply to the point size for a superscript.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The superscriptScale value is the suggested scale factor to apply to the point size for a superscript. |
| A scale factor of 1.0 means no scaling. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontMetrics:underlineOffset" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">underlineOffset</apiName><shortdesc class="- topic/shortdesc "> |
| The underlineOffset value is the suggested vertical offset from the Roman baseline for an underline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The underlineOffset value is the suggested vertical offset from the Roman baseline for an underline. |
| |
| <p class="- topic/p ">Note that depending on the rotation of the line, this value is either added or subtracted from the |
| position of the line to find the position for the underline. In a line with <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph>, |
| <codeph class="+ topic/ph pr-d/codeph ">underline.y = line.y + underlineOffset</codeph>. In a line |
| with <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_90</codeph>, <codeph class="+ topic/ph pr-d/codeph ">underline.x = line.x - underlineOffset</codeph>.</p> |
| |
| <p class="- topic/p ">When applying decorations such as underlines to a <codeph class="+ topic/ph pr-d/codeph ">TextLine</codeph>, the recommended procedure is to specify |
| an <codeph class="+ topic/ph pr-d/codeph ">eventMirror</codeph> on the <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph> which is to receive the decoration. |
| In response to the <codeph class="+ topic/ph pr-d/codeph ">Event.ADDED</codeph> event, the <codeph class="+ topic/ph pr-d/codeph ">bounds</codeph> of the |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineMirrorRegion</codeph> can be used in conjunction |
| with the <codeph class="+ topic/ph pr-d/codeph ">underlineOffset</codeph> to place the underline.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/eventMirror" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.eventMirror</linktext></link><link href="flash.events.xml#Event" class="- topic/link "><linktext class="- topic/linktext ">Event</linktext></link><link href="flash.text.engine.xml#TextLineMirrorRegion" class="- topic/link "><linktext class="- topic/linktext ">TextLineMirrorRegion</linktext></link><link href="flash.text.engine.xml#TextRotation" class="- topic/link "><linktext class="- topic/linktext ">TextRotation</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontMetrics:underlineThickness" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">underlineThickness</apiName><shortdesc class="- topic/shortdesc "> |
| The underlineThickness value is the suggested thickness for an underline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The underlineThickness value is the suggested thickness for an underline. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:ElementFormat" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">ElementFormat</apiName><shortdesc class="- topic/shortdesc "> |
| The ElementFormat class represents formatting information which can be applied to a ContentElement.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The ElementFormat class represents formatting information which can be applied to a ContentElement. Use the ElementFormat class |
| to create specific text formatting for the various subclasses of ContentElement. The properties of the ElementFormat class apply to device and |
| embedded fonts. |
| |
| <p class="- topic/p ">An ElementFormat object that is applied to a ContentElement in a TextBlock does not invalidate the TextBlock. |
| Once an ElementFormat has been |
| applied to a ContentElement, its <codeph class="+ topic/ph pr-d/codeph ">locked</codeph> property is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>. |
| The properties of a locked ElementFormat object cannot be changed. Instead, use the <codeph class="+ topic/ph pr-d/codeph ">clone()</codeph> |
| method to create an unlocked copy of the object, which can be modified and assigned to the ContentElement.</p> |
| |
| </apiDesc><example conref="examples\ElementFormatExample.as" class="- topic/example "> <p class="- topic/p ">This example creates two <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> objects and sets several of |
| their properties. It then assigns the new ElementFormats to a <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> object, |
| which has been assigned as the content of a <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. Note that changing the |
| <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> of a <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> does not affect TextLines that |
| have been previously created by the parent TextBlock.</p> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.text.engine.*; |
| |
| |
| public class ElementFormatExample extends Sprite { |
| |
| public function ElementFormatExample():void { |
| var fd:FontDescription = new FontDescription(); |
| fd.fontName = "Garamond"; |
| fd.fontWeight = flash.text.engine.FontWeight.BOLD; |
| |
| var ef1:ElementFormat = new ElementFormat(fd); |
| ef1.fontSize = 30; |
| ef1.color = 0xFF0000; |
| ef1.alpha = 100; |
| ef1.kerning = flash.text.engine.Kerning.ON; |
| ef1.trackingRight = 2; |
| ef1.typographicCase = flash.text.engine.TypographicCase.UPPERCASE; |
| ef1.alignmentBaseline = flash.text.engine.TextBaseline.DESCENT; |
| ef1.ligatureLevel = flash.text.engine.LigatureLevel.EXOTIC; |
| |
| var ef2:ElementFormat = new ElementFormat(fd); |
| ef2.fontSize = 30; |
| ef2.color = 0xFF0000; |
| ef2.alpha = 0.3; |
| ef2.kerning = flash.text.engine.Kerning.OFF; |
| ef2.typographicCase = flash.text.engine.TypographicCase.LOWERCASE; |
| ef2.digitCase = flash.text.engine.DigitCase.OLD_STYLE; |
| ef2.textRotation = flash.text.engine.TextRotation.ROTATE_180; |
| |
| var str:String = "This is flash text 0123456789"; |
| var tb:TextBlock = new TextBlock(); |
| var te1:TextElement = new TextElement(str, ef1); |
| tb.content = te1; |
| var line1:TextLine = tb.createTextLine(null, 600); |
| addChild(line1); |
| line1.x = 15; |
| line1.y = 30; |
| |
| tb.content.elementFormat = ef2; |
| var line2:TextLine = tb.createTextLine(null, 600); |
| addChild(line2); |
| line2.x = 15; |
| line2.y = 60; |
| |
| } |
| } |
| } |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/elementFormat" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.elementFormat</linktext></link></related-links><apiConstructor id="flash.text.engine:ElementFormat:ElementFormat" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">ElementFormat</apiName><shortdesc class="- topic/shortdesc "> |
| Creates an ElementFormat object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontSize</codeph> specified is less than 0. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">textRotation</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">kerning</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">Kerning</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">breakOpportunity</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">digitCase</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">DigitCase</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">digitWidth</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">DigitWidth</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">ligatureLevel</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">LigatureLevel</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">typographicCase</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TypographicCase</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontDescription</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:FontDescription</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The FontDescription object which identifies the font used with this element format. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. If no font description is provided, a default font description is constructed. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontSize</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">12.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The size of text in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">color</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">uint</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0x000000</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The color of text. A hexadecimal number containing three 8-bit RGB |
| components; for example, 0xFF0000 is red and 0x00FF00 is green. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">alpha</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">1.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">alpha</codeph> property applied to all line atoms based on the element format. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">textRotation</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">auto</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">the rotation applied to individual glyphs. Use TextRotation |
| constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">dominantBaseline</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">roman</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The baseline to which the glyphs in the text snap. |
| Use TextBaseline constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">alignmentBaseline</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">useDominantBaseline</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The baseline on the containing line to which the dominant baseline snaps. |
| Use TextBaseline constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">baselineShift</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The baseline shift for the text in pixels em. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">kerning</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">on</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The kerning used for this text. Use constants defined in the Kerning class. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">trackingRight</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The tracking or manual kerning applied to the right of each glyph in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">trackingLeft</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The tracking or manual kerning applied to the left of each glyph in pixels. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">locale</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">en</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The locale of the text. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">breakOpportunity</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">auto</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The line break opportunity applied to this text. Use BreakOpportunity |
| constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">digitCase</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">default</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The digit case used for this text. Use DigitCase |
| constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">digitWidth</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">default</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The digit width used for this text. Use DigitWidth |
| constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ligatureLevel</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">common</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The ligature level used for this text. Use LigatureLevel |
| constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">typographicCase</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">default</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The typographic case used for this text. Use TypographicCase |
| constants for this property. |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates an ElementFormat object. |
| |
| </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="flash.text.engine:ElementFormat:clone" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">clone</apiName><shortdesc class="- topic/shortdesc "> |
| Constructs an unlocked, cloned copy of the ElementFormat.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">An unlocked copy of the <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> object. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ElementFormat</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Constructs an unlocked, cloned copy of the ElementFormat. |
| |
| </apiDesc><example conref="examples\ElementFormat_cloneExample.as" class="- topic/example "> <p class="- topic/p ">This example creates an <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> object and sets a <codeph class="+ topic/ph pr-d/codeph ">FontSize</codeph>. |
| A new <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> is created, using the <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> (and therefore locking it), and |
| the <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> is used as content for a <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. A |
| line of text is created from the <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>.</p> |
| <p class="- topic/p ">To modify the <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> object, first check its |
| <codeph class="+ topic/ph pr-d/codeph ">locked</codeph> property. If true, use the <codeph class="+ topic/ph pr-d/codeph ">clone()</codeph> method to |
| create an unlocked copy of the <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph>, change its properties, |
| then re-link the new <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> to the <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. |
| When the lines are re-broken, the new lines will have the new font settings.</p> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.text.engine.*; |
| |
| |
| public class ElementFormat_cloneExample extends Sprite { |
| private var ef1:ElementFormat; |
| private var ef2:ElementFormat; |
| |
| public function ElementFormat_cloneExample():void { |
| var fd:FontDescription = new FontDescription(); |
| fd.fontLookup = flash.text.engine.FontLookup.DEVICE; |
| fd.fontName = "Palatino"; |
| |
| var ef1:ElementFormat = new ElementFormat(fd); |
| ef1.fontSize=20; |
| |
| var str:String = "This is flash text 0123456789"; |
| var tb:TextBlock = new TextBlock(); |
| var te1:TextElement = new TextElement(str, ef1); |
| tb.content = te1; |
| var line1:TextLine = tb.createTextLine(null, 600); |
| addChild(line1); |
| |
| ef2 = (ef1.locked) ? ef1.clone() : ef1; |
| ef2.fontSize = 32; |
| |
| tb.content.elementFormat=ef2; |
| var line2:TextLine = tb.createTextLine(null, 600); |
| addChild(line2); |
| |
| } |
| } |
| } |
| </codeblock></example></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:ElementFormat:getFontMetrics" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getFontMetrics</apiName><shortdesc class="- topic/shortdesc "> |
| Returns a FontMetrics object with properties which describe the emBox, strikethrough position, |
| strikethrough thickness, underline position, and underline thickness for the font specified by |
| fontDescription and fontSize. |
| |
| </shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A <codeph class="+ topic/ph pr-d/codeph ">FontMetrics</codeph> object describing properties of the font specified by <codeph class="+ topic/ph pr-d/codeph ">fontDescription</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:FontMetrics</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| <p class="- topic/p ">Returns a <codeph class="+ topic/ph pr-d/codeph ">FontMetrics</codeph> object with properties which describe the emBox, strikethrough position, |
| strikethrough thickness, underline position, and underline thickness for the font specified by |
| <codeph class="+ topic/ph pr-d/codeph ">fontDescription</codeph> and <codeph class="+ topic/ph pr-d/codeph ">fontSize</codeph>.</p> |
| |
| </apiDesc><example conref="examples\FontMetricsExample.as" class="- topic/example "> This example creates an <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> object with an assigned |
| <codeph class="+ topic/ph pr-d/codeph ">FontDescription</codeph> and uses the <codeph class="+ topic/ph pr-d/codeph ">getFontMetrics</codeph> method to |
| display metrics for the chosen font at 24 points. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.text.engine.*; |
| |
| |
| public class FontMetricsExample extends Sprite { |
| |
| public function FontMetricsExample():void { |
| var fd:FontDescription = new FontDescription(); |
| fd.fontName = "Garamond"; |
| fd.fontWeight = flash.text.engine.FontWeight.BOLD; |
| |
| var ef1:ElementFormat = new ElementFormat(fd); |
| ef1.fontSize = 24; |
| var fm1:FontMetrics = ef1.getFontMetrics(); |
| |
| trace(fm1.emBox); |
| trace(fm1.strikethroughOffset); |
| trace(fm1.strikethroughThickness); |
| trace(fm1.subscriptScale); |
| trace(fm1.subscriptOffset); |
| trace(fm1.superscriptScale); |
| trace(fm1.superscriptOffset); |
| trace(fm1.underlineOffset); |
| trace(fm1.underlineThickness); |
| |
| |
| } |
| } |
| } |
| </codeblock></example></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription" class="- topic/link "><linktext class="- topic/linktext ">FontDescription</linktext></link><link href="flash.text.engine.xml#FontMetrics" class="- topic/link "><linktext class="- topic/linktext ">FontMetrics</linktext></link></related-links></apiOperation><apiValue id="flash.text.engine:ElementFormat:alignmentBaseline:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">alignmentBaseline</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the type of baseline in the containing element to which to align the dominant baselines of elements having |
| this format.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the type of baseline in the containing element to which to align the dominant baselines of elements having |
| this format. Use <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph> constants for this property. |
| |
| <p class="- topic/p ">The largest vertical element in the line determines the alignment of baselines unless |
| <codeph class="+ topic/ph pr-d/codeph ">TextBlock.baselineFontDescription</codeph> and <codeph class="+ topic/ph pr-d/codeph ">TextBlock.baselineFontSize</codeph> are set to override that logic.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">TextBaseline.USE_DOMINANT_BASELINE</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ROMAN</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> aligns with the roman baseline of the line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ASCENT</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> aligns with the ascent baseline of the line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.DESCENT</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> aligns with the descent baseline of the line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_TOP</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> aligns with the ideographic top baseline of the line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_CENTER</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> aligns with the ideographic center baseline of the line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_BOTTOM</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> aligns with the ideographic bottom baseline of the line.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.USE_DOMINANT_BASELINE</codeph></entry><entry class="- topic/entry ">The <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> aligns with the same baseline of the line.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Sets the alignment baseline of the line to which the <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> of the graphic element aligns.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Sets the alignment baseline of the line to which the <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> of the text element aligns.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBaseline" class="- topic/link "><linktext class="- topic/linktext ">TextBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:alpha:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">alpha</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the transparency of the line elements affected by this obect.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the transparency of the line elements affected by this obect. Valid values range from 0 (fully transparent) |
| to 1 (fully opaque). Display objects with <codeph class="+ topic/ph pr-d/codeph ">alpha</codeph> set to 0 are active, even though they are invisible. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">1</codeph>.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Applies the specified alpha to the graphic element. Combines |
| multiplicatively with any alpha set on the graphic <codeph class="+ topic/ph pr-d/codeph ">DisplayObject</codeph> |
| itself or on the <codeph class="+ topic/ph pr-d/codeph ">TextLine</codeph>.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Applies the specified alpha to the text element. Combines |
| multiplicatively with any alpha set on the <codeph class="+ topic/ph pr-d/codeph ">TextLine</codeph>.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/alpha" class="- topic/link "><linktext class="- topic/linktext ">DisplayObject.alpha</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:baselineShift:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">baselineShift</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates the baseline shift for the element in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates the baseline shift for the element in pixels. |
| <p class="- topic/p ">The element is shifted away from the <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> by this amount. |
| The offset is added to the y position of the members of the element, so in non-rotated |
| text, a positive baseline shift moves the element down and a negative baseline shift |
| moves the element up.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">0.0</codeph>, indicating no shift.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Shifts the graphic away from the baseline.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Shifts the text away from the baseline.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ElementFormat:breakOpportunity:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">breakOpportunity</apiName><shortdesc class="- topic/shortdesc "> |
| The line break opportunity applied to this text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to a value not a member of <codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The line break opportunity applied to this text. |
| This property determines which characters can be used for breaking when wrapping text is broken into multiple lines. |
| Use <codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity</codeph> |
| constants for this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity.AUTO</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity.AUTO</codeph></entry><entry class="- topic/entry ">Line breaking opportunities are based on standard Unicode character properties, such as breaking between words and on hyphens.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity.ANY</codeph></entry><entry class="- topic/entry ">Any character in the <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph> object is treated 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.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity.NONE</codeph></entry><entry class="- topic/entry ">No characters in the range are treated as line break opportunities.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BreakOpportunity.ALL</codeph></entry><entry class="- topic/entry ">All characters in the range are treated as line break opportunities, meaning that a line break will occur |
| after each character. Useful for creating effects like text on a path.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Determines the break opportunity between adjacent text elements in the group. |
| If the elementFormat of the group is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>, the format of the first |
| of the adjacent elements is used.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the break opportunity between the characters in the text element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#BreakOpportunity" class="- topic/link "><linktext class="- topic/linktext ">BreakOpportunity</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:color:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">color</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates the color of the text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">uint</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates the color of the text. An integer containing three 8-bit RGB components; for example, |
| 0xFF0000 is red and 0x00FF00 is green. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">0x000000</codeph>, which is black.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Sets the color of the text.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ElementFormat:digitCase:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">digitCase</apiName><shortdesc class="- topic/shortdesc "> |
| The digit case used for this text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">DigitCase</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The digit case used for this text. |
| Digit case affects the style and positioning of groups of numeric characters. |
| Use <codeph class="+ topic/ph pr-d/codeph ">DigitCase</codeph> |
| constants for this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">DigitCase.DEFAULT</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">DigitCase.DEFAULT</codeph></entry><entry class="- topic/entry ">Applies default digit case to the text.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">DigitCase.LINING</codeph></entry><entry class="- topic/entry ">Applies lining digit case to the text.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">DigitCase.OLD_STYLE</codeph></entry><entry class="- topic/entry ">Applies old style digit case to the text.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the digit case used for the text in the element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#DigitCase" class="- topic/link "><linktext class="- topic/linktext ">DigitCase</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:digitWidth:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">digitWidth</apiName><shortdesc class="- topic/shortdesc "> |
| The digit width used for this text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">DigitWidth</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The digit width used for this text. Use <codeph class="+ topic/ph pr-d/codeph ">DigitWidth</codeph> |
| constants for this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">DigitWidth.DEFAULT</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">DigitWidth.DEFAULT</codeph></entry><entry class="- topic/entry ">Applies default digit width to the text.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">DigitWidth.PROPORTIONAL</codeph></entry><entry class="- topic/entry ">Applies proportional digit width to the text.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">DigitWidth.TABULAR</codeph></entry><entry class="- topic/entry ">Applies tabular digit width to the text.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the digit width used for the text in the element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#DigitWidth" class="- topic/link "><linktext class="- topic/linktext ">DigitWidth</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:dominantBaseline:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">dominantBaseline</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the type of baseline to use as the dominant baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the type of baseline to use as the dominant baseline. The dominant baseline is aligned |
| with the alignment baseline to determine the vertical position of the element on the line. |
| Use <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph> constants for this property. |
| |
| <p class="- topic/p ">The content of the element determines the baselines. |
| In the case of a <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph>, the font and the point size determine the baselines. |
| In the case of a <codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph>, the height of the element determines the baselines.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ROMAN</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ROMAN</codeph></entry><entry class="- topic/entry ">The roman baseline of the element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ASCENT</codeph></entry><entry class="- topic/entry ">The ascent baseline of the element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.DESCENT</codeph></entry><entry class="- topic/entry ">The descent baseline of the element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_TOP</codeph></entry><entry class="- topic/entry ">The ideographic top baseline of the element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_CENTER</codeph></entry><entry class="- topic/entry ">The ideographic center baseline of the element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_BOTTOM</codeph></entry><entry class="- topic/entry ">The ideographic bottom baseline of the element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Determines which of the baselines of the graphic element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines which of the baselines of the text element aligns with the <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph>.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBaseline" class="- topic/link "><linktext class="- topic/linktext ">TextBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:fontDescription:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">fontDescription</apiName><shortdesc class="- topic/shortdesc "> |
| An object whose properties describe a font.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:FontDescription</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| An object whose properties describe a font. |
| |
| <p class="- topic/p ">The default value is a default-constructed FontDescription object.</p> |
| |
| <p class="- topic/p ">When the fontDescription property is set, the FontDescription object provided is locked: its <codeph class="+ topic/ph pr-d/codeph ">locked</codeph> |
| property is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>. A locked FontDescription cannot be modified.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the font used for the text in the element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription" class="- topic/link "><linktext class="- topic/linktext ">FontDescription</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:fontSize:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">fontSize</apiName><shortdesc class="- topic/shortdesc "> |
| The size of text in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to a value less than zero. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The size of text in pixels. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">12.0</codeph>.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the size in pixels for the text in the element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ElementFormat:kerning:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">kerning</apiName><shortdesc class="- topic/shortdesc "> |
| Kerning adjusts the pixels between certain character pairs to improve readability.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Kerning adjusts the pixels between certain character pairs to improve readability. |
| Kerning is supported for all fonts which have kerning tables. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">Kerning.ON</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following constants in the Kerning class:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">Kerning.ON</codeph></entry><entry class="- topic/entry ">Kerning is enabled.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">Kerning.OFF</codeph></entry><entry class="- topic/entry ">Kerning is disabled.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">Kerning.AUTO</codeph></entry><entry class="- topic/entry ">Kerning is enabled except where inappropriate in Asian typography. Kerning is applied between two |
| characters if neither is Kanji, Hiragana, or Katakana.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Determines whether kerning is applied between adjacent text elements in the group. |
| If the elementFormat of the group is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>, the format of the first |
| of the adjacent elements is used.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines whether kerning is applied between the characters in the text element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#Kerning" class="- topic/link "><linktext class="- topic/linktext ">Kerning</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:ligatureLevel:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ligatureLevel</apiName><shortdesc class="- topic/shortdesc "> |
| The ligature level used for this text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">LigatureLevel</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The ligature level used for this text. |
| A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures |
| usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. |
| They are used with both Latin and non-Latin character sets. Use <codeph class="+ topic/ph pr-d/codeph ">LigatureLevel</codeph> |
| constants for this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">LigatureLevel.COMMON</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LigatureLevel.NONE</codeph></entry><entry class="- topic/entry ">No ligatures are created.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LigatureLevel.MINIMUM</codeph></entry><entry class="- topic/entry ">Minimal ligatures are created.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LigatureLevel.COMMON</codeph></entry><entry class="- topic/entry ">Common ligatures are created.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LigatureLevel.UNCOMMON</codeph></entry><entry class="- topic/entry ">Uncommon ligatures are created.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LigatureLevel.EXOTIC</codeph></entry><entry class="- topic/entry ">Exotic ligatures are created.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Determines the ligature level between adjacent text elements in the group. |
| If the elementFormat of the group is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>, the format of the first |
| of the adjacent elements is used.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the ligature level between the characters in the text element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#LigatureLevel" class="- topic/link "><linktext class="- topic/linktext ">LigatureLevel</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:locale:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">locale</apiName><shortdesc class="- topic/shortdesc "> |
| The locale of the text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The locale of the text. Controls case transformations and shaping. |
| Standard locale identifiers are used. For example "en", "en_US" and "en-US" are all |
| English, "ja" is Japanese. See <xref href="http://www.loc.gov/standards/iso639-2/php/code_list.php" scope="external" class="- topic/xref ">iso639-2 code list</xref> |
| for a list of locale codes. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">"en"</codeph>.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines transformations and shaping for the text in the element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ElementFormat:locked:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">locked</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates whether the ElementFormat is locked.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5." class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates whether the ElementFormat is locked. If <codeph class="+ topic/ph pr-d/codeph ">true</codeph> the ElementFormat cannot be modified. |
| Call <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.clone()</codeph> to get an unlocked copy of the ElementFormat object. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ElementFormat:textRotation:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textRotation</apiName><shortdesc class="- topic/shortdesc "> |
| Sets the rotation applied to individual glyphs.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Sets the rotation applied to individual glyphs. Use constants defined in the TextRotation class |
| for this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph>.</p> |
| |
| <p class="- topic/p ">The final rotation of any glyph is the sum of <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.textRotation</codeph>, <codeph class="+ topic/ph pr-d/codeph ">ContentElement.textRotation</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation</codeph>.</p> |
| |
| <p class="- topic/p ">You typically use this property for Asian text where characters must be rotated to display properly in vertical layout. |
| Use <codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph> in combination with <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation = TextRotation.ROTATE_90</codeph> |
| to accomplish this.</p> |
| |
| <p class="- topic/p ">Setting this property on fonts which do not contain vertical layout information can give undesirable results. |
| Fonts that contain a vmtx or VORG table, such as the Japanese font, "MS Mincho", work correctly because the |
| tables supply the data that the layout engine requires for correct layout. Fonts such as Verdana, which do not contain the necessary information, |
| do not.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph></entry><entry class="- topic/entry ">Glyphs are not rotated.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_90</codeph></entry><entry class="- topic/entry ">Glyphs are rotated 90 degrees clockwise.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_180</codeph></entry><entry class="- topic/entry ">Glyphs are rotated 180 degrees.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_270</codeph></entry><entry class="- topic/entry ">Glyphs are rotated 270 degrees clockwise.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph></entry><entry class="- topic/entry ">Specifies a 90 degree counter clockwise rotation for full width and wide glyphs only, |
| as determined by the Unicode properties of the glyph. |
| This value is typically used with Asian text to rotate |
| only those glyphs that require rotation. |
| This rotation is applied only in vertical text to return full width and wide |
| characters to a vertical orientation without affecting other characters.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the rotation of the glyphs in the text element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextRotation" class="- topic/link "><linktext class="- topic/linktext ">TextRotation</linktext></link><link href="flash.text.engine.xml#ContentElement/textRotation" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.textRotation</linktext></link><link href="flash.text.engine.xml#TextBlock/lineRotation" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.lineRotation</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ElementFormat:trackingLeft:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">trackingLeft</apiName><shortdesc class="- topic/shortdesc "> |
| The tracking or manual kerning applied to the left of each glyph in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5." class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The tracking or manual kerning applied to the left of each glyph in pixels. |
| If <codeph class="+ topic/ph pr-d/codeph ">kerning</codeph> is enabled, the <codeph class="+ topic/ph pr-d/codeph ">trackingLeft</codeph> value is added to the values in the |
| kerning table for the font. If <codeph class="+ topic/ph pr-d/codeph ">kerning</codeph> is disabled, the <codeph class="+ topic/ph pr-d/codeph ">trackingLeft</codeph> value |
| is used as a manual kerning value. Supports both positive and negative values. |
| |
| <p class="- topic/p ">Typically, the desired tracking value is split between <codeph class="+ topic/ph pr-d/codeph ">trackingRight</codeph> and <codeph class="+ topic/ph pr-d/codeph ">trackingLeft</codeph>. |
| Otherwise, in mixed directionality text, there is twice the tracking at one bidi boundary and none at the other.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">0.0</codeph>.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Determines the tracking applied to the left side of the graphic.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the tracking applied to the left side of characters in the text element.</entry></row></tbody></tgroup></adobetable> |
| |
| <p class="- topic/p ">Example:</p> |
| |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| //positive tracking added to kerning |
| var ef1:ElementFormat = new ElementFormat(); |
| ef1.kerning = flash.text.engine.Kerning.ON; |
| ef1.trackingLeft = 0.5; |
| |
| //negative manual kerning |
| var ef2:ElementFormat = new ElementFormat(); |
| ef2.kerning = flash.text.engine.Kerning.OFF; |
| ef2.trackingLeft = -1.0; |
| </codeblock> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ElementFormat:trackingRight:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">trackingRight</apiName><shortdesc class="- topic/shortdesc "> |
| The tracking or manual kerning applied to the right of each glyph in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5." class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The tracking or manual kerning applied to the right of each glyph in pixels. |
| If <codeph class="+ topic/ph pr-d/codeph ">kerning</codeph> is enabled, the <codeph class="+ topic/ph pr-d/codeph ">trackingRight</codeph> value is added to the values in the |
| kerning table for the font. If <codeph class="+ topic/ph pr-d/codeph ">kerning</codeph> is disabled, the <codeph class="+ topic/ph pr-d/codeph ">trackingRight</codeph> value |
| is used as a manual kerning value. Supports both positive and negative values. |
| |
| <p class="- topic/p ">Typically, the desired tracking value is split between <codeph class="+ topic/ph pr-d/codeph ">trackingRight</codeph> and <codeph class="+ topic/ph pr-d/codeph ">trackingLeft</codeph>. |
| Otherwise, in mixed directionality text, there is twice the tracking at one bidi boundary and none at the other.</p> |
| |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">0.0</codeph>.</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Determines the tracking applied to the right side of the graphic.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the tracking applied to the right side of characters in the text element.</entry></row></tbody></tgroup></adobetable> |
| |
| <p class="- topic/p ">Example:</p> |
| |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| //positive tracking added to kerning |
| var ef1:ElementFormat = new ElementFormat(); |
| ef1.kerning = flash.text.engine.Kerning.ON; |
| ef1.trackingRight = 0.5; |
| |
| //negative manual kerning |
| var ef2:ElementFormat = new ElementFormat(); |
| ef2.kerning = flash.text.engine.Kerning.OFF; |
| ef2.trackingRight = -1.0; |
| </codeblock> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ElementFormat:typographicCase:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">typographicCase</apiName><shortdesc class="- topic/shortdesc "> |
| The typographic case used for this text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to a value not a member of <codeph class="+ topic/ph pr-d/codeph ">TypographicCase</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the ElementFormat object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The typographic case used for this text. Use constants defined in the TypographicCase class for this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">TypographicCase.DEFAULT</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TypographicCase.DEFAULT</codeph></entry><entry class="- topic/entry ">Specifies that normal case is used for all characters.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TypographicCase.TITLE</codeph></entry><entry class="- topic/entry ">Specifies that uppercase characters use title glyphs on output.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TypographicCase.CAPS</codeph></entry><entry class="- topic/entry ">Specifies that spacing is adjusted for uppercase characters on output.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TypographicCase.SMALL_CAPS</codeph></entry><entry class="- topic/entry ">Specifies that uppercase characters use small caps glyphs on output.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TypographicCase.UPPERCASE</codeph></entry><entry class="- topic/entry ">Specifies that all characters use uppercase glyphs on output.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TypographicCase.LOWERCASE</codeph></entry><entry class="- topic/entry ">Specifies that all characters use lowercase glyphs on output.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TypographicCase.CAPS_AND_SMALL_CAPS</codeph></entry><entry class="- topic/entry ">Specifies that all lowercase characters use small caps glyphs on output.</entry></row></tbody></tgroup></adobetable> |
| <p class="- topic/p "/> |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Subclass</entry><entry class="- topic/entry ">Effect of setting property</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GraphicElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph></entry><entry class="- topic/entry ">Has no effect.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph></entry><entry class="- topic/entry ">Determines the typographic case used for the text in the element.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TypographicCase" class="- topic/link "><linktext class="- topic/linktext ">TypographicCase</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextJustifier" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextJustifier</apiName><shortdesc class="- topic/shortdesc "> |
| The TextJustifier class is an abstract base class for the justifier types that you can apply to a TextBlock, specifically the |
| EastAsianJustifier and SpaceJustifier classes.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextJustifier class is an abstract base class for the justifier types that you can apply to a TextBlock, specifically the |
| EastAsianJustifier and SpaceJustifier classes. |
| |
| <p class="- topic/p ">You cannot instantiate the TextJustifier class directly. Invoking <codeph class="+ topic/ph pr-d/codeph ">new TextJustifier()</codeph> throws an <codeph class="+ topic/ph pr-d/codeph ">ArgumentError</codeph> |
| exception. Setting the properties of an EastAsianJustifier or SpaceJustifier object after you apply it to a TextBlock does not |
| invalidate the TextBlock.</p> |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#EastAsianJustifier" class="- topic/link "><linktext class="- topic/linktext ">EastAsianJustifier</linktext></link><link href="flash.text.engine.xml#SpaceJustifier" class="- topic/link "><linktext class="- topic/linktext ">SpaceJustifier</linktext></link><link href="flash.text.engine.xml#TextBlock/textJustifier" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.textJustifier</linktext></link></related-links><apiConstructor id="flash.text.engine:TextJustifier:TextJustifier" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">TextJustifier</apiName><shortdesc class="- topic/shortdesc "> |
| Calling the new TextJustifier() constructor throws an |
| ArgumentError exception.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">locale</codeph> specified is <codeph class="+ topic/ph pr-d/codeph ">null</codeph> or too short to represent a valid locale. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">lineJustification</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">LineJustification</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">locale</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The locale to determine the justification rules. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">lineJustification</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The type of line justification for the paragraph. |
| Use <codeph class="+ topic/ph pr-d/codeph ">LineJustification</codeph> constants for this property. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Calling the <codeph class="+ topic/ph pr-d/codeph ">new TextJustifier()</codeph> constructor throws an |
| <codeph class="+ topic/ph pr-d/codeph ">ArgumentError</codeph> exception. You <i class="+ topic/ph hi-d/i ">can</i>, however, call constructors for |
| the following subclasses of TextJustifier: |
| |
| <ul class="- topic/ul "><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new SpaceJustifier()</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new EastAsianJustifier()</codeph></li></ul> |
| |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#EastAsianJustifier" class="- topic/link "><linktext class="- topic/linktext ">EastAsianJustifier</linktext></link><link href="flash.text.engine.xml#LineJustification" class="- topic/link "><linktext class="- topic/linktext ">LineJustification</linktext></link><link href="flash.text.engine.xml#SpaceJustifier" class="- topic/link "><linktext class="- topic/linktext ">SpaceJustifier</linktext></link></related-links></apiConstructor><apiOperation id="flash.text.engine:TextJustifier:clone" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">clone</apiName><shortdesc class="- topic/shortdesc "> |
| Constructs a cloned copy of the TextJustifier.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A copy of the <codeph class="+ topic/ph pr-d/codeph ">TextJustifier</codeph> object. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextJustifier</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Constructs a cloned copy of the TextJustifier. |
| |
| <p class="- topic/p ">Subclasses of TextJustifier must override this method.</p> |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextJustifier:getJustifierForLocale" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getJustifierForLocale</apiName><shortdesc class="- topic/shortdesc "> |
| Constructs a default TextJustifier subclass appropriate to the specified locale.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">locale</codeph> specified is <codeph class="+ topic/ph pr-d/codeph ">null</codeph> or too short to represent a valid locale. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A reference to a <codeph class="+ topic/ph pr-d/codeph ">TextJustifier</codeph> object. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextJustifier</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">locale</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The locale to determine the justifier constructed. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Constructs a default TextJustifier subclass appropriate to the specified locale. |
| |
| <p class="- topic/p ">If the locale is Chinese, Korean, or Japanese, the method constructs a default EastAsianJustifier object. |
| Otherwise the text engine constructs a default SpaceJustifier object.</p> |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiValue id="flash.text.engine:TextJustifier:lineJustification:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">lineJustification</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the line justification for the text in a text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the line justification for the text in a text block. |
| |
| <p class="- topic/p ">Use the following constants defined by the <codeph class="+ topic/ph pr-d/codeph ">LineJustification</codeph> as valid values for this property:</p> |
| |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LineJustification.UNJUSTIFIED</codeph></entry><entry class="- topic/entry ">Generates unjustified lines.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LineJustification.ALL_BUT_LAST</codeph></entry><entry class="- topic/entry ">Generates all lines justified except for the last one.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">LineJustification.ALL_INCLUDING_LAST</codeph></entry><entry class="- topic/entry ">Generates all lines justified.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#LineJustification" class="- topic/link "><linktext class="- topic/linktext ">LineJustification</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextJustifier:locale:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">locale</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the locale to determine the justification rules for the text in a text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">locale</codeph> specified is <codeph class="+ topic/ph pr-d/codeph ">null</codeph> or too short to represent a valid locale. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the locale to determine the justification rules for the text in a text block. |
| Standard locale identifiers are used. For example "en", "en_US" and "en-US" are all |
| English, "ja" is Japanese. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:FontDescription" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">FontDescription</apiName><shortdesc class="- topic/shortdesc "> |
| The FontDescription class represents the information necessary to describe a font.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The FontDescription class represents the information necessary to describe a font. |
| |
| <p class="- topic/p ">A FontDescription object is applied to an ElementFormat, |
| which is in turn applied to a ContentElement in a TextBlock. Once a FontDescription has been |
| applied to an ElementFormat, its <codeph class="+ topic/ph pr-d/codeph ">locked</codeph> property is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>. |
| The properties of a locked FontDescription object cannot be changed. Instead, use the <codeph class="+ topic/ph pr-d/codeph ">clone()</codeph> |
| method to create an unlocked copy of the object, which can be modified and assigned to the ElementFormat.</p> |
| |
| <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> FTE (Flash Text Engine) does not support Type 1 fonts or bitmap fonts such as Type 3, |
| ATC, sfnt-wrapped CID, or Naked CID.</p> |
| |
| </apiDesc><example conref="examples\FontDescriptionExample.as" class="- topic/example "> <p class="- topic/p ">This example creates a <codeph class="+ topic/ph pr-d/codeph ">FontDescription</codeph> object, assigns |
| a device font to it, sets various font properties, |
| and assigns the new object to an <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> object. |
| Additional font formatting is done within <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph>. A new |
| <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> is created, using the <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph>, and |
| the <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> is used as content for a <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. A |
| line of text is created from the <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>.</p> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.text.engine.*; |
| |
| |
| public class FontDescriptionExample extends Sprite { |
| |
| public function FontDescriptionExample():void { |
| var fd:FontDescription = new FontDescription(); |
| fd.fontLookup = flash.text.engine.FontLookup.DEVICE; |
| fd.fontName = "Palatino"; |
| fd.fontWeight = flash.text.engine.FontWeight.BOLD; |
| fd.fontPosture = flash.text.engine.FontPosture.ITALIC; |
| |
| var ef1:ElementFormat = new ElementFormat(fd); |
| ef1.fontSize = 30; |
| ef1.color = 0xFF0000; |
| |
| var str:String = "This is flash text 0123456789"; |
| var tb:TextBlock = new TextBlock(); |
| var te1:TextElement = new TextElement(str, ef1); |
| tb.content = te1; |
| var line1:TextLine = tb.createTextLine(null, 600); |
| addChild(line1); |
| |
| } |
| } |
| } |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/fontDescription" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.fontDescription</linktext></link></related-links><apiConstructor id="flash.text.engine:FontDescription:FontDescription" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">FontDescription</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a FontDescription object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontWeight</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontWeight</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontPosture</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontPosture</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontLookup</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontLookup</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">renderingMode</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">RenderingMode</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">cffHinting</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">CFFHinting</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontName</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">_serif</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The name of the font to use, or a comma-separated list of font names. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontWeight</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">normal</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the font weight. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontPosture</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">normal</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the font posture. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontLookup</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">device</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies how to look up the font. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">renderingMode</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">cff</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rendering mode used for this text. Use <codeph class="+ topic/ph pr-d/codeph ">RenderingMode</codeph> |
| constants for this property. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">cffHinting</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">horizontalStem</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The type of CFF (Compact Font Format) hinting used for this text. Use <codeph class="+ topic/ph pr-d/codeph ">CFFHinting</codeph> |
| constants for this property. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a FontDescription object. |
| |
| </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="flash.text.engine:FontDescription:clone" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">clone</apiName><shortdesc class="- topic/shortdesc "> |
| Constructs an unlocked, cloned copy of the FontDescription.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">An unlocked copy of the <codeph class="+ topic/ph pr-d/codeph ">FontDescription</codeph> object. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:FontDescription</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Constructs an unlocked, cloned copy of the FontDescription. |
| |
| </apiDesc><example conref="examples\FontDescription_cloneExample.as" class="- topic/example "> <p class="- topic/p ">This example creates a <codeph class="+ topic/ph pr-d/codeph ">FontDescription</codeph> object, assigns |
| a device font to it, sets various font properties, |
| and assigns the new object (and therefore locking it) to an <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> object. |
| A new <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> is created, using the <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph>, and |
| the <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> is used as content for a <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. A |
| line of text is created from the <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>.</p> |
| <p class="- topic/p ">To modify the <codeph class="+ topic/ph pr-d/codeph ">FontDescription</codeph> object, first check its |
| <codeph class="+ topic/ph pr-d/codeph ">locked</codeph> property. If true, use the <codeph class="+ topic/ph pr-d/codeph ">clone()</codeph> method to |
| create an unlocked copy of the <codeph class="+ topic/ph pr-d/codeph ">FontDescription</codeph>, change its properties, |
| and assign it to a new ElementFormat object. Then re-link |
| the new <codeph class="+ topic/ph pr-d/codeph ">ElementFormat</codeph> to the <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. |
| When the lines are re-broken, the new lines will have the new font settings.</p> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.text.engine.*; |
| |
| |
| public class FontDescription_cloneExample extends Sprite { |
| private var fd:FontDescription; |
| private var fd2:FontDescription; |
| |
| public function FontDescription_cloneExample():void { |
| fd = new FontDescription(); |
| fd.fontLookup = flash.text.engine.FontLookup.DEVICE; |
| fd.fontName = "Palatino"; |
| fd.fontWeight = flash.text.engine.FontWeight.BOLD; |
| fd.fontPosture = flash.text.engine.FontPosture.ITALIC; |
| |
| var ef1:ElementFormat = new ElementFormat(fd); |
| |
| var str:String = "This is flash text 0123456789"; |
| var tb:TextBlock = new TextBlock(); |
| var te1:TextElement = new TextElement(str, ef1); |
| tb.content = te1; |
| var line1:TextLine = tb.createTextLine(null, 600); |
| addChild(line1); |
| |
| fd2 = (fd.locked) ? fd.clone() : fd; |
| fd2.fontWeight = flash.text.engine.FontWeight.NORMAL; |
| var ef2:ElementFormat = new ElementFormat(fd2); |
| |
| tb.content.elementFormat=ef2; |
| var line2:TextLine = tb.createTextLine(null, 600); |
| addChild(line2); |
| |
| } |
| } |
| } |
| </codeblock></example></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:FontDescription:isDeviceFontCompatible" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">isDeviceFontCompatible</apiName><shortdesc class="- topic/shortdesc "> |
| Returns true if a usable device font is available with the specified fontName, fontWeight, and fontPosture.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontWeight</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontWeight</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontPosture</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontPosture</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc "><codeph class="+ topic/ph pr-d/codeph ">true</codeph> if a compatible device font is available, otherwise <codeph class="+ topic/ph pr-d/codeph ">false</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontName</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The name of the device font to check. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontWeight</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the font weight. Use <codeph class="+ topic/ph pr-d/codeph ">FontWeight</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontPosture</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the font posture. Use <codeph class="+ topic/ph pr-d/codeph ">FontPosture</codeph>. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns true if a usable device font is available with the specified <codeph class="+ topic/ph pr-d/codeph ">fontName</codeph>, <codeph class="+ topic/ph pr-d/codeph ">fontWeight</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">fontPosture</codeph>. |
| |
| <p class="- topic/p ">The flash.text.engine classes can only use OpenType and TrueType device fonts. If a font based on an older font technology is used, |
| the runtime falls back to known good device fonts on a glyph-by-glyph basis to render the text</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/fontLookup" class="- topic/link "><linktext class="- topic/linktext ">fontLookup</linktext></link><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link><link href="flash.text.engine.xml#FontPosture" class="- topic/link "><linktext class="- topic/linktext ">FontPosture</linktext></link><link href="flash.text.engine.xml#FontWeight" class="- topic/link "><linktext class="- topic/linktext ">FontWeight</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:FontDescription:isFontCompatible" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">isFontCompatible</apiName><shortdesc class="- topic/shortdesc "> |
| Returns true if an embedded font is available with the specified fontName, fontWeight, and fontPosture |
| where Font.fontType is flash.text.FontType.EMBEDDED_CFF.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontWeight</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontWeight</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">fontPosture</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontPosture</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc "><codeph class="+ topic/ph pr-d/codeph ">true</codeph> if a compatible embedded font is available, otherwise <codeph class="+ topic/ph pr-d/codeph ">false</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontName</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The name of the embedded font to check. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontWeight</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the font weight. Use <codeph class="+ topic/ph pr-d/codeph ">FontWeight</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fontPosture</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the font posture. Use <codeph class="+ topic/ph pr-d/codeph ">FontPosture</codeph>. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns true if an embedded font is available with the specified <codeph class="+ topic/ph pr-d/codeph ">fontName</codeph>, <codeph class="+ topic/ph pr-d/codeph ">fontWeight</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">fontPosture</codeph> |
| where <codeph class="+ topic/ph pr-d/codeph ">Font.fontType</codeph> is <codeph class="+ topic/ph pr-d/codeph ">flash.text.FontType.EMBEDDED_CFF</codeph>. Starting with Flash Player 10, |
| two kinds of embedded fonts can appear in application content. Normal embedded fonts are only used by TextField. |
| CFF embedded fonts are only used by the flash.text.engine classes. The two types are distinguised by the |
| <codeph class="+ topic/ph pr-d/codeph ">fontType</codeph> property of the <codeph class="+ topic/ph pr-d/codeph ">Font</codeph> class, as returned by the <codeph class="+ topic/ph pr-d/codeph ">enumerateFonts()</codeph> function. |
| |
| <p class="- topic/p ">The flash.text.engine classes cannot use a font of type <codeph class="+ topic/ph pr-d/codeph ">EMBEDDED</codeph>. If <codeph class="+ topic/ph pr-d/codeph ">fontLookup</codeph> is set |
| to <codeph class="+ topic/ph pr-d/codeph ">FontLookup.EMBEDDED_CFF</codeph> and the only font available at run time with the specified name, weight, and posture is of type |
| <codeph class="+ topic/ph pr-d/codeph ">EMBEDDED</codeph>, the runtime falls back to device fonts on a glyph-by-glyph basis to render the text, |
| as if no embedded font were available with the specified name and style.</p> |
| |
| <p class="- topic/p ">If both <codeph class="+ topic/ph pr-d/codeph ">EMBEDDED</codeph> and <codeph class="+ topic/ph pr-d/codeph ">EMBEDDED_CFF</codeph> fonts are available with the same name, weight, and posture, the <codeph class="+ topic/ph pr-d/codeph ">EMBEDDED_CFF</codeph> |
| font is selected and text renders with the <codeph class="+ topic/ph pr-d/codeph ">EMBEDDED_CFF</codeph> font.</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/fontLookup" class="- topic/link "><linktext class="- topic/linktext ">fontLookup</linktext></link><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link><link href="flash.text.xml#FontType/EMBEDDED_CFF" class="- topic/link "><linktext class="- topic/linktext ">FontType.EMBEDDED_CFF</linktext></link><link href="flash.text.engine.xml#FontPosture" class="- topic/link "><linktext class="- topic/linktext ">FontPosture</linktext></link><link href="flash.text.engine.xml#FontWeight" class="- topic/link "><linktext class="- topic/linktext ">FontWeight</linktext></link></related-links></apiOperation><apiValue id="flash.text.engine:FontDescription:cffHinting:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">cffHinting</apiName><shortdesc class="- topic/shortdesc "> |
| The type of CFF hinting used for this text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">CFFHinting</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the FontDescription object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The type of CFF hinting used for this text. Use <codeph class="+ topic/ph pr-d/codeph ">CFFHinting</codeph> |
| constants for this property. This property applies only if the |
| <codeph class="+ topic/ph pr-d/codeph ">RenderingMode</codeph> property of the text is set to <codeph class="+ topic/ph pr-d/codeph ">RenderingMode.CFF</codeph>. |
| |
| <p class="- topic/p ">The type of CFF (Compact Font Format) hinting used determines whether the Flash runtime forces strong horizontal |
| stems to fit to a sub-pixel grid or not.</p> |
| |
| <p class="- topic/p ">Applies only to embedded fonts.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">CFFHinting.HORIZONTAL_STEM</codeph>.</p> |
| |
| <p class="- topic/p ">For the <codeph class="+ topic/ph pr-d/codeph ">CFFHinting</codeph> property, you can use the following constants from the CFFHinting class:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">CFFHinting.NONE</codeph></entry><entry class="- topic/entry ">Specifies no CFF hinting. Horizontal stems in the glyphs are not |
| forced to the sub-pixel grid. This setting is appropriate for animation or |
| for large font sizes.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">CFFHinting.HORIZONTAL_STEM</codeph></entry><entry class="- topic/entry ">Specifies CFF hinting. Strong horizontal stems are fit to the sub-pixel grid on |
| a screen. To use this setting, the |
| <codeph class="+ topic/ph pr-d/codeph ">RenderingMode</codeph> property must be set to <codeph class="+ topic/ph pr-d/codeph ">RenderingMode.CFF</codeph>.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#CFFHinting" class="- topic/link "><linktext class="- topic/linktext ">CFFHinting</linktext></link><link href="flash.text.engine.xml#FontDescription/renderingMode" class="- topic/link "><linktext class="- topic/linktext ">FontDescription.renderingMode</linktext></link><link href="flash.text.engine.xml#RenderingMode" class="- topic/link "><linktext class="- topic/linktext ">RenderingMode</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontDescription:fontLookup:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">fontLookup</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies how the font should be looked up.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the FontDescription object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies how the font should be looked up. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">FontLookup.DEVICE</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">FontLookup.DEVICE</codeph></entry><entry class="- topic/entry ">The runtime looks up a device font with the specified <codeph class="+ topic/ph pr-d/codeph ">name</codeph> |
| on the local system with which to render the text.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">FontLookup.EMBEDDED_CFF</codeph></entry><entry class="- topic/entry ">The runtime looks up an embedded CFF font with the specified <codeph class="+ topic/ph pr-d/codeph ">name</codeph> |
| with which to render the text. Only fonts of type <codeph class="+ topic/ph pr-d/codeph ">flash.text.Font.fontType.EMBEDDED_CFF</codeph> |
| are considered. |
| If the specified CFF font is not embedded in the application, the runtime attempts |
| to use a fallback device font for each glyph. This method is less efficient |
| than selecting a device font in the first place.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#CFFHinting" class="- topic/link "><linktext class="- topic/linktext ">CFFHinting</linktext></link><link href="flash.text.engine.xml#FontLookup" class="- topic/link "><linktext class="- topic/linktext ">FontLookup</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontDescription:fontName:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">fontName</apiName><shortdesc class="- topic/shortdesc "> |
| The name of the font to use, or a comma-separated list of font names.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the FontDescription object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The name of the font to use, or a comma-separated list of font names. The runtime renders |
| the element with the first available font in the list. For example "Arial, Helvetica, _sans" |
| causes the player to search for Arial, then Helvetica, if Arial is not found, then _sans, if neither is found. |
| |
| <p class="- topic/p ">Flash runtimes support three generic device font names: _sans (for sans serif fonts), _serif (for serif fonts), |
| and _typewriter (for mono-space fonts). These are mapped to specific device fonts depending on the platform.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">"_serif"</codeph>.</p> |
| |
| <p class="- topic/p ">Flash runtimes provide font fallback for glyphs which are not found in the selected font. |
| Whether the font in use is embedded or device, if the glyph is not found in the font, |
| the runtime attempts to render it using another device font likely to contain the glyph.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontLookup" class="- topic/link "><linktext class="- topic/linktext ">FontLookup</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontDescription:fontPosture:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">fontPosture</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the font posture.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontPosture</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the FontDescription object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the font posture. |
| |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">FontPosture.NORMAL</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following constants from the FontPosture class:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">Value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">FontPosture.NORMAL</codeph></entry><entry class="- topic/entry ">Normal font posture.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">FontPosture.ITALIC</codeph></entry><entry class="- topic/entry ">Italic font posture.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontPosture" class="- topic/link "><linktext class="- topic/linktext ">FontPosture</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontDescription:fontWeight:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">fontWeight</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the font weight.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">FontWeight</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the FontDescription object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the font weight. |
| |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">FontWeight.NORMAL</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following constants from the FontWeight class:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">FontWeight.NORMAL</codeph></entry><entry class="- topic/entry ">Normal font weight.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">FontWeight.BOLD</codeph></entry><entry class="- topic/entry ">Bold font weight.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontWeight" class="- topic/link "><linktext class="- topic/linktext ">FontWeight</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:FontDescription:locked:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">locked</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates whether or not the FontDescription is locked.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5." class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the FontDescription object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates whether or not the FontDescription is locked. If <codeph class="+ topic/ph pr-d/codeph ">true</codeph> the FontDescription cannot be modified. |
| Call <codeph class="+ topic/ph pr-d/codeph ">FontDescription.clone()</codeph> to get an unlocked copy of the FontDescription object. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontDescription:renderingMode:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">renderingMode</apiName><shortdesc class="- topic/shortdesc "> |
| The rendering mode used for this text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">RenderingMode</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set after the FontDescription object is locked (<codeph class="+ topic/ph pr-d/codeph ">locked</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>). |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The rendering mode used for this text. Use <codeph class="+ topic/ph pr-d/codeph ">RenderingMode</codeph> |
| constants for this property. |
| |
| <p class="- topic/p ">Applies only to embedded fonts.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">RenderingMode.CFF</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following constants from the RenderingMode class:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">RenderingMode.NORMAL</codeph></entry><entry class="- topic/entry ">Applies the regular text rendering, which matches the type of rendering that |
| Flash Player 7 and earlier versions used.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">RenderingMode.CFF</codeph></entry><entry class="- topic/entry ">Applies CFF (Compact Font Format) rendering, which makes text more legible. (This feature became |
| available in Flash Player 10.) CFF rendering allows for high-quality rendering |
| of font faces at small sizes.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#RenderingMode" class="- topic/link "><linktext class="- topic/linktext ">RenderingMode</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:GroupElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">GroupElement</apiName><shortdesc class="- topic/shortdesc "> |
| A GroupElement object groups a collection of TextElement, GraphicElement, or other GroupElement objects |
| that you can assign as a unit to the content property of a TextBlock object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.text.engine:ContentElement</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| A GroupElement object groups a collection of TextElement, GraphicElement, or other GroupElement objects |
| that you can assign as a unit to the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property of a TextBlock object. A GroupElement |
| object can also simply share common formatting within another GroupElement object. |
| |
| <p class="- topic/p ">When a GroupElement contains another GroupElement, the inner GroupElement retains its own formatting (ElementFormat settings). It does |
| not inherit the formatting of the outer GroupElement.</p> |
| |
| <p class="- topic/p ">On a GroupElement, most of the format properties have no impact. For this reason, it is legal to create a text line for a GroupElement object |
| that has a null <codeph class="+ topic/ph pr-d/codeph ">elementFormat</codeph> parameter. A few format properties such as <codeph class="+ topic/ph pr-d/codeph ">kerning</codeph> and <codeph class="+ topic/ph pr-d/codeph ">ligature</codeph> |
| do affect formatting where intersections occur between members of the group. If the group has a null format, the format of the preceding |
| element determines the formatting where intersections occur between members of the group.</p> |
| |
| </apiDesc><example conref="examples\GroupElementExample.as" class="- topic/example "> This example creates a red box as a GraphicElement object and combines |
| it with two TextElement objects to create a GroupElement object. It assigns the GroupElement |
| object to the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property of a TextBlock, from which it creates three lines. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.display.MovieClip; |
| import flash.text.engine.ContentElement; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.GraphicElement; |
| import flash.text.engine.GroupElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.FontDescription; |
| |
| public class GroupElementExample extends Sprite { |
| |
| public function GroupElementExample():void { |
| |
| var redBox:MovieClip = new MovieClip(); |
| redBox.graphics.beginFill(0xCC0000, 1.0); |
| redBox.graphics.drawRect(0, 0, 20, 20); |
| redBox.graphics.endFill(); |
| |
| var format:ElementFormat = new ElementFormat(); |
| var fontDescription:FontDescription = new FontDescription("Arial"); |
| format.fontSize = 16; |
| format.fontDescription = fontDescription; |
| |
| var str1:String = "This red box is a GraphicElement "; |
| var str2:String = " in the middle of two TextElements, " + |
| " which together make " + |
| "up a GroupElement in a TextBlock that is broken into three lines."; |
| |
| var textElement1:TextElement = new TextElement(str1,format); |
| var graphicElement:GraphicElement = new GraphicElement(redBox,redBox.width,redBox.height, format); |
| var textElement2:TextElement = new TextElement(str2, format); |
| var groupVector:Vector.<ContentElement> = new Vector.<ContentElement>(); |
| groupVector.push(textElement1, graphicElement, textElement2); |
| var groupElement = new GroupElement(groupVector); |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = groupElement; |
| createTextLines(textBlock); |
| } |
| |
| private function createTextLines(textBlock:TextBlock):void |
| { |
| |
| var yPos = 20; |
| var line_length:Number = 450; |
| var textLine:TextLine = textBlock.createTextLine (null, line_length); |
| |
| while (textLine) |
| { |
| addChild(textLine); |
| textLine.x = 15; |
| yPos += textLine.height+8; |
| textLine.y = yPos; |
| textLine = textBlock.createTextLine(textLine, line_length); |
| } |
| } |
| } |
| } |
| |
| |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement" class="- topic/link "><linktext class="- topic/linktext ">ContentElement</linktext></link><link href="flash.text.engine.xml#GraphicElement" class="- topic/link "><linktext class="- topic/linktext ">GraphicElement</linktext></link><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link><link href="flash.text.engine.xml#TextElement" class="- topic/link "><linktext class="- topic/linktext ">TextElement</linktext></link></related-links><apiConstructor id="flash.text.engine:GroupElement:GroupElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">GroupElement</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a new GroupElement instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The specified <codeph class="+ topic/ph pr-d/codeph ">element</codeph> contains <codeph class="+ topic/ph pr-d/codeph ">null</codeph> elements. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The specified <codeph class="+ topic/ph pr-d/codeph ">element</codeph> contains an element that is not a known subclass of <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The specified <codeph class="+ topic/ph pr-d/codeph ">element</codeph> contains elements that are specified as the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> of a <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The specified <codeph class="+ topic/ph pr-d/codeph ">element</codeph> contains elements that are already members of a group, or appear more than once in |
| the <codeph class="+ topic/ph pr-d/codeph ">elements</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elements</apiItemName><apiType value="Vector$flash.text.engine:ContentElement" name="type" class="- topic/state reference/state apiRef/apiType "/><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Vector of ContentElement objects to be contained in the GroupElement. |
| The Vector can be empty. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elementFormat</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ElementFormat</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The element format for the group. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| This format applies to the intersections between elements in the group; those elements do not inherit the format. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">eventMirror</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.events:EventDispatcher</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">EventDispatcher</codeph> object that receives copies of every |
| event dispatched to text lines created based on this content element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">textRotation</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rotation applied to the element as a unit. Use <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph> constants for |
| this property. The default value is <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a new GroupElement instance. |
| |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement" class="- topic/link "><linktext class="- topic/linktext ">ContentElement</linktext></link><link href="flash.text.engine.xml#ElementFormat" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat</linktext></link><link href="flash.events.xml#EventDispatcher" class="- topic/link "><linktext class="- topic/linktext ">flash.events.EventDispatcher</linktext></link><link href="flash.text.engine.xml#TextLineMirrorRegion" class="- topic/link "><linktext class="- topic/linktext ">TextLineMirrorRegion</linktext></link><link href="flash.text.engine.xml#TextRotation" class="- topic/link "><linktext class="- topic/linktext ">TextRotation</linktext></link></related-links></apiConstructor><apiOperation id="flash.text.engine:GroupElement:getElementAtCharIndex" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getElementAtCharIndex</apiName><shortdesc class="- topic/shortdesc "> |
| Returns the element containing the character specified by the charIndex parameter.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph> is not in the range of <codeph class="+ topic/ph pr-d/codeph ">0 - rawText.length</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The element containing the character at <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ContentElement</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">charIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the character whose element you want to find. |
| A value of 0 corresponds to the first character in the group, not the first character in the TextBlock. |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns the element containing the character specified by the <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph> parameter. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:GroupElement:getElementAt" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getElementAt</apiName><shortdesc class="- topic/shortdesc "> |
| Retrieves an element from within the group.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">index</codeph> is out of range. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ContentElement</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">index</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the element to retrieve. |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Retrieves an element from within the group. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:GroupElement:getElementIndex" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getElementIndex</apiName><shortdesc class="- topic/shortdesc "> |
| Returns the index of the element specified by the element parameter.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the element specified by <codeph class="+ topic/ph pr-d/codeph ">element</codeph>, or -1 if the element is not in the group. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">element</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ContentElement</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The element in the group whose index you want to retrieve. |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns the index of the element specified by the <codeph class="+ topic/ph pr-d/codeph ">element</codeph> parameter. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:GroupElement:groupElements" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">groupElements</apiName><shortdesc class="- topic/shortdesc "> |
| Replaces the range of elements that the beginIndex and endIndex |
| parameters specify with a new GroupElement containing those elements.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> or <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> is out of range. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The new group. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:GroupElement</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">beginIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the start position of the range to group. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">endIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value following the end position of the range to group. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Replaces the range of elements that the <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> |
| parameters specify with a new <codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph> containing those elements. |
| As designed, the elements from beginIndex to endIndex-1 are replaced. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:GroupElement:mergeTextElements" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">mergeTextElements</apiName><shortdesc class="- topic/shortdesc "> |
| Merges the text from the range of elements that the beginIndex and endIndex |
| parameters specify into the element specified by beginIndex without affecting the format of that element.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> or <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If any of the elements in the specified range is not TextElement. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The first text element in the range, now containing all the text in the range. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextElement</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">beginIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the start position of the range to merge. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">endIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value following the end position of the range to merge. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Merges the text from the range of elements that the <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> |
| parameters specify into the element specified by <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> without affecting the format of that element. |
| As designed, the text from elements from beginIndex to endIndex-1 are merged. |
| After their text has been merged, elements from beginIndex+1 to endIndex-1 are removed from the group and orphaned, |
| with <codeph class="+ topic/ph pr-d/codeph ">null</codeph> <codeph class="+ topic/ph pr-d/codeph ">group</codeph> properties. |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextElement" class="- topic/link "><linktext class="- topic/linktext ">TextElement</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:GroupElement:replaceElements" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">replaceElements</apiName><shortdesc class="- topic/shortdesc "> |
| Replaces the range of elements that the beginIndex and |
| endIndex parameters specify with the contents |
| of the newElements parameter.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> or <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">newElements</codeph> specified contain <codeph class="+ topic/ph pr-d/codeph ">null</codeph> elements. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">newElements</codeph> specified contain <codeph class="+ topic/ph pr-d/codeph ">this</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">newElements</codeph> specified contain elements that are not a known subclass of <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph> . |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">newElements</codeph> specified contain elements that are specified as the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> of a <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">newElements</codeph> specified contain elements that are already members of a group or appear |
| more than once in the <codeph class="+ topic/ph pr-d/codeph ">elements</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the operation would result in nested rotations within the <codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Vector containing the elements that were replaced. |
| |
| </apiDesc><apiType value="Vector$flash.text.engine:ContentElement" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">beginIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the start position of the replacement range. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">endIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value following the end position of the replacement range. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">newElements</apiItemName><apiType value="Vector$flash.text.engine:ContentElement" name="type" class="- topic/state reference/state apiRef/apiType "/><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The elements to use to replace the specified range of elements. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Replaces the range of elements that the <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and |
| <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph> parameters specify with the contents |
| of the <codeph class="+ topic/ph pr-d/codeph ">newElements</codeph> parameter. |
| The elements from beginIndex to endIndex-1 are replaced. |
| <p class="- topic/p ">To delete elements, pass <codeph class="+ topic/ph pr-d/codeph ">null</codeph> for <codeph class="+ topic/ph pr-d/codeph ">newElements</codeph>. |
| To insert an element, pass the same value for <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph>. |
| The new element is inserted before the specified index. |
| To append an element, pass <codeph class="+ topic/ph pr-d/codeph ">elementCount</codeph> for <codeph class="+ topic/ph pr-d/codeph ">beginIndex</codeph> and <codeph class="+ topic/ph pr-d/codeph ">endIndex</codeph>.</p> |
| <p class="- topic/p ">After the operation, the replaced elements are orphaned, with <codeph class="+ topic/ph pr-d/codeph ">null</codeph> <codeph class="+ topic/ph pr-d/codeph ">group</codeph> properties and returned.</p> |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:GroupElement:setElements" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">setElements</apiName><shortdesc class="- topic/shortdesc "> |
| Sets the elements in the group to the contents of the Vector.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified contains <codeph class="+ topic/ph pr-d/codeph ">null</codeph> elements. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified contains <codeph class="+ topic/ph pr-d/codeph ">this</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified contains elements that are not a known subclass of <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph> . |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified contains elements that are specified as the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> of a <codeph class="+ topic/ph pr-d/codeph ">TextBlock</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified contains elements that are already members of a group, or appear more than once |
| in the <codeph class="+ topic/ph pr-d/codeph ">value</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the operation would result in nested rotations within the <codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">value</apiItemName><apiType value="Vector$flash.text.engine:ContentElement" name="type" class="- topic/state reference/state apiRef/apiType "/></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Sets the elements in the group to the contents of the Vector. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:GroupElement:splitTextElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">splitTextElement</apiName><shortdesc class="- topic/shortdesc "> |
| Splits a TextElement into two, creating a new TextElement at the specified position.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">elementIndex</codeph> or <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph> is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the element at <codeph class="+ topic/ph pr-d/codeph ">elementIndex</codeph> is not a TextElement. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The new text element containing the latter portion of the original text element. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextElement</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elementIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the position of the element in the group. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">splitIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the character in the TextElement where the split is to occur. |
| The specified character is the first character in the new TextElement. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Splits a TextElement into two, creating a new TextElement at the specified position. |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextElement" class="- topic/link "><linktext class="- topic/linktext ">TextElement</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:GroupElement:ungroupElements" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">ungroupElements</apiName><shortdesc class="- topic/shortdesc "> |
| Ungroups the elements in a nested GroupElement that groupIndex specifies within an outer |
| GroupElement object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">groupIndex</codeph> is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the element at <codeph class="+ topic/ph pr-d/codeph ">groupIndex</codeph> is not a GroupElement. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">groupIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value for the position of the group to be split. |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Ungroups the elements in a nested GroupElement that <codeph class="+ topic/ph pr-d/codeph ">groupIndex</codeph> specifies within an outer |
| GroupElement object. After the operation, the ungrouped elements replace the nested GroupElement, which becomes an orphan |
| with a <codeph class="+ topic/ph pr-d/codeph ">null</codeph> <codeph class="+ topic/ph pr-d/codeph ">group</codeph> property. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiValue id="flash.text.engine:GroupElement:elementCount:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">elementCount</apiName><shortdesc class="- topic/shortdesc "> |
| The number of elements in the group.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The number of elements in the group. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:ContentElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">ContentElement</apiName><shortdesc class="- topic/shortdesc "> |
| The ContentElement class serves as a base class for the element types that can appear in a GroupElement, namely a GraphicElement, |
| another GroupElement, or a TextElement.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The ContentElement class serves as a base class for the element types that can appear in a GroupElement, namely a GraphicElement, |
| another GroupElement, or a TextElement. |
| |
| <p class="- topic/p ">ContentElement is an abstract base class; therefore, you cannot instantiate ContentElement directly. |
| Invoking <codeph class="+ topic/ph pr-d/codeph ">new ContentElement()</codeph> throws an <codeph class="+ topic/ph pr-d/codeph ">ArgumentError</codeph> exception. </p> |
| |
| <p class="- topic/p ">You can assign a ContentElement element to exactly one <codeph class="+ topic/ph pr-d/codeph ">GroupElement</codeph> or to the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property of exactly one text |
| block.</p> |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat</linktext></link><link href="flash.text.engine.xml#GraphicElement" class="- topic/link "><linktext class="- topic/linktext ">GraphicElement</linktext></link><link href="flash.text.engine.xml#GroupElement" class="- topic/link "><linktext class="- topic/linktext ">GroupElement</linktext></link><link href="flash.text.engine.xml#TextBlock/content" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.content</linktext></link><link href="flash.text.engine.xml#TextElement" class="- topic/link "><linktext class="- topic/linktext ">TextElement</linktext></link><link href="flash.text.engine.xml#TextLineMirrorRegion" class="- topic/link "><linktext class="- topic/linktext ">TextLineMirrorRegion</linktext></link><link href="flash.text.engine.xml#TextRotation" class="- topic/link "><linktext class="- topic/linktext ">TextRotation</linktext></link></related-links><apiConstructor id="flash.text.engine:ContentElement:ContentElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">ContentElement</apiName><shortdesc class="- topic/shortdesc "> |
| Calling the new ContentElement() constructor throws an |
| ArgumentError exception.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elementFormat</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ElementFormat</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The element format for the text in the element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">eventMirror</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.events:EventDispatcher</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">EventDispatcher</codeph> object that receives copies of every |
| event dispatched to valid text lines created based on this content element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">textRotation</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rotation applied the element as a unit. Use <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph> |
| constants for this property. The default value is <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Calling the <codeph class="+ topic/ph pr-d/codeph ">new ContentElement()</codeph> constructor throws an |
| <codeph class="+ topic/ph pr-d/codeph ">ArgumentError</codeph> exception. You <i class="+ topic/ph hi-d/i ">can</i>, however, call constructors for |
| the following subclasses of ContentElement: |
| |
| <ul class="- topic/ul "><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new GraphicElement()</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new GroupElement()</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new TextElement()</codeph></li></ul> |
| |
| </apiDesc></apiConstructorDetail></apiConstructor><apiValue id="flash.text.engine:ContentElement:GRAPHIC_ELEMENT" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">GRAPHIC_ELEMENT</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates the presence of a graphic element in the text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">0xFDEF</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">uint</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates the presence of a graphic element in the text. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/rawText" class="- topic/link "><linktext class="- topic/linktext ">rawText</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ContentElement:userData" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">userData</apiName><shortdesc class="- topic/shortdesc "> |
| Provides a way for an application to associate arbitrary data with the element.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiType value="" name="type" class="- topic/state reference/state apiRef/apiType "/></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Provides a way for an application to associate arbitrary data with the element. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ContentElement:elementFormat:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">elementFormat</apiName><shortdesc class="- topic/shortdesc "> |
| The ElementFormat object used for the element.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:ElementFormat</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The ElementFormat object used for the element. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| <p class="- topic/p ">When the <codeph class="+ topic/ph pr-d/codeph ">elementFormat</codeph> property is set, the ElementFormat object provided is locked: its <codeph class="+ topic/ph pr-d/codeph ">locked</codeph> |
| property is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>. A locked ElementFormat cannot be modified.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat</linktext></link><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link><link href="flash.text.engine.xml#TextElement" class="- topic/link "><linktext class="- topic/linktext ">TextElement</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ContentElement:eventMirror:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">eventMirror</apiName><shortdesc class="- topic/shortdesc "> |
| The EventDispatcher object that receives copies of every |
| event dispatched to valid text lines based on this content element.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.events:EventDispatcher</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The <codeph class="+ topic/ph pr-d/codeph ">EventDispatcher</codeph> object that receives copies of every |
| event dispatched to valid 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 lines have resulted from particular 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 <codeph class="+ topic/ph pr-d/codeph ">null</codeph>, which means no mirrored events are dispatched. |
| |
| <p class="- topic/p ">Event mirrors manifest themselves in text lines as instances of the <codeph class="+ topic/ph pr-d/codeph ">TextLineMirrorRegion</codeph> |
| class. Depending on bidirectional processing and line breaking, one or more mirror regions can be produced.</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.events.xml#EventDispatcher" class="- topic/link "><linktext class="- topic/linktext ">flash.events.EventDispatcher</linktext></link><link href="flash.text.engine.xml#TextLineMirrorRegion" class="- topic/link "><linktext class="- topic/linktext ">TextLineMirrorRegion</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ContentElement:groupElement:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">groupElement</apiName><shortdesc class="- topic/shortdesc "> |
| The GroupElement object that contains this element, or |
| null if it is not in a group.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:GroupElement</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The GroupElement object that contains this element, or |
| <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if it is not in a group. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#GroupElement" class="- topic/link "><linktext class="- topic/linktext ">GroupElement</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ContentElement:rawText:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">rawText</apiName><shortdesc class="- topic/shortdesc "> |
| A copy of the text in the element, including any U+FDEF characters.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| A copy of the text in the element, including any U+FDEF characters. The Unicode character, U+FDEF, marks the location of |
| a graphic element in the String. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ContentElement:textBlockBeginIndex:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textBlockBeginIndex</apiName><shortdesc class="- topic/shortdesc "> |
| The index in the text block of the first character of this element.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The index in the text block of the first character of this element. |
| This value is not cached; it is calculated whenever this method is called. |
| |
| <p class="- topic/p ">The default value is -1.</p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:ContentElement:textBlock:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textBlock</apiName><shortdesc class="- topic/shortdesc "> |
| The TextBlock to which this element belongs.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextBlock</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextBlock to which this element belongs. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ContentElement:textRotation:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textRotation</apiName><shortdesc class="- topic/shortdesc "> |
| The rotation to apply to the element as a unit.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value that is not a member of TextRotation. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to <codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the operation would result in nested rotations within a GroupElement. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The rotation to apply to the element as a unit. Use <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph> |
| constants for this property. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph>.</p> |
| |
| <p class="- topic/p ">The final rotation of any glyph is the sum of <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.textRotation</codeph>, <codeph class="+ topic/ph pr-d/codeph ">ContentElement.textRotation</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation</codeph>.</p> |
| |
| <p class="- topic/p "><codeph class="+ topic/ph pr-d/codeph ">ContentElement.textRotation</codeph> is used to create a short run of text whose |
| rotation differs from the containing line. TCY runs in Japanese text are an example. TCY stands for Tate-Chu-Yoko |
| and refers to a little horizontal run of text (usually a number) in some vertical Japanese text. |
| To create a Paragraph of vertical Japanese text containing a TCY run, do the following:</p> |
| <ol class="- topic/ol "><li class="- topic/li ">Set <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation=TextRotation.ROTATE_90</codeph></li><li class="- topic/li ">Set <codeph class="+ topic/ph pr-d/codeph ">TextBlock.content</codeph> 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.</li><li class="- topic/li ">Set the <codeph class="+ topic/ph pr-d/codeph ">textRotation</codeph> property of the TCY TextElement to <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_270</codeph>. |
| 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.</li></ol> |
| |
| <p class="- topic/p ">Rotated content elements cannot be nested. In any hierarchy of content elements, no matter how complex, |
| only one content element can have its <codeph class="+ topic/ph pr-d/codeph ">textRotation</codeph> property set. The following methods and property setters throw an |
| argument error if nested rotations are detected:</p> |
| <ol class="- topic/ol "><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">ContentElement.textRotation</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">GroupElement.setElements</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">GroupElement.replaceElements</codeph></li></ol> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph></entry><entry class="- topic/entry ">Element is not rotated.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_90</codeph></entry><entry class="- topic/entry ">Element is rotated 90 degrees clockwise.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_180</codeph></entry><entry class="- topic/entry ">Element is rotated 180 degrees.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_270</codeph></entry><entry class="- topic/entry ">Element is rotated 270 degrees clockwise.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph></entry><entry class="- topic/entry ">Not supported.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextRotation" class="- topic/link "><linktext class="- topic/linktext ">TextRotation</linktext></link><link href="flash.text.engine.xml#ElementFormat/textRotation" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.textRotation</linktext></link><link href="flash.text.engine.xml#TextBlock/lineRotation" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.lineRotation</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:ContentElement:text:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">text</apiName><shortdesc class="- topic/shortdesc "> |
| A copy of the text in the element, not including any U+FDEF characters, which represent graphic elements in the String.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| A copy of the text in the element, not including any U+FDEF characters, which represent graphic elements in the String. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextElement/text" class="- topic/link "><linktext class="- topic/linktext ">TextElement.text</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextBlock" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextBlock</apiName><shortdesc class="- topic/shortdesc "> |
| The TextBlock class is a factory for the creation of TextLine objects, which you can |
| render by placing them on the display list.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextBlock class is a factory for the creation of TextLine objects, which you can |
| render by placing them on the display list. |
| |
| <p class="- topic/p ">The TextBlock class is intended to contain a single paragraph because the Unicode |
| bidirectional and line-break algorithms operate on one paragraph at a time. For applications |
| that compose multiple paragraphs of text, use a markup language, or text analysis to |
| divide the text into paragraphs and create one TextBlock per paragraph.</p> |
| |
| <p class="- topic/p ">The TextBlock object stores its content in the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property, which is an |
| instance of the ContentElement class. Because you can't create an instance of the ContentElement |
| class, set <codeph class="+ topic/ph pr-d/codeph ">content</codeph> to an instance of one of its subclasses: TextElement, |
| GraphicElement, or GroupElement. Use TextElement for purely text content, GraphicElement for |
| an image or graphic content, and GroupElement for content that contains a combination of TextElement, |
| GraphicElement, and other GroupElement objects. See the ContentElement class and |
| its subclasses for details on managing formatted runs of text, embedded sub-runs, and graphic elements.</p> |
| |
| <p class="- topic/p ">After you create the TextBlock instance and set the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property, call the |
| <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph> method to create lines of text, which are instances of the <codeph class="+ topic/ph pr-d/codeph ">TextLine</codeph> class. </p> |
| |
| </apiDesc><example conref="examples\TextBlockExample.as" class="- topic/example "> This example displays three TextBlock paragraphs of Japanese and English |
| text. The Japanese text is converted to Strings from Unicode character codes. |
| When you click on the button, the example rotates the text from horizontal to |
| vertical or from veritcal to horizontal. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| package { |
| import fl.controls.Button; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.TextRotation; |
| import flash.text.engine.TextBaseline; |
| import flash.text.engine.LineJustification; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.EastAsianJustifier; |
| import flash.display.Loader; |
| import flash.display.Sprite; |
| import flash.display.Stage; |
| import flash.events.MouseEvent; |
| import flash.system.Capabilities; |
| |
| public class TextBlockExample extends Sprite { |
| |
| var vertical:Boolean; |
| var container:Sprite; |
| var textBlocks:Vector.<TextBlock>; |
| var loader:Loader = new Loader(); |
| var directionButton:Button = new Button(); |
| |
| public function TextBlockExample():void { |
| addChild(directionButton); |
| directionButton.width = 30; |
| directionButton.move(50, 350); |
| directionButton.addEventListener(MouseEvent.CLICK, clickHandler); |
| createContent(); |
| createLines(); |
| } |
| |
| private function createEmptyBlock():TextBlock { |
| |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.baselineZero = TextBaseline.IDEOGRAPHIC_CENTER; |
| textBlock.textJustifier = new EastAsianJustifier("ja", LineJustification.ALL_BUT_LAST); |
| textBlock.lineRotation = vertical? TextRotation.ROTATE_90: TextRotation.ROTATE_0; |
| return textBlock; |
| } |
| |
| private function paragraph1(format:ElementFormat):TextBlock { |
| |
| var textBlock:TextBlock = createEmptyBlock(); |
| textBlock.content = new TextElement( |
| String.fromCharCode( |
| 0x5185, 0x95A3, 0x5E9C, 0x304C, 0x300C, 0x653F, 0x5E9C, 0x30A4, |
| 0x30F3, 0x30BF, 0x30FC, 0x30CD, 0x30C3, 0x30C8, 0x30C6, 0x30EC, |
| 0x30D3, 0x300D, 0x306E, 0x52D5, 0x753B, 0x914D, 0x4FE1, 0x5411, |
| 0x3051, 0x306B, 0x30A2, 0x30C9, 0x30D3, 0x30B7, 0x30B9, 0x30C6, |
| 0x30E0, 0x30BA, 0x793E, 0x306E |
| ) + |
| "FMS 2" + |
| String.fromCharCode(0x3092, 0x63A1, 0x7528, 0x3059, 0x308B, 0x3068, |
| 0x767a, 0x8868, 0x3057, 0x307e, 0x3057, 0x305F, 0x3002), format); |
| return textBlock; |
| } |
| |
| private function paragraph2(format:ElementFormat):TextBlock { |
| |
| var textBlock:TextBlock = createEmptyBlock(); |
| textBlock.content = new TextElement( |
| String.fromCharCode( |
| 0x30AF, 0x30ED, 0x30B9, 0x30D7, 0x30E9, 0x30C3, 0x30C8, 0x30D5, |
| 0x30A9, 0x30FC, 0x30E0, 0x4E0A, 0x3067, 0x518D, 0x751F, 0x53EF, |
| 0x80FD, 0x306A |
| ) + |
| "Flash Video" + |
| String.fromCharCode( |
| 0x3092, 0x914D, 0x4FE1, 0x3001, 0x653F, 0x5E9C, 0x6700, 0x65B0, |
| 0x60C5, 0x5831, 0x3092, 0x3088, 0x308A, 0x591A, 0x304F, 0x306E, |
| 0x56FD, 0x6C11, 0x306B, 0x9AD8, 0x54C1, 0x8CEA, 0x306A, 0x753B, |
| 0x50CF, 0x3067, 0x7C21, 0x5358, 0x304B, 0x3064, 0x30EA, 0x30A2, |
| 0x30EB, 0x30BF, 0x30A4, 0x30E0, 0x306B, 0x63D0, 0x4F9B, 0x3059, |
| 0x308B, 0x3053, 0x3068, 0x304C, 0x53EF, 0x80FD, 0x306B, 0x306A, |
| 0x308A, 0x307e, 0x3057, 0x305F, 0x3002), format); |
| return textBlock; |
| } |
| |
| private function paragraph3(format:ElementFormat):TextBlock { |
| |
| var textBlock:TextBlock = createEmptyBlock(); |
| textBlock.content = new TextElement( |
| String.fromCharCode(0x3010) + |
| "2007" + |
| String.fromCharCode(0x5E74) + "2" + String.fromCharCode(0x6708) + |
| "21" + |
| String.fromCharCode(0x65E5, 0x3011), |
| format); |
| return textBlock; |
| } |
| |
| private function createContent():void { |
| |
| var font:FontDescription = new FontDescription(); |
| if (Capabilities.os.search("Mac OS") > -1) |
| font.fontName = String.fromCharCode(0x5C0F, 0x585A, 0x660E, 0x671D) + " Pro R"; // "Kozuka Mincho Pro R" koFont.fontName = "Adobe " + String.fromCharCode(0xBA85, 0xC870) + " Std M"; // "Adobe Myungjo Std M" |
| else |
| font.fontName = "Kozuka Mincho Pro R"; |
| var format:ElementFormat = new ElementFormat(); |
| format.fontDescription = font; |
| format.fontSize = 12; |
| format.locale = "ja"; |
| format.color = 0x000000; |
| if (!vertical) |
| format.textRotation = TextRotation.ROTATE_0; |
| textBlocks = new Vector.<TextBlock>(); |
| textBlocks.push( |
| paragraph1(format), |
| paragraph2(format), |
| paragraph3(format)//, |
| ); |
| } |
| |
| private function createLines():void { |
| |
| if (container != null) { |
| removeChild(container); |
| } |
| container = new Sprite(); |
| container.y = 45; |
| container.x = 40; |
| addChild(container); |
| var linePosition:Number = vertical? this.stage.stageWidth - 120: 12; |
| |
| for (var i:uint = 0; i < textBlocks.length; i++) { |
| var textBlock:TextBlock = textBlocks[i]; |
| var previousLine:TextLine = null; |
| |
| while (true) { |
| var textLine:TextLine = textBlock.createTextLine( |
| previousLine, |
| 300); |
| if (textLine == null) |
| break; |
| if (vertical) |
| { |
| textLine.x = linePosition; |
| linePosition -= 24; |
| directionButton.label = " -- "; |
| } |
| else |
| { |
| textLine.y = linePosition+50; |
| linePosition += 24; |
| directionButton.label = " | "; |
| } |
| container.addChild(textLine); |
| previousLine = textLine; |
| } |
| if (vertical) |
| linePosition -= 16; |
| else |
| linePosition += 16; |
| } |
| } |
| |
| private function clickHandler(event:MouseEvent):void { |
| |
| vertical = !vertical; |
| createContent(); |
| createLines(); |
| } |
| } |
| } |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement" class="- topic/link "><linktext class="- topic/linktext ">ContentElement</linktext></link><link href="flash.text.engine.xml#GraphicElement" class="- topic/link "><linktext class="- topic/linktext ">GraphicElement</linktext></link><link href="flash.text.engine.xml#GroupElement" class="- topic/link "><linktext class="- topic/linktext ">GroupElement</linktext></link><link href="flash.text.engine.xml#TextBaseline" class="- topic/link "><linktext class="- topic/linktext ">TextBaseline</linktext></link><link href="flash.text.engine.xml#TextElement" class="- topic/link "><linktext class="- topic/linktext ">TextElement</linktext></link><link href="flash.text.engine.xml#TextJustifier" class="- topic/link "><linktext class="- topic/linktext ">TextJustifier</linktext></link><link href="flash.text.engine.xml#TextLine" class="- topic/link "><linktext class="- topic/linktext ">TextLine</linktext></link><link href="flash.text.engine.xml#TextRotation" class="- topic/link "><linktext class="- topic/linktext ">TextRotation</linktext></link><link href="flash.text.engine.xml#TabStop" class="- topic/link "><linktext class="- topic/linktext ">TabStop</linktext></link></related-links><apiConstructor id="flash.text.engine:TextBlock:TextBlock" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">TextBlock</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a TextBlock object |
| |
| </shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">content</codeph> specified is not a known subclass of <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">content</codeph> specified is already a member of a group. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">lineRotation</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">baselineZero</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">bidiLevel</codeph> specified is less than 0. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">tabStops</codeph> specified contain <codeph class="+ topic/ph pr-d/codeph ">null</codeph> elements. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">tabStops</codeph> specified are not sorted by increasing position. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">baselineFontSize</codeph> specified is less than 0. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">content</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ContentElement</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The contents of the text block. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">tabStops</apiItemName><apiType value="Vector$flash.text.engine:TabStop" name="type" class="- topic/state reference/state apiRef/apiType "/><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The tab stops for the text in the text block. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">textJustifier</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextJustifier</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The TextJustifier object to use during line creation for this block. |
| If no justifier is provided, a default justifier is constructed based on an English locale. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">lineRotation</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rotation applied to the text lines generated from the text block as units. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">baselineZero</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">roman</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies which baseline is at y=0 for all lines in the block. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">bidiLevel</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The default bidirectional embedding level of the text in the text block. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">applyNonLinearFontScaling</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">true</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies that you want to enhance screen appearance at the expense of WYSIWYG print fidelity. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">baselineFontDescription</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:FontDescription</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies a font description from which to derive line baselines for all lines in the block. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">baselineFontSize</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">12.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the size to use with the baselineFontDescription. |
| This parameter is ignored if <codeph class="+ topic/ph pr-d/codeph ">baselineFontDescription</codeph> is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a TextBlock object |
| |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/applyNonLinearFontScaling" class="- topic/link "><linktext class="- topic/linktext ">applyNonLinearFontScaling</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineFontDescription" class="- topic/link "><linktext class="- topic/linktext ">baselineFontDescription</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineFontSize" class="- topic/link "><linktext class="- topic/linktext ">baselineFontSize</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">baselineZero</linktext></link><link href="flash.text.engine.xml#TextBlock/bidiLevel" class="- topic/link "><linktext class="- topic/linktext ">bidiLevel</linktext></link><link href="flash.text.engine.xml#TextBlock/lineRotation" class="- topic/link "><linktext class="- topic/linktext ">lineRotation</linktext></link><link href="flash.text.engine.xml#TextBlock/tabStops" class="- topic/link "><linktext class="- topic/linktext ">tabStops</linktext></link><link href="flash.text.engine.xml#TextJustifier" class="- topic/link "><linktext class="- topic/linktext ">TextJustifier</linktext></link></related-links></apiConstructor><apiOperation id="flash.text.engine:TextBlock:createTextLine" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">createTextLine</apiName><shortdesc class="- topic/shortdesc "> |
| Instructs the text block to create a line of text from its content, beginning at the point |
| specified by the previousLine parameter and breaking at the point specified by the |
| width parameter.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the TextLine specified by <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> is not valid. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the TextLine specified by <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> is owned by a different TextBlock. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">width</codeph> is less than zero, unless <codeph class="+ topic/ph pr-d/codeph ">fitSomething</codeph> is true. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">width</codeph> is greater than <codeph class="+ topic/ph pr-d/codeph ">TextLine.MAX_LINE_WIDTH</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If one or more elements in the content of the text block has a <codeph class="+ topic/ph pr-d/codeph ">null ElementFormat</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A text line, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if the text block is empty or the width specified is less than the width of the next element. |
| To distinguish between these cases, check the <codeph class="+ topic/ph pr-d/codeph ">textLineCreationResult</codeph> property of the text block. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">previousLine</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the previously broken line after which breaking is to commence. Can be <codeph class="+ topic/ph pr-d/codeph ">null</codeph> |
| when breaking the first line. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">width</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">1000000</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the desired width of the line in pixels. The actual width may be less. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">lineOffset</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">An optional parameter which specifies the difference in pixels between the origin of the line and the origin of the tab stops. |
| This can be used when lines are not aligned, but it is desirable for their tabs to be so. |
| The default value for this parameter is <codeph class="+ topic/ph pr-d/codeph ">0.0</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fitSomething</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">false</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">An optional parameter which instructs Flash Player to fit at least one character into the text line, no matter what |
| width has been specified (even if width is zero or negative, which would otherwise result in an exception being thrown). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Instructs the text block to create a line of text from its content, beginning at the point |
| specified by the <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> parameter and breaking at the point specified by the |
| <codeph class="+ topic/ph pr-d/codeph ">width</codeph> parameter. The text line is a TextLine object, which you can add |
| to the display list. |
| |
| <p class="- topic/p ">Breaking lines over a range of a text block that has already been broken can change the validity |
| of lines in and beyond the area where breaking takes place. The status of lines can change from VALID to INVALID or |
| POSSIBLY_INVALID. If a newly broken line aligns perfectly with a previously broken line which has a status |
| of POSSIBLY_INVALID, that previously broken line and all following POSSIBLY_INVALID lines change back |
| to a status of VALID. The validity of lines that have been set to values that are not members of |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity</codeph> do not change to VALID, but could change to INVALID. |
| Check the <codeph class="+ topic/ph pr-d/codeph ">firstInvalidLine</codeph> property after any change to the text block |
| to see where to begin or continue rebreaking text lines.</p> |
| |
| <p class="- topic/p ">You can create artificial word breaks by including the Unicode Zero Width Space (ZWSP) character in the text. |
| This can be useful for languages such as Thai, which require a dictionary for correct line breaking. |
| The Flash runtime does not include such a dictionary.</p> |
| |
| <p class="- topic/p ">In order to reduce memory overhead, when all the desired lines have been created, unless it is expected that the |
| lines will need to be repeatedly rebroken due to, for example, the resizing of the container, the user should call |
| the <codeph class="+ topic/ph pr-d/codeph ">releaseLineCreationData()</codeph> method allowing the text block to dispose of the temporary data associated with line breaking.</p> |
| |
| </apiDesc><example conref="examples\TextBlock_createTextLineExample.as" class="- topic/example "> This example calls the <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph> method to create |
| lines of text in a text block. It accomplishes this by performing the following tasks: |
| <ul class="- topic/ul "><li class="- topic/li ">Creating a TextElement from a String and giving it a font size of 20</li><li class="- topic/li ">Creating a TextBlock and assigning the TextElement to it</li><li class="- topic/li ">Calling <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph> to create lines 300 pixels wide from the text block</li><li class="- topic/li ">Placing each line on Stage (<codeph class="+ topic/ph pr-d/codeph ">addChild()</codeph>) and setting its position (<codeph class="+ topic/ph pr-d/codeph ">x</codeph> and <codeph class="+ topic/ph pr-d/codeph ">y</codeph>)</li></ul> |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.FontDescription; |
| |
| public class TextBlock_createTextLineExample extends Sprite { |
| |
| public function TextBlock_createTextLineExample():void { |
| |
| var str:String = "I am a TextElement, created from a String and assigned " + |
| "to the content property of a TextBlock. The createTextLine() method " + |
| "then created these lines, 300 pixels wide, for display." ; |
| |
| var fontDescription:FontDescription = new FontDescription("Arial"); |
| var format:ElementFormat = new ElementFormat(fontDescription); |
| format.fontSize = 16; |
| var textElement:TextElement = new TextElement(str, format); |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = textElement; |
| createLines(textBlock); |
| } |
| |
| private function createLines(textBlock:TextBlock):void |
| { |
| var lineWidth:Number = 300; |
| var xPos:Number = 15.0; |
| var yPos:Number = 20.0; |
| |
| var textLine:TextLine = textBlock.createTextLine (null, lineWidth); |
| while (textLine) |
| { |
| textLine.x = xPos; |
| textLine.y = yPos; |
| yPos += textLine.height + 2; |
| addChild (textLine); |
| textLine = textBlock.createTextLine (textLine, lineWidth); |
| } |
| } |
| } |
| } |
| </codeblock></example></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine" class="- topic/link "><linktext class="- topic/linktext ">TextLine</linktext></link><link href="flash.text.engine.xml#TextLine/validity" class="- topic/link "><linktext class="- topic/linktext ">TextLine.validity</linktext></link><link href="flash.text.engine.xml#TextLineValidity" class="- topic/link "><linktext class="- topic/linktext ">TextLineValidity</linktext></link><link href="flash.text.engine.xml#TextBlock/releaseLineCreationData()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.releaseLineCreationData()</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextBlock:dump" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">dump</apiName><shortdesc class="- topic/shortdesc "> |
| Dumps the underlying contents of the TextBlock as an XML string.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Dumps the underlying contents of the TextBlock as an XML string. |
| This can be useful in automated testing, and includes text, formatting, and layout information. |
| |
| <p class="- topic/p ">The following describes the output:</p> |
| |
| <pre xml:space="preserve" class="- topic/pre "> |
| >block< |
| [0-N LINE] |
| >/block< |
| </pre> |
| |
| <p class="- topic/p ">For a description of the output for each line, see the TextLine.dump() method.</p> |
| |
| <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> The content and format of the output may change in the future. Adobe does not guarantee backward compatibility |
| of this method.</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine/dump()" class="- topic/link "><linktext class="- topic/linktext ">TextLine.dump()</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextBlock:findNextAtomBoundary" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">findNextAtomBoundary</apiName><shortdesc class="- topic/shortdesc "> |
| Finds the index of the next atom boundary from the specified character index, not including the character at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">index</codeph> specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The TextLine to which the indexed character belongs is not valid. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the next atom boundary from the specified character index. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">afterCharIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the index of the character from which to search for the next atom boundary. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Finds the index of the next atom boundary from the specified character index, not including the character at the specified index. |
| The characters between atom boundaries combine to form one atom in a <codeph class="+ topic/ph pr-d/codeph ">TextLine</codeph>, such as an 'e' and a combining acute accent. |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine/atomCount" class="- topic/link "><linktext class="- topic/linktext ">TextLine.atomCount</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextBlock:findNextWordBoundary" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">findNextWordBoundary</apiName><shortdesc class="- topic/shortdesc "> |
| Finds the index of the next word boundary from the specified character index, not including the character at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">index</codeph> specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The TextLine to which the indexed character belongs is not valid. |
| |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the next word boundary from the specified character index. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">afterCharIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the index of the character from which to search for the next word boundary. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Finds the index of the next word boundary from the specified character index, not including the character at the specified index. |
| Word boundaries are determined based on the Unicode properties of the characters. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextBlock:findPreviousAtomBoundary" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">findPreviousAtomBoundary</apiName><shortdesc class="- topic/shortdesc "> |
| Finds the index of the previous atom boundary to the specified character index, not including the character at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">index</codeph> specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The TextLine to which the indexed character belongs is not valid. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the previous atom boundary to the specified character index. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">beforeCharIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the index of the character from which to search for the previous atom boundary. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Finds the index of the previous atom boundary to the specified character index, not including the character at the specified index. |
| The characters between atom boundaries combine to form one atom in a <codeph class="+ topic/ph pr-d/codeph ">TextLine</codeph>, such as an 'e' and a combining acute accent. |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine/atomCount" class="- topic/link "><linktext class="- topic/linktext ">TextLine.atomCount</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextBlock:findPreviousWordBoundary" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">findPreviousWordBoundary</apiName><shortdesc class="- topic/shortdesc "> |
| Finds the index of the previous word boundary to the specified character index, not including the character at the specified index.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">index</codeph> specified is out of range. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The TextLine to which the indexed character belongs is not valid. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The index of the previous word boundary to the specified character index. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">beforeCharIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the index of the character from which to search for the previous word boundary. |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Finds the index of the previous word boundary to the specified character index, not including the character at the specified index. |
| Word boundaries are determined based on the Unicode properties of the characters. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextBlock:getTextLineAtCharIndex" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getTextLineAtCharIndex</apiName><shortdesc class="- topic/shortdesc "> |
| Returns the TextLine containing the character specified by the charIndex parameter.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The character index specified is out of range. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">RangeError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">RangeError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The TextLine containing the character at <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph>. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">charIndex</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">int</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The zero-based index value of the character (for example, the first character is 0, |
| the second character is 1, and so on). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Returns the TextLine containing the character specified by the <codeph class="+ topic/ph pr-d/codeph ">charIndex</codeph> parameter. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.text.engine:TextBlock:recreateTextLine" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">recreateTextLine</apiName><shortdesc class="- topic/shortdesc "> |
| Instructs the text block to re-use an existing text line to create a line of text from its content, beginning at the point |
| specified by the previousLine parameter and breaking at the point specified by the |
| width parameter.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">textLine</codeph> is null. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the TextLine specified by <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> is not valid. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the TextLine specified by <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> is owned by a different TextBlock. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the TextLine specified by <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> is also specified by <codeph class="+ topic/ph pr-d/codeph ">textLine</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">width</codeph> is less than zero, unless <codeph class="+ topic/ph pr-d/codeph ">fitSomething</codeph> is true. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If <codeph class="+ topic/ph pr-d/codeph ">width</codeph> is greater than <codeph class="+ topic/ph pr-d/codeph ">TextLine.MAX_LINE_WIDTH</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If one or more elements in the content of the text block has a <codeph class="+ topic/ph pr-d/codeph ">null ElementFormat</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A text line, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if the text block is empty or the width specified is less than the width of the next element. |
| To distinguish between these cases, check the <codeph class="+ topic/ph pr-d/codeph ">textLineCreationResult</codeph> property of the text block. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">textLine</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies a previously created TextLine to be re-used. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">previousLine</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the previously broken line after which breaking is to commence. Can be <codeph class="+ topic/ph pr-d/codeph ">null</codeph> |
| when breaking the first line. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">width</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">1000000</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the desired width of the line in pixels. The actual width may be less. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">lineOffset</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">0.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">An optional parameter which specifies the difference in pixels between the origin of the line and the origin of the tab stops. |
| This can be used when lines are not aligned, but it is desirable for their tabs to be so. |
| The default value for this parameter is <codeph class="+ topic/ph pr-d/codeph ">0.0</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">fitSomething</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">false</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">An optional parameter which instructs Flash Player to fit at least one character into the text line, no matter what |
| width has been specified (even if width is zero or negative, which would otherwise result in an exception being thrown). |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Instructs the text block to re-use an existing text line to create a line of text from its content, beginning at the point |
| specified by the <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> parameter and breaking at the point specified by the |
| <codeph class="+ topic/ph pr-d/codeph ">width</codeph> parameter. The text line is a TextLine object, which you can add |
| to the display list. By re-using an existing text line, performance is enhanced due to reduced object creation. |
| |
| <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">textLine</codeph> being recreated is released from whatever text block it is in, if any. |
| In addition, all properties, including inherited properties from <codeph class="+ topic/ph pr-d/codeph ">DisplayObjectContainer</codeph>, |
| <codeph class="+ topic/ph pr-d/codeph ">InteractiveObject</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">DisplayObject</codeph> are reset to their default values. |
| Finally, all children of the line are removed including graphic elements and other decorations, and all event |
| listeners on the line are removed. To improve performance, the only exception to this complete reset is that |
| the line itself is not removed from its parent.</p> |
| |
| <p class="- topic/p ">Breaking lines over a range of a text block that has already been broken can change the validity |
| of lines in and beyond the area where breaking takes place. The status of lines can change from VALID to INVALID or |
| POSSIBLY_INVALID. If a newly broken line aligns perfectly with a previously broken line which has a status |
| of POSSIBLY_INVALID, that previously broken line and all following POSSIBLY_INVALID lines change back |
| to a status of VALID. The validity of lines that have been set to values that are not members of |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity</codeph> do not change to VALID, but could change to INVALID. |
| Check the <codeph class="+ topic/ph pr-d/codeph ">firstInvalidLine</codeph> property after any change to the text block |
| to see where to begin or continue rebreaking text lines.</p> |
| |
| <p class="- topic/p ">You can create artificial word breaks by including the Unicode Zero Width Space (ZWSP) character in the text. |
| This can be useful for languages such as Thai, which require a dictionary for correct line breaking. |
| The Flash runtime does not include such a dictionary.</p> |
| |
| <p class="- topic/p ">In order to reduce memory overhead, when all the desired lines have been created, unless it is expected that the |
| lines will need to be repeatedly rebroken due to, for example, the resizing of the container, the user should call |
| the <codeph class="+ topic/ph pr-d/codeph ">releaseLineCreationData()</codeph> method allowing the text block to dispose of the temporary data associated with line breaking.</p> |
| |
| </apiDesc><example conref="examples\TextBlock_recreateTextLineExample.as" class="- topic/example "> This example re-uses the TextLine object <codeph class="+ topic/ph pr-d/codeph ">textLine</codeph>: |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| var elementFormat:ElementFormat = new ElementFormat(); |
| elementFormat.fontDescription = new FontDescription("Arial"); |
| elementFormat.fontSize = 48; |
| |
| var textElement:TextElement = new TextElement("Text you'll never see", elementFormat) |
| var textBlock:TextBlock = new TextBlock(textElement); |
| var textLine:TextLine = textBlock.createTextLine(); |
| textLine.x = 50; |
| textLine.y = 50; |
| addChild(textLine); |
| |
| // Reuse the element format to preserve the text formatting |
| var elementTwo:TextElement = new TextElement("Text you see", elementFormat); |
| textBlock.content = elementTwo; |
| textBlock.recreateTextLine(textLine); |
| |
| // Set the position (and any other display object properties like alpha, children, etc.) |
| // otherwise, they're all set to default properties. |
| textLine.x = 50; |
| textLine.y = 50; |
| </codeblock></example></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBaseline" class="- topic/link "><linktext class="- topic/linktext ">TextBaseline</linktext></link><link href="flash.text.engine.xml#TextLine" class="- topic/link "><linktext class="- topic/linktext ">TextLine</linktext></link><link href="flash.text.engine.xml#TextLine/validity" class="- topic/link "><linktext class="- topic/linktext ">TextLine.validity</linktext></link><link href="flash.text.engine.xml#TextLineValidity" class="- topic/link "><linktext class="- topic/linktext ">TextLineValidity</linktext></link><link href="flash.text.engine.xml#TextBlock/releaseLineCreationData()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.releaseLineCreationData()</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextBlock:releaseLineCreationData" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">releaseLineCreationData</apiName><shortdesc class="- topic/shortdesc "> |
| Instructs the text block to release all the temporary data associated with the creation of text lines.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Instructs the text block to release all the temporary data associated with the creation of text lines. |
| To minimize an application's memory foot print, you should call the <codeph class="+ topic/ph pr-d/codeph ">releaseLineCreationData()</codeph> method when you are |
| done creating text lines from a text block. However, to maximize performance for rebreaking the lines |
| (for example when the container is resized) the <codeph class="+ topic/ph pr-d/codeph ">releaseLineCreationData()</codeph> method should not be called. |
| It is up to the application to balance memory vs. performance. |
| |
| <p class="- topic/p ">The recommended process for text that is not expected to change is: initialize a text block, |
| call the <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph> method as often as necessary to create the desired output, and then call |
| the <codeph class="+ topic/ph pr-d/codeph ">releaseLineCreationData()</codeph> method.</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link></related-links></apiOperation><apiOperation id="flash.text.engine:TextBlock:releaseLines" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">releaseLines</apiName><shortdesc class="- topic/shortdesc "> |
| Removes a range of text lines from the list of lines maintained by the TextBlock.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the TextLine specified by <codeph class="+ topic/ph pr-d/codeph ">firstLine</codeph> or <codeph class="+ topic/ph pr-d/codeph ">lastLine</codeph> is not |
| in the list of text lines maintained by the text block. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">firstLine</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the first line to release. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">lastLine</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextLine</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies the last line to release. |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Removes a range of text lines from the list of lines maintained by the TextBlock. |
| This allows the lines to be garbage-collected if no other references exist. |
| |
| <p class="- topic/p ">Sets the <codeph class="+ topic/ph pr-d/codeph ">textBlock</codeph>, <codeph class="+ topic/ph pr-d/codeph ">nextLine</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">previousLine</codeph> |
| members of the removed lines to <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| Sets the <codeph class="+ topic/ph pr-d/codeph ">validity</codeph> of the removed lines and of all lines which follow |
| the removed lines in the TextBlock to <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.INVALID</codeph>.</p> |
| |
| </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine" class="- topic/link "><linktext class="- topic/linktext ">TextLine</linktext></link></related-links></apiOperation><apiValue id="flash.text.engine:TextBlock:userData" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">userData</apiName><shortdesc class="- topic/shortdesc "> |
| Provides a way for the application to associate arbitrary data with the text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiType value="" name="type" class="- topic/state reference/state apiRef/apiType "/></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Provides a way for the application to associate arbitrary data with the text block. The data could be information that refers to the content, |
| such as a revision date or the name of the author, or it could be cached data that you use during processing. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextBlock:applyNonLinearFontScaling:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">applyNonLinearFontScaling</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that you want to enhance screen appearance at the expense of what-you-see-is-what-you-get (WYSIWYG) print fidelity.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that you want to enhance screen appearance at the expense of what-you-see-is-what-you-get (WYSIWYG) print fidelity. |
| For platforms and fonts that do not support sub pixel glyph positioning during device font rendering, but |
| do support non-linear scaling, setting this property to <codeph class="+ topic/ph pr-d/codeph ">true</codeph> enables the use of those metrics at some cost to |
| WYSIWYG print fidelity, particularly for small point sizes. Non linear font scaling works by selectivly scaling the width |
| of individual glyphs to conceal unsightly gaps caused by pixel snapping. |
| |
| <p class="- topic/p ">On platforms which do support sub-pixel glyph positioning, this flag is ignored.</p> |
| |
| <p class="- topic/p ">This flag has no effect on embedded font rendering</p> |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.</p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextBlock:baselineFontDescription:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">baselineFontDescription</apiName><shortdesc class="- topic/shortdesc "> |
| The font used to determine the baselines for all the lines created from the block, independent of their content.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:FontDescription</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The font used to determine the baselines for all the lines created from the block, independent of their content. Baselines depend on font and font size. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. When the baseline font is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>, the baseline font size is ignored and |
| the baseline for any given line is based on the font and size of the largest text in the line. When you specify both |
| <codeph class="+ topic/ph pr-d/codeph ">baselineFontDescription</codeph> and <codeph class="+ topic/ph pr-d/codeph ">baselineFontSize</codeph>, they determine the baselines for all the lines |
| in the text block, independent of their content. This combination is most often useful in Asian typography.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/baselineFontSize" class="- topic/link "><linktext class="- topic/linktext ">baselineFontSize</linktext></link><link href="flash.text.engine.xml#FontDescription" class="- topic/link "><linktext class="- topic/linktext ">FontDescription</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:baselineFontSize:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">baselineFontSize</apiName><shortdesc class="- topic/shortdesc "> |
| The font size used to calculate the baselines for the lines created from the block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">baselineFontSize</codeph> specified is less than 0. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The font size used to calculate the baselines for the lines created from the block. Baselines depend on font and font size. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">12</codeph>. When the baseline font is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>, the baseline font size is ignored and |
| the baseline for any given line is based on the font and size of the largest text in the line.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/baselineFontDescription" class="- topic/link "><linktext class="- topic/linktext ">baselineFontDescription</linktext></link><link href="flash.text.engine.xml#FontDescription" class="- topic/link "><linktext class="- topic/linktext ">FontDescription</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:baselineZero:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">baselineZero</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies which baseline is at y=0 for lines created from this block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies which baseline is at y=0 for lines created from this block. |
| Valid values for this property are found in the members of the |
| <codeph class="+ topic/ph pr-d/codeph ">TextBaseline</codeph> class. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ROMAN</codeph>.</p> |
| |
| <p class="- topic/p ">To set values for this property, use the following string values:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ROMAN</codeph></entry><entry class="- topic/entry ">The roman baseline of the lines is at y=0.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.ASCENT</codeph></entry><entry class="- topic/entry ">The ascent baseline of the lines is at y=0.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.DESCENT</codeph></entry><entry class="- topic/entry ">The descent baseline of the lines is at y=0.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_TOP</codeph></entry><entry class="- topic/entry ">The ideographic top baseline of the lines is at y=0.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_CENTER</codeph></entry><entry class="- topic/entry ">The ideographic center baseline of the lines is at y=0.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextBaseline.IDEOGRAPHIC_BOTTOM</codeph></entry><entry class="- topic/entry ">The ideographic bottom baseline of the lines is at y=0.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBaseline" class="- topic/link "><linktext class="- topic/linktext ">TextBaseline</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:bidiLevel:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">bidiLevel</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the default bidirectional embedding level of the text in the text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to a value which is less than 0. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the default bidirectional embedding level of the text in the text block. |
| An even value means left-to-right and an odd value means right-to-left. You can increment <codeph class="+ topic/ph pr-d/codeph ">bidiLevel</codeph> to |
| indicate the number of levels by which particular text is embedded with respect to left-to-right |
| and right-to-left. |
| |
| <p class="- topic/p ">The default value is 0.</p> |
| |
| <p class="- topic/p ">Modifying <codeph class="+ topic/ph pr-d/codeph ">bidiLevel</codeph> changes the validity of all previously broken lines to TextLineValidity.INVALID. After |
| changing <codeph class="+ topic/ph pr-d/codeph ">bidiLevel</codeph>, the <codeph class="+ topic/ph pr-d/codeph ">firstInvalidLine</codeph> property equals the <codeph class="+ topic/ph pr-d/codeph ">firstLine</codeph> property, and you must |
| rebreak all the lines in the TextBlock.</p> |
| |
| </apiDesc><example conref="examples\TextBlock_bidiLevelExample.as" class="- topic/example "> This example shows the same text string (logical order: a, b, c, alef, bet, gimel) |
| rendered first with <codeph class="+ topic/ph pr-d/codeph ">bidiLevel</codeph> even and second with <codeph class="+ topic/ph pr-d/codeph ">bidiLevel</codeph> odd. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.FontDescription; |
| |
| public class TextBlock_bidiLevelExample extends Sprite { |
| |
| public function TextBlock_bidiLevelExample():void { |
| var fontSize:Number = 36; |
| |
| var format:ElementFormat = new ElementFormat(); |
| format.fontDescription = new FontDescription("Adobe Hebrew"); |
| format.fontSize = fontSize; |
| var y:Number = 0; |
| var leading:Number = fontSize * 0.2; |
| var text:String = "abc" + String.fromCharCode(0x05D0, 0x05D1, 0x05D2); |
| |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = new TextElement(text, format); |
| |
| // bidiLevel even |
| textBlock.bidiLevel = 0; |
| var textLine = textBlock.createTextLine(null, 400); |
| y += leading + textLine.ascent; |
| textLine.y = y; |
| y += textLine.descent; |
| addChild(textLine); |
| |
| // bidiLevel odd |
| textBlock.content = new TextElement(text, format); |
| textBlock.bidiLevel = 1; |
| textLine = textBlock.createTextLine(null, 400); |
| y += leading + textLine.ascent; |
| textLine.y = y; |
| addChild(textLine); |
| } |
| } |
| } |
| </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">createTextLine()</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:content:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">content</apiName><shortdesc class="- topic/shortdesc "> |
| Holds the contents of the text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:ContentElement</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to a value which is not a known subclass of <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified is already a member of a group. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Holds the contents of the text block. Because ContentElement is a base class, assign <codeph class="+ topic/ph pr-d/codeph ">content</codeph> |
| an instance of a ContentElement subclass: TextElement, GraphicElement, or GroupElement. A TextElement object |
| contains a String, a GraphicElement object contains a DisplayObject, and a GroupElement contains a Vector object that |
| contains one or more TextElement, GraphicElement, or other GroupElement objects. Use a TextElement for a |
| paragraph of homogenous text, a GraphicElement for a graphic, and a GroupElement for a combination of text and graphic |
| elements or multiples instances of these elements, as well as other GroupElement objects. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| <p class="- topic/p ">Modifying the <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property changes the validity of all previously created lines to |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.INVALID</codeph>. After changing <codeph class="+ topic/ph pr-d/codeph ">content</codeph>, the <codeph class="+ topic/ph pr-d/codeph ">firstInvalidLine</codeph> property |
| equals the <codeph class="+ topic/ph pr-d/codeph ">firstLine</codeph> property and you must rebreak all lines in the TextBlock.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement" class="- topic/link "><linktext class="- topic/linktext ">ContentElement</linktext></link><link href="flash.text.engine.xml#GraphicElement" class="- topic/link "><linktext class="- topic/linktext ">GraphicElement</linktext></link><link href="flash.text.engine.xml#GroupElement" class="- topic/link "><linktext class="- topic/linktext ">GroupElement</linktext></link><link href="flash.text.engine.xml#TextElement" class="- topic/link "><linktext class="- topic/linktext ">TextElement</linktext></link><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">createTextLine()</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:firstInvalidLine:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">firstInvalidLine</apiName><shortdesc class="- topic/shortdesc "> |
| Identifies the first line in the text block in which TextLine.validity is not equal to |
| TextLineValidity.VALID.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLine</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Identifies the first line in the text block in which <codeph class="+ topic/ph pr-d/codeph ">TextLine.validity</codeph> is not equal to |
| <codeph class="+ topic/ph pr-d/codeph ">TextLineValidity.VALID</codeph>. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine/validity" class="- topic/link "><linktext class="- topic/linktext ">TextLine.validity</linktext></link><link href="flash.text.engine.xml#TextLineValidity" class="- topic/link "><linktext class="- topic/linktext ">TextLineValidity</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:firstLine:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">firstLine</apiName><shortdesc class="- topic/shortdesc "> |
| The first TextLine in the TextBlock, if any.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLine</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The first TextLine in the TextBlock, if any. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine" class="- topic/link "><linktext class="- topic/linktext ">TextLine</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:lastLine:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">lastLine</apiName><shortdesc class="- topic/shortdesc "> |
| The last TextLine in the TextBlock, if any.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLine</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The last TextLine in the TextBlock, if any. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLine" class="- topic/link "><linktext class="- topic/linktext ">TextLine</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:lineRotation:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">lineRotation</apiName><shortdesc class="- topic/shortdesc "> |
| Rotates the text lines in the text block as a unit.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to any value which is not a member of <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to <codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph>. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Rotates the text lines in the text block as a unit. Call the <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph> method <i class="+ topic/ph hi-d/i ">after</i> |
| setting <codeph class="+ topic/ph pr-d/codeph ">lineRotation</codeph> for it to take effect. The default value is <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph>. |
| |
| <p class="- topic/p ">The final rotation of any glyph depends on the values of |
| <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.textRotation</codeph>, <codeph class="+ topic/ph pr-d/codeph ">ContentElement.textRotation</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation</codeph>.</p> |
| |
| <p class="- topic/p "><codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation</codeph> is typically used for Asian text. |
| To create a paragraph of vertical Japanese text, do the following:</p> |
| <ol class="- topic/ol "><li class="- topic/li ">Set the <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation</codeph> property to <codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_90</codeph>.</li><li class="- topic/li ">Leave the <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.textRotation</codeph> property of the content as the default, <codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph>.</li></ol> |
| |
| <p class="- topic/p ">Use the following constants, which are defined in the <codeph class="+ topic/ph pr-d/codeph ">TextRotation</codeph> class, to set the |
| value for this property:</p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_0</codeph></entry><entry class="- topic/entry ">Lines are not rotated.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_90</codeph></entry><entry class="- topic/entry ">Lines are rotated 90 degrees clockwise.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_180</codeph></entry><entry class="- topic/entry ">Lines are rotated 180 degrees.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.ROTATE_270</codeph></entry><entry class="- topic/entry ">Lines are rotated 270 degrees clockwise.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextRotation.AUTO</codeph></entry><entry class="- topic/entry ">Not supported.</entry></row></tbody></tgroup></adobetable> |
| |
| </apiDesc><example conref="examples\TextBlock_lineRotationExample.as" class="- topic/example "> This example adds Japanese text to a TextBlock and sets the |
| <codeph class="+ topic/ph pr-d/codeph ">lineRotation</codeph> property to TextRotation.ROTATE_90 to display the line |
| vertically. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| import flash.display.Sprite; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.TextRotation; |
| import flash.text.engine.ElementFormat; |
| |
| public class TextBlock_lineRotationExample extends Sprite { |
| |
| public function TextBlock_lineRotationExample():void { |
| var Japanese:String = String.fromCharCode( |
| 0x5185, 0x95A3, 0x5E9C, 0x304C, 0x300C, 0x653F, 0x5E9C, 0x30A4, |
| 0x30F3, 0x30BF, 0x30FC, 0x30CD, 0x30C3, 0x30C8, 0x30C6, 0x30EC, |
| 0x30D3, 0x300D, 0x306E, 0x52D5, 0x753B, 0x914D, 0x4FE1, 0x5411, |
| 0x3051, 0x306B, 0x30A2, 0x30C9, 0x30D3, 0x30B7, 0x30B9, 0x30C6, |
| 0x30E0, 0x30BA, 0x793E, 0x306E |
| ) + |
| "FMS 2" + |
| String.fromCharCode(0x3092, 0x63A1, 0x7528, 0x3059, 0x308B, 0x3068, |
| 0x767a, 0x8868, 0x3057, 0x307e, 0x3057, 0x305F, 0x3002); |
| |
| var fontDescription:FontDescription = new FontDescription("MS Mincho"); |
| var format:ElementFormat = new ElementFormat(); |
| format.fontSize = 15; |
| format.fontDescription = fontDescription; |
| |
| var textElement:TextElement = new TextElement(Japanese, format); |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = textElement; |
| textBlock.lineRotation = TextRotation.ROTATE_90; |
| |
| var linePosition:Number = this.stage.stageWidth - 120; |
| var previousLine:TextLine = null; |
| |
| while (true) { |
| var textLine:TextLine = textBlock.createTextLine( |
| previousLine, |
| 300); |
| if (textLine == null) |
| break; |
| textLine.y = 30; |
| textLine.x = linePosition; |
| linePosition -= 24; |
| addChild(textLine); |
| previousLine = textLine; |
| } |
| } |
| } |
| } |
| </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/textRotation" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.textRotation</linktext></link><link href="flash.text.engine.xml#ElementFormat/textRotation" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.textRotation</linktext></link><link href="flash.text.engine.xml#TextLine" class="- topic/link "><linktext class="- topic/linktext ">TextLine</linktext></link><link href="flash.text.engine.xml#TextRotation" class="- topic/link "><linktext class="- topic/linktext ">TextRotation</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:tabStops:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">tabStops</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the tab stops for the text in the text block, |
| in the form of a Vector of TabStop objects.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiType value="Vector$flash.text.engine:TabStop" name="type" class="- topic/state reference/state apiRef/apiType "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">tabStops</codeph> specified contain <codeph class="+ topic/ph pr-d/codeph ">null</codeph> elements. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">tabStops</codeph> specified are not sorted by increasing position. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the tab stops for the text in the text block, |
| in the form of a Vector of <codeph class="+ topic/ph pr-d/codeph ">TabStop</codeph> objects. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>, which means no tab stops are specified. When no tab stops are specified (or the insertion point is beyond the last specified tab stop) |
| the runtime creates half-inch tabs by default.</p> |
| |
| <p class="- topic/p ">When the <codeph class="+ topic/ph pr-d/codeph ">tabStops</codeph> property is set, the TextBlock makes a copy of the Vector for internal use. |
| Modifying the original Vector or its contents does not affect the TextBlock. When the <codeph class="+ topic/ph pr-d/codeph ">tabStops</codeph> property is queried, a copy |
| of the internal Vector is returned. Again, modifying this returned vector or its contents does not affect the TextBlock.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TabStop" class="- topic/link "><linktext class="- topic/linktext ">TabStop</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:textJustifier:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textJustifier</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the TextJustifier to use during line creation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextJustifier</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If set to a value which is not a known subclass of <codeph class="+ topic/ph pr-d/codeph ">TextJustifier</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the TextJustifier to use during line creation. |
| |
| <p class="- topic/p ">The default value is a constructed default TextJustifier object.</p> |
| |
| <p class="- topic/p ">When the <codeph class="+ topic/ph pr-d/codeph ">textJustifier</codeph> property is set, the TextBlock makes a copy of the object for internal use. |
| Modifying the original object does not affect the TextBlock. When the <codeph class="+ topic/ph pr-d/codeph ">textJustifier</codeph> property is queried, a copy |
| of the internal object is returned. Again, modifying this returned object does not affect the TextBlock.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#EastAsianJustifier" class="- topic/link "><linktext class="- topic/linktext ">EastAsianJustifier</linktext></link><link href="flash.text.engine.xml#SpaceJustifier" class="- topic/link "><linktext class="- topic/linktext ">SpaceJustifier</linktext></link><link href="flash.text.engine.xml#TextJustifier" class="- topic/link "><linktext class="- topic/linktext ">TextJustifier</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBlock:textLineCreationResult:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textLineCreationResult</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates the result of a createTextLine() operation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates the result of a <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph> operation. |
| Changing the content of the block invalidates previously broken lines and resets |
| this property to <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| <p class="- topic/p ">Values for this property are found in <codeph class="+ topic/ph pr-d/codeph ">TextLineCreationResult</codeph></p> |
| |
| <adobetable class="innertable"><tgroup cols="2" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">String value</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextLineCreationResult.SUCCESS</codeph></entry><entry class="- topic/entry ">The line was successfully broken.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextLineCreationResult.COMPLETE</codeph></entry><entry class="- topic/entry ">Either the new line created aligned perfectly with following lines which |
| have transitioned from POSSIBLY_INVALID to VALID, or |
| no line was created because all text in the block had already been broken.</entry></row><row class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">TextLineCreationResult.INSUFFICIENT_WIDTH</codeph></entry><entry class="- topic/entry ">No line was created because no text could fit in the specified width.</entry></row></tbody></tgroup></adobetable> |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextLineCreationResult" class="- topic/link "><linktext class="- topic/linktext ">TextLineCreationResult</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextLineCreationResult" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextLineCreationResult</apiName><shortdesc class="- topic/shortdesc "> |
| The TextLineCreationResult class is an enumeration of constant values used with TextBlock.textLineCreationResult.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextLineCreationResult class is an enumeration of constant values used with <codeph class="+ topic/ph pr-d/codeph ">TextBlock.textLineCreationResult</codeph>. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link><link href="flash.text.engine.xml#TextBlock/textLineCreationResult" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.textLineCreationResult</linktext></link></related-links><apiValue id="flash.text.engine:TextLineCreationResult:COMPLETE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">COMPLETE</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates no line was created because all text in the block had already been broken.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">complete</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates no line was created because all text in the block had already been broken. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineCreationResult:EMERGENCY" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">EMERGENCY</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates the line was created with an emergency break because no break opportunity |
| was available in the specified width.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">emergency</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates the line was created with an emergency break because no break opportunity |
| was available in the specified width. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineCreationResult:INSUFFICIENT_WIDTH" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">INSUFFICIENT_WIDTH</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates no line was created because no text could fit in the specified width |
| and fitSomething was not specified in the call to createTextLine().</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">insufficientWidth</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates no line was created because no text could fit in the specified width |
| and <codeph class="+ topic/ph pr-d/codeph ">fitSomething</codeph> was not specified in the call to <codeph class="+ topic/ph pr-d/codeph ">createTextLine()</codeph>. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineCreationResult:SUCCESS" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">SUCCESS</apiName><shortdesc class="- topic/shortdesc "> |
| Indicates the line was successfully broken.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">success</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Indicates the line was successfully broken. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:LigatureLevel" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">LigatureLevel</apiName><shortdesc class="- topic/shortdesc "> |
| The LigatureLevel class is an enumeration of constant values used in setting the ligatureLevel property |
| of the ElementFormat class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The LigatureLevel class is an enumeration of constant values used in setting the <codeph class="+ topic/ph pr-d/codeph ">ligatureLevel</codeph> property |
| of the ElementFormat class. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures |
| usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. |
| They are used with both Latin and Non-Latin character sets. |
| <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> When working with Arabic or Syriac fonts, <codeph class="+ topic/ph pr-d/codeph ">ligatureLevel</codeph> must be set to MINIMUM or above.</p> |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/ligatureLevel" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.ligatureLevel</linktext></link></related-links><apiValue id="flash.text.engine:LigatureLevel:COMMON" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">COMMON</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify common ligatures.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">common</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify common ligatures. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:LigatureLevel:EXOTIC" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">EXOTIC</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify exotic ligatures.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">exotic</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify exotic ligatures. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:LigatureLevel:MINIMUM" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">MINIMUM</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify minimum ligatures.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">minimum</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify minimum ligatures. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:LigatureLevel:NONE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">NONE</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify no ligatures.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">none</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify no ligatures. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:LigatureLevel:UNCOMMON" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">UNCOMMON</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify uncommon ligatures.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">uncommon</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify uncommon ligatures. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextRotation" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextRotation</apiName><shortdesc class="- topic/shortdesc "> |
| The TextRotation class is an enumeration of constant values used with the following properties: |
| ElementFormat.textRotation, ContentElement.textRotation, |
| TextBlock.lineRotation, and TextLine.getAtomTextRotation().</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextRotation class is an enumeration of constant values used with the following properties: |
| <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.textRotation</codeph>, <codeph class="+ topic/ph pr-d/codeph ">ContentElement.textRotation</codeph>, |
| <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">TextLine.getAtomTextRotation()</codeph>. |
| |
| <p class="- topic/p ">The final rotation of any glyph is the sum of <codeph class="+ topic/ph pr-d/codeph ">TextBlock.lineRotation</codeph>, |
| <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.textRotation</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">ContentElement.textRotation</codeph></p> |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/textRotation" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.textRotation</linktext></link><link href="flash.text.engine.xml#ContentElement/textRotation" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.textRotation</linktext></link><link href="flash.text.engine.xml#TextBlock/lineRotation" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.lineRotation</linktext></link><link href="flash.text.engine.xml#TextLine/getAtomTextRotation()" class="- topic/link "><linktext class="- topic/linktext ">TextLine.getAtomTextRotation()</linktext></link></related-links><apiValue id="flash.text.engine:TextRotation:AUTO" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">AUTO</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies a 90 degree counter clockwise rotation for full width and wide glyphs only, |
| as determined by the Unicode properties of the glyph.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">auto</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies a 90 degree counter clockwise rotation for full width and wide glyphs only, |
| as determined by the Unicode properties of the glyph. |
| This value is typically used with Asian text to rotate |
| only those glyphs that require rotation. |
| This rotation is applied only in vertical text to return full width and wide |
| characters to a vertical orientation without affecting other characters. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextRotation:ROTATE_0" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ROTATE_0</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies no rotation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate0</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies no rotation. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextRotation:ROTATE_180" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ROTATE_180</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies a 180 degree rotation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate180</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies a 180 degree rotation. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextRotation:ROTATE_270" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ROTATE_270</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies a 270 degree clockwise rotation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate270</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies a 270 degree clockwise rotation. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextRotation:ROTATE_90" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ROTATE_90</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies a 90 degree clockwise rotation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate90</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies a 90 degree clockwise rotation. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TabAlignment" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TabAlignment</apiName><shortdesc class="- topic/shortdesc "> |
| The TabAlignment class is an enumeration of constant values that you can use to set the tabAlignment property |
| of the TabStop class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TabAlignment class is an enumeration of constant values that you can use to set the <codeph class="+ topic/ph pr-d/codeph ">tabAlignment</codeph> property |
| of the <codeph class="+ topic/ph pr-d/codeph ">TabStop</codeph> class. |
| |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TabStop/alignment" class="- topic/link "><linktext class="- topic/linktext ">TabStop.alignment</linktext></link><link href="flash.text.engine.xml#TextBlock/tabStops" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.tabStops</linktext></link></related-links><apiValue id="flash.text.engine:TabAlignment:CENTER" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">CENTER</apiName><shortdesc class="- topic/shortdesc "> |
| Positions the center of the tabbed text at the tab stop.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">center</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Positions the center of the tabbed text at the tab stop. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TabAlignment:DECIMAL" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">DECIMAL</apiName><shortdesc class="- topic/shortdesc "> |
| Positions the alignment token of the tabbed text at the tab stop.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">decimal</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Positions the alignment token of the tabbed text at the tab stop. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TabStop/decimalAlignmentToken" class="- topic/link "><linktext class="- topic/linktext ">TabStop.decimalAlignmentToken</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TabAlignment:END" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">END</apiName><shortdesc class="- topic/shortdesc "> |
| Positions the end of the tabbed text at the tab stop.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">end</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Positions the end of the tabbed text at the tab stop. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TabAlignment:START" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">START</apiName><shortdesc class="- topic/shortdesc "> |
| Positions the start of the tabbed text at the tab stop.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">start</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Positions the start of the tabbed text at the tab stop. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:GraphicElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">GraphicElement</apiName><shortdesc class="- topic/shortdesc "> |
| The GraphicElement class represents a graphic element in a TextBlock or GroupElement object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.text.engine:ContentElement</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The GraphicElement class represents a graphic element in a TextBlock or GroupElement object. Assign a GraphicElement object to the |
| <codeph class="+ topic/ph pr-d/codeph ">content</codeph> property of a TextBlock object to display a graphic or an image with <codeph class="+ topic/ph pr-d/codeph ">TextBlock.createTextLine()</codeph>. |
| Assign it to a GroupElement object to combine it with other graphic and text elements. |
| |
| </apiDesc><example conref="examples\GraphicElementExample.as" class="- topic/example "> The following example creates a TextBlock with a GraphicElement (a red box) and |
| displays it, adding a second TextBlock beneath it that contains a caption. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.display.MovieClip; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.GraphicElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.FontDescription; |
| |
| public class GraphicElementExample extends Sprite { |
| |
| public function GraphicElementExample():void { |
| |
| var format:ElementFormat = new ElementFormat(); |
| format.fontSize = 14; |
| var redBox:MovieClip = new MovieClip(); |
| redBox.graphics.beginFill(0xCC0000, 1.0); |
| redBox.graphics.drawRect(0,0, 200, 200); |
| redBox.graphics.endFill(); |
| var graphicElement:GraphicElement = new GraphicElement(redBox,redBox.width,redBox.height, format); |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = graphicElement; |
| var textLine1:TextLine = textBlock.createTextLine(null,redBox.width); |
| addChild(textLine1); |
| textLine1.x = 15 |
| textLine1.y = 215 |
| var str:String = "Your picture here ..."; |
| var textElement:TextElement = new TextElement(str, format); |
| textBlock = new TextBlock(); |
| textBlock.content = textElement; |
| var textLine2 = textBlock.createTextLine(null, 300); |
| addChild(textLine2); |
| textLine2.x = textLine1.x; |
| textLine2.y += textLine1.y + format.fontSize; |
| } |
| } |
| } |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement" class="- topic/link "><linktext class="- topic/linktext ">ContentElement</linktext></link><link href="flash.text.engine.xml#GroupElement" class="- topic/link "><linktext class="- topic/linktext ">GroupElement</linktext></link><link href="flash.text.engine.xml#TextBlock" class="- topic/link "><linktext class="- topic/linktext ">TextBlock</linktext></link></related-links><apiConstructor id="flash.text.engine:GraphicElement:GraphicElement" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">GraphicElement</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a new GraphicElement instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">graphic</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.display:DisplayObject</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The DisplayObject to populate the GraphicElement. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elementWidth</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">15.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The width of the area reserved for the element in pixels. The default value is 15. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elementHeight</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">15.0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The height of the area reserved for the element in pixels. The default value is 15. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">elementFormat</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:ElementFormat</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The element format for the element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">eventMirror</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.events:EventDispatcher</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">EventDispatcher</codeph> object that receives copies of every |
| event dispatched to text lines created based on this content element. The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">textRotation</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">rotate0</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rotation applied to the element as a unit. Use <codeph class="+ topic/ph pr-d/codeph ">flash.text.engine.TextRotation</codeph> |
| constants for this property. The default value is <codeph class="+ topic/ph pr-d/codeph ">flash.text.engine.TextRotation.ROTATE_0</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a new GraphicElement instance. |
| |
| <p class="- topic/p ">The registration point of the graphic aligns with the upper-left corner |
| of the region defined by <codeph class="+ topic/ph pr-d/codeph ">elementHeight</codeph>, <codeph class="+ topic/ph pr-d/codeph ">elementWidth</codeph> |
| and <codeph class="+ topic/ph pr-d/codeph ">elementFormat.baselineShift</codeph>. The graphic is not scaled to match the size of the region. |
| If the GraphicElement has an <codeph class="+ topic/ph pr-d/codeph ">eventMirror</codeph>, the <codeph class="+ topic/ph pr-d/codeph ">elementWidth</codeph> and <codeph class="+ topic/ph pr-d/codeph ">elementHeight</codeph> |
| properties, and not the graphic, determine the size and position of the resulting mirror region. If a loader |
| is used, the graphic might not be loaded at the time the text line and the mirror regions are created.</p> |
| |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#GroupElement" class="- topic/link "><linktext class="- topic/linktext ">GroupElement</linktext></link></related-links></apiConstructor><apiValue id="flash.text.engine:GraphicElement:elementHeight:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">elementHeight</apiName><shortdesc class="- topic/shortdesc "> |
| The height in pixels to reserve for the graphic in the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The height in pixels to reserve for the graphic in the line. |
| It is the responsibility of the caller to scale the graphic. |
| |
| <p class="- topic/p ">The default value is 15.0.</p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:GraphicElement:elementWidth:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">elementWidth</apiName><shortdesc class="- topic/shortdesc "> |
| The width in pixels to reserve for the graphic in the line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The width in pixels to reserve for the graphic in the line. |
| It is the responsibility of the caller to scale the graphic. |
| |
| <p class="- topic/p ">The default value is 15.0.</p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:GraphicElement:graphic:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">graphic</apiName><shortdesc class="- topic/shortdesc "> |
| The DisplayObject to be used as a graphic for the GraphicElement.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:DisplayObject</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The DisplayObject to be used as a graphic for the GraphicElement. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p> |
| |
| <p class="- topic/p ">When the GraphicElement becomes part of a text line, the graphic |
| is added as a child of the line. Setting the graphic removes |
| the old graphic from the line and adds the new one.</p> |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:FontWeight" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">FontWeight</apiName><shortdesc class="- topic/shortdesc "> |
| The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The FontWeight class is an enumeration of constant values used with <codeph class="+ topic/ph pr-d/codeph ">FontDescription.fontWeight</codeph>. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/fontWeight" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.FontDescription.fontWeight</linktext></link></related-links><apiValue id="flash.text.engine:FontWeight:BOLD" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">BOLD</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate bold font weight.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">bold</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate bold font weight. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:FontWeight:NORMAL" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">NORMAL</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate normal font weight.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">normal</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate normal font weight. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextBaseline" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextBaseline</apiName><shortdesc class="- topic/shortdesc "> |
| The TextBaseline class is an enumeration of constant values to use in setting the dominantBaseline and |
| alignmentBaseline properties of the ElementFormat class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextBaseline class is an enumeration of constant values to use in setting the <codeph class="+ topic/ph pr-d/codeph ">dominantBaseline</codeph> and |
| <codeph class="+ topic/ph pr-d/codeph ">alignmentBaseline</codeph> properties of the ElementFormat class. You can also use it in the |
| <codeph class="+ topic/ph pr-d/codeph ">baselineZero</codeph> property of the TextBlock class. |
| Consider this situation: |
| <p class="- topic/p "><adobeimage alt="Text baseline alignment" href="../../../images/textBaselines.gif" placement="inline" class="+ topic/image adobe-d/adobeimage "/></p> |
| <p class="- topic/p ">The line consists of four <codeph class="+ topic/ph pr-d/codeph ">TextElement</codeph> objects, containing 'a', 'b', 'cccccccc', and 'X' respectively. |
| The element containing 'X' determines the line baselines because it is the largest element in the line. |
| The roman baseline of the 'X' element is aligned with the roman baseline of the line. |
| The ideographic top of the 'a' element is aligned with the ideographic top of the line. |
| The ideographic bottom of the 'b' element is aligned with the ideographic bottom of the line. |
| The ideographic center of the 'cccccccc' element is aligned with the ideographic center of the line.</p> |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link></related-links><apiValue id="flash.text.engine:TextBaseline:ASCENT" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ASCENT</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies an ascent baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">ascent</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies an ascent baseline. |
| For a text element, the font and point size of the text determine this value. |
| For a graphic element, the text engine uses the geometric top of the element. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBaseline:DESCENT" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">DESCENT</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies a descent baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">descent</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies a descent baseline. |
| For a text element, the font and point size of the text determine this value. |
| For a graphic element, the text element uses the geometric bottom of the element. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBaseline:IDEOGRAPHIC_BOTTOM" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">IDEOGRAPHIC_BOTTOM</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies an ideographic bottom baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">ideographicBottom</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies an ideographic bottom baseline. |
| For a text element, the font and point size of the text determine this value. |
| For a graphic element, the text engine uses the geometric bottom of the element. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBaseline:IDEOGRAPHIC_CENTER" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">IDEOGRAPHIC_CENTER</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies an ideographic center baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">ideographicCenter</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies an ideographic center baseline. |
| For a text element, the font and point size of the text determine this value. |
| For a graphic element, the text engine uses the geometric center of the element. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBaseline:IDEOGRAPHIC_TOP" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">IDEOGRAPHIC_TOP</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies an ideographic top baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">ideographicTop</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies an ideographic top baseline. |
| For a text element, the font and point size of the text determine this value. |
| For a graphic element, the text engine uses the geometric top of the element. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBaseline:ROMAN" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ROMAN</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies a roman baseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">roman</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies a roman baseline. |
| For a text element, the font and point size of the text determine this value. |
| For a graphic element, the text engine uses the geometric bottom of the element. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/dominantBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.dominantBaseline</linktext></link><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link><link href="flash.text.engine.xml#TextBlock/baselineZero" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.baselineZero</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:TextBaseline:USE_DOMINANT_BASELINE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">USE_DOMINANT_BASELINE</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies that the alignmentBaseline is the same as the dominantBaseline.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">useDominantBaseline</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies that the alignmentBaseline is the same as the dominantBaseline. |
| Use this value only to set <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.alignmentBaseline</codeph>. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/alignmentBaseline" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.alignmentBaseline</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:BreakOpportunity" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">BreakOpportunity</apiName><shortdesc class="- topic/shortdesc "> |
| The BreakOpportunity class is an enumeration of constant values that you can use to set the breakOpportunity property |
| of the ElementFormat class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The BreakOpportunity class is an enumeration of constant values that you can use to set the <codeph class="+ topic/ph pr-d/codeph ">breakOpportunity</codeph> property |
| of the ElementFormat class. |
| This property determines which characters can be used for breaking when wrapping text is broken into multiple lines. |
| |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/breakOpportunity" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.breakOpportunity</linktext></link></related-links><apiValue id="flash.text.engine:BreakOpportunity:ALL" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ALL</apiName><shortdesc class="- topic/shortdesc "> |
| Treats all characters in the ContentElement object as line break opportunities, meaning that a line break will occur |
| afer each character.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">all</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| 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. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:BreakOpportunity:ANY" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ANY</apiName><shortdesc class="- topic/shortdesc "> |
| Treats any character in the ContentElement object as a line break opportunity.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">any</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| 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. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:BreakOpportunity:AUTO" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">AUTO</apiName><shortdesc class="- topic/shortdesc "> |
| Bases line break opportunities on Unicode character properties.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">auto</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Bases line break opportunities on Unicode character properties. This setting implements |
| the Unicode line breaking properties defined by the Unicode Standard Annex #14. |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="http://unicode.org/reports/tr14/tr14-12.html" class="- topic/link "><linktext class="- topic/linktext ">Article on Unicode line breaking properties.</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:BreakOpportunity:NONE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">NONE</apiName><shortdesc class="- topic/shortdesc "> |
| Treats no characters in the ContentElement object as line break opportunities.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">none</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Treats no characters in the ContentElement object as line break opportunities. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:DigitWidth" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">DigitWidth</apiName><shortdesc class="- topic/shortdesc "> |
| The DigitWidth class is an enumeration of constant values used in setting the digitWidth property |
| of the ElementFormat class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The DigitWidth class is an enumeration of constant values used in setting the <codeph class="+ topic/ph pr-d/codeph ">digitWidth</codeph> property |
| of the ElementFormat class. |
| |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/digitWidth" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.ElementFormat.digitWidth</linktext></link></related-links><apiValue id="flash.text.engine:DigitWidth:DEFAULT" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">DEFAULT</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify default digit width.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">default</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify default digit width. The results are font-dependent; characters use the settings specified by the font designer |
| without any features applied. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:DigitWidth:PROPORTIONAL" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">PROPORTIONAL</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify proportional digit width.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">proportional</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify proportional digit width. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:DigitWidth:TABULAR" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">TABULAR</apiName><shortdesc class="- topic/shortdesc "> |
| Used to specify tabular digit width.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">tabular</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to specify tabular digit width. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:CFFHinting" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">CFFHinting</apiName><shortdesc class="- topic/shortdesc "> |
| The CFFHinting class defines values for cff hinting in the FontDescription class.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The CFFHinting class defines values for cff hinting in the FontDescription class. |
| |
| <p class="- topic/p ">Hinting adjusts the display of an outline font so it lines up with the pixel grid. |
| At small screen sizes, hinting produces a clear, legible text for human readers. |
| </p> |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.FontDescription</linktext></link></related-links><apiValue id="flash.text.engine:CFFHinting:HORIZONTAL_STEM" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">HORIZONTAL_STEM</apiName><shortdesc class="- topic/shortdesc "> |
| Fits strong horizontal stems to the pixel grid for improved readability.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">horizontalStem</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Fits strong horizontal stems to the pixel grid for improved readability. |
| This constant is used in setting the <codeph class="+ topic/ph pr-d/codeph ">cffHinting</codeph> property of the |
| FontDescription class. Use the syntax <codeph class="+ topic/ph pr-d/codeph ">CFFHinting.HORIZONTAL_STEM</codeph>. |
| |
| <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> Not recommended for animation.</p> |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/cffHinting" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.FontDescription.cffHinting</linktext></link></related-links></apiValue><apiValue id="flash.text.engine:CFFHinting:NONE" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">NONE</apiName><shortdesc class="- topic/shortdesc "> |
| No hinting is applied.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">none</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| No hinting is applied. Horizontal stems in the glyphs are not forced to the pixel grid. |
| This constant is used in setting the <codeph class="+ topic/ph pr-d/codeph ">cffHinting</codeph> property of the |
| FontDescription class. Recommended setting for animation or for large font sizes. |
| Use the syntax <codeph class="+ topic/ph pr-d/codeph ">CFFHinting.NONE</codeph>. |
| |
| </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#FontDescription/cffHinting" class="- topic/link "><linktext class="- topic/linktext ">flash.text.engine.FontDescription.cffHinting</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:Kerning" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">Kerning</apiName><shortdesc class="- topic/shortdesc "> |
| The Kerning class is an enumeration of constant values used with ElementFormat.kerning.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The Kerning class is an enumeration of constant values used with <codeph class="+ topic/ph pr-d/codeph ">ElementFormat.kerning</codeph>. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ElementFormat/kerning" class="- topic/link "><linktext class="- topic/linktext ">ElementFormat.kerning</linktext></link></related-links><apiValue id="flash.text.engine:Kerning:AUTO" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">AUTO</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate that kerning is enabled except where inappropriate in Asian typography.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">auto</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate that kerning is enabled except where inappropriate in Asian typography. Kerning is |
| applied between two characters if neither is Kanji, Hiragana, or Katakana. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:Kerning:OFF" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">OFF</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate kerning is disabled.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">off</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate kerning is disabled. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:Kerning:ON" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ON</apiName><shortdesc class="- topic/shortdesc "> |
| Used to indicate kerning is enabled.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">on</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Used to indicate kerning is enabled. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:TextLineMirrorRegion" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">TextLineMirrorRegion</apiName><shortdesc class="- topic/shortdesc "> |
| The TextLineMirrorRegion class represents a portion of a text line wherein events are mirrored to another event dispatcher.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextLineMirrorRegion class represents a portion of a text line wherein events are mirrored to another event dispatcher. |
| |
| <p class="- topic/p ">After normal event-dispatching for a text line finishes, if the line is valid and event propagation has not been stopped, |
| events are re dispatched to the mirror regions of the line.</p> |
| |
| <p class="- topic/p ">Mirroring of mouse events is a special case. Because mirror regions aren't actually display objects, <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> and <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph> |
| events are simulated for them. The <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> and <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> events are not simulated. All naturally occuring |
| <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph>, <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph>, <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> and <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> events (whether targetted at the |
| text line or at children of the text line) are ignored - they are not mirrored.</p> |
| |
| <p class="- topic/p ">You cannot create a TextLineMirrorRegion object directly from ActionScript code. |
| If you call <codeph class="+ topic/ph pr-d/codeph ">new TextLineMirrorRegion()</codeph>, an exception is thrown. A TextLineMirrorRegion is created and associated with a text line when that |
| text line is created from a ContentElement object with an event mirror set.</p> |
| |
| <p class="- topic/p ">The TextLineMirrorRegion class is final; it cannot be subclassed.</p> |
| |
| </apiDesc><example conref="examples\TextLineMirrorRegionExample.as" class="- topic/example "> This example displays a block of text with mirror regions that turn red when you click |
| them. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.FontDescription; |
| import flash.text.engine.ContentElement; |
| import flash.text.engine.GroupElement; |
| import flash.text.engine.TextLineMirrorRegion; |
| import flash.events.MouseEvent; |
| import flash.events.EventDispatcher; |
| import flash.ui.Mouse; |
| |
| public class TextLineMirrorRegionExample extends Sprite { |
| |
| var myEvent:EventDispatcher = new EventDispatcher(); |
| var fontDescription:FontDescription = new FontDescription(); |
| var textBlock:TextBlock = new TextBlock(); |
| |
| public function TextLineMirrorRegionExample():void { |
| |
| fontDescription.fontWeight = "bold"; |
| var blackFormat:ElementFormat = new ElementFormat(); |
| blackFormat.fontSize = 18; |
| blackFormat.color = 0x000000; |
| blackFormat.fontDescription = fontDescription; |
| |
| var textElement1 = new TextElement("Click on different parts of me to find the ", blackFormat); |
| var textElement2 = new TextElement("mirror regions",blackFormat); |
| var textElement3 = new TextElement(". If I am a mirror region, I'll ",blackFormat); |
| var textElement4 = new TextElement("turn red",blackFormat); |
| var textElement5 = new TextElement(".",blackFormat); |
| |
| myEvent.addEventListener("click", clickHandler); |
| myEvent.addEventListener("mouseOut", mouseOutHandler); |
| myEvent.addEventListener("mouseOver", mouseOverHandler); |
| |
| var groupVector:Vector.<ContentElement> = new Vector.<ContentElement>; |
| groupVector.push(textElement1, textElement2, textElement3, textElement4, textElement5); |
| var groupElement:GroupElement = new GroupElement(groupVector); |
| |
| textElement2.eventMirror=myEvent; |
| textElement4.eventMirror=myEvent; |
| |
| textBlock.content = groupElement; |
| createLines(textBlock); |
| } |
| |
| private function clickHandler(event:MouseEvent):void |
| { |
| var redFormat:ElementFormat = new ElementFormat(); |
| redFormat.color = 0xCC0000; |
| redFormat.fontSize = 18; |
| redFormat.fontDescription = fontDescription; |
| var line:TextLine = event.target as TextLine; |
| var region:TextLineMirrorRegion = line.getMirrorRegion(myEvent); |
| region.element.elementFormat = redFormat; |
| createLines(textBlock); |
| } |
| |
| private function mouseOverHandler(event:MouseEvent):void |
| { |
| Mouse.cursor = "button"; |
| } |
| |
| private function mouseOutHandler(event:MouseEvent):void |
| { |
| Mouse.cursor = "arrow"; |
| } |
| |
| private function createLines(textBlock:TextBlock):void |
| { |
| var purgeLine:TextLine = textBlock.firstLine; |
| |
| while (purgeLine) |
| { |
| removeChild (purgeLine); |
| purgeLine = purgeLine.nextLine; |
| } |
| var lineWidth:Number = 150; |
| var xPos:Number = 15.0; |
| var yPos:Number = 20.0; |
| var textLine:TextLine = textBlock.createTextLine (null, lineWidth); |
| |
| while (textLine) |
| { |
| textLine.x = xPos; |
| textLine.y = yPos; |
| yPos += textLine.height + 2; |
| addChild (textLine); |
| textLine = textBlock.createTextLine (textLine, lineWidth); |
| } |
| } |
| } |
| } |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#ContentElement/eventMirror" class="- topic/link "><linktext class="- topic/linktext ">ContentElement.eventMirror</linktext></link><link href="flash.text.engine.xml#TextBlock/createTextLine()" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.createTextLine()</linktext></link><link href="flash.text.engine.xml#TextLine/mirrorRegions" class="- topic/link "><linktext class="- topic/linktext ">TextLine.mirrorRegions</linktext></link></related-links><apiValue id="flash.text.engine:TextLineMirrorRegion:bounds:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">bounds</apiName><shortdesc class="- topic/shortdesc "> |
| The bounds of the mirror region, relative to the text line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.geom:Rectangle</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The bounds of the mirror region, relative to the text line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineMirrorRegion:element:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">element</apiName><shortdesc class="- topic/shortdesc "> |
| The ContentElement object from which the mirror region was derived.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:ContentElement</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The TextLine to which this element belongs is not valid. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The <codeph class="+ topic/ph pr-d/codeph ">ContentElement</codeph> object from which the mirror region was derived. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineMirrorRegion:mirror:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">mirror</apiName><shortdesc class="- topic/shortdesc "> |
| The EventDispatcher object to which events affecting the mirror region are mirrored.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.events:EventDispatcher</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The <codeph class="+ topic/ph pr-d/codeph ">EventDispatcher</codeph> object to which events affecting the mirror region are mirrored. |
| This includes mouse events that specifically occur in the mirror region, and all other events |
| that target the text line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineMirrorRegion:nextRegion:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">nextRegion</apiName><shortdesc class="- topic/shortdesc "> |
| The next TextLineMirrorRegion in the set derived from the text element, or null if the current region is the last mirror region |
| in the set.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLineMirrorRegion</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The next TextLineMirrorRegion in the set derived from the text element, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if the current region is the last mirror region |
| in the set. May be on the same line or on another text line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineMirrorRegion:previousRegion:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">previousRegion</apiName><shortdesc class="- topic/shortdesc "> |
| The previous TextLineMirrorRegion in the set derived from the text element, or null if the current region is the first mirror |
| region in the set.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLineMirrorRegion</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The previous TextLineMirrorRegion in the set derived from the text element, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph> if the current region is the first mirror |
| region in the set. May be on the same line or on another text line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:TextLineMirrorRegion:textLine:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">textLine</apiName><shortdesc class="- topic/shortdesc "> |
| The TextLine containing this mirror region.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.text.engine:TextLine</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The TextLine containing this mirror region. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:LineJustification" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">LineJustification</apiName><shortdesc class="- topic/shortdesc "> |
| The LineJustification class is an enumeration of constant values used in setting the lineJustfication property |
| of the TextJustifier subclasses.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The LineJustification class is an enumeration of constant values used in setting the <codeph class="+ topic/ph pr-d/codeph ">lineJustfication</codeph> property |
| of the TextJustifier subclasses. |
| |
| </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#TextJustifier/lineJustification" class="- topic/link "><linktext class="- topic/linktext ">TextJustifier.lineJustification</linktext></link></related-links><apiValue id="flash.text.engine:LineJustification:ALL_BUT_LAST" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ALL_BUT_LAST</apiName><shortdesc class="- topic/shortdesc "> |
| Justify all but the last line.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">allButLast</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Justify all but the last line. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:LineJustification:ALL_INCLUDING_LAST" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">ALL_INCLUDING_LAST</apiName><shortdesc class="- topic/shortdesc "> |
| Justify all lines.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">allIncludingLast</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Justify all lines. |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:LineJustification:UNJUSTIFIED" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">UNJUSTIFIED</apiName><shortdesc class="- topic/shortdesc "> |
| Do not justify lines.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiData class="- topic/ph reference/ph apiRef/apiData ">unjustified</apiData><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Do not justify lines. |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.text.engine:SpaceJustifier" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">SpaceJustifier</apiName><shortdesc class="- topic/shortdesc "> |
| The SpaceJustifier class represents properties that control the justification options for text lines in a text block.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.text.engine:TextJustifier</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| The SpaceJustifier class represents properties that control the justification options for text lines in a text block. |
| |
| <p class="- topic/p "> Use the constructor <codeph class="+ topic/ph pr-d/codeph ">new SpaceJustifier()</codeph> to create a SpaceJustifier object before setting its properties. |
| Setting the properties of a SpaceJustifier object after you apply it to a TextBlock does not invalidate the TextBlock.</p> |
| |
| </apiDesc><example conref="examples\SpaceJustifierExample.as" class="- topic/example "> The following example uses letter spacing and justifies all of a block of text |
| except for the last line. |
| <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock "> |
| |
| package { |
| import flash.display.Sprite; |
| import flash.text.engine.TextBlock; |
| import flash.text.engine.TextElement; |
| import flash.text.engine.TextLine; |
| import flash.text.engine.ElementFormat; |
| import flash.text.engine.SpaceJustifier; |
| import flash.text.engine.LineJustification; |
| |
| public class SpaceJustifierExample extends Sprite { |
| |
| public function SpaceJustifierExample():void { |
| var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " + |
| "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut " + |
| "enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut " + |
| "aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit " + |
| "in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur " + |
| "sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt " + |
| "mollit anim id est laborum."; |
| |
| var format:ElementFormat = new ElementFormat(null, 12, 0xCC0000); |
| var textElement:TextElement = new TextElement(str, format); |
| var spaceJustifier:SpaceJustifier = new SpaceJustifier("en", LineJustification.ALL_BUT_LAST); |
| spaceJustifier.letterSpacing = true; |
| var textBlock:TextBlock = new TextBlock(); |
| textBlock.content = textElement; |
| textBlock.textJustifier = spaceJustifier; |
| createLines(textBlock); |
| } |
| |
| private function createLines(textBlock:TextBlock):void { |
| |
| var yPos = 20; |
| var textLine:TextLine = textBlock.createTextLine (null, 150); |
| |
| while (textLine) |
| { |
| addChild(textLine); |
| textLine.x = 15; |
| yPos += textLine.textHeight+2; |
| textLine.y = yPos; |
| textLine = textBlock.createTextLine(textLine, 150); |
| } |
| } |
| } |
| } |
| </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#LineJustification" class="- topic/link "><linktext class="- topic/linktext ">LineJustification</linktext></link><link href="flash.text.engine.xml#TextBlock/textJustifier" class="- topic/link "><linktext class="- topic/linktext ">TextBlock.textJustifier</linktext></link><link href="flash.text.engine.xml#TextJustifier" class="- topic/link "><linktext class="- topic/linktext ">TextJustifier</linktext></link></related-links><apiConstructor id="flash.text.engine:SpaceJustifier:SpaceJustifier" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">SpaceJustifier</apiName><shortdesc class="- topic/shortdesc "> |
| Creates a SpaceJustifier object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata><asCustoms class="+ topic/metadata adobe-api-d/asCustoms "><internal> |
| </internal></asCustoms></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">locale</codeph> specified is <codeph class="+ topic/ph pr-d/codeph ">null</codeph> or too short to represent a valid locale. |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">lineJustification</codeph> specified is not a member of <codeph class="+ topic/ph pr-d/codeph ">LineJustification</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">locale</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">en</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The locale to determine the justification rules. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">"en"</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">lineJustification</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">unjustified</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The type of line justification for the paragraph. |
| Use <codeph class="+ topic/ph pr-d/codeph ">LineJustification</codeph> constants for this property. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">LineJustification.UNJUSTIFIED</codeph>. |
| </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">letterSpacing</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">false</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies whether to use letter spacing during justification. |
| The default value is <codeph class="+ topic/ph pr-d/codeph ">false</codeph>. |
| </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Creates a SpaceJustifier object. The LineJustification class contains constants for specifying the types of |
| line justification that you can apply. |
| |
| </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.text.engine.xml#LineJustification" class="- topic/link "><linktext class="- topic/linktext ">LineJustification</linktext></link></related-links></apiConstructor><apiOperation id="flash.text.engine:SpaceJustifier:clone" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">clone</apiName><shortdesc class="- topic/shortdesc "> |
| Constructs a cloned copy of the SpaceJustifier.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata><asCustoms class="+ topic/metadata adobe-api-d/asCustoms "><internal>This class is currently stored as a live reference, but there is no way to track when its |
| properties change. This means that when changes are made, text blocks are not invalidated, which in |
| the current implementation can lead to player crashes. Even from the API perspective its wrong, as |
| the affected text lines should be marked INVALID when format changes are made, but they�re not. The |
| solution is to use a copy-on-set model. When the object is passed in, the player copies it, so later |
| changes to the object that was passed in have no effect. The setter makes an internal copy of the |
| array; the getter returns a copy of the internal copy. Operations like |
| myBlock.textJustifier.spaceJustifier.letterSpacing = true will have no effect. Users who subclass |
| this class in the future will need to use the clone() method to implement this technique of |
| 'locking' the format once it has been set. |
| |
| </internal></asCustoms></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiIsOverride class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiIsOverride "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A copy of the <codeph class="+ topic/ph pr-d/codeph ">SpaceJustifier</codeph> object. |
| |
| </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.text.engine:TextJustifier</apiOperationClassifier></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Constructs a cloned copy of the SpaceJustifier. |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiValue id="flash.text.engine:SpaceJustifier:letterSpacing:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">letterSpacing</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies whether to use letter spacing during justification.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies whether to use letter spacing during justification. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">false</codeph></p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:SpaceJustifier:maximumSpacing:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">maximumSpacing</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the maximum spacing (as a multiplier of the width of a normal space) between words to use during justification.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified is less than <codeph class="+ topic/ph pr-d/codeph ">optimumSpacing</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. |
| If <codeph class="+ topic/ph pr-d/codeph ">letterSpacing</codeph> is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>, letter spacing will be used after the spaces between words reach the maximum. |
| If <codeph class="+ topic/ph pr-d/codeph ">letterSpacing</codeph> is <codeph class="+ topic/ph pr-d/codeph ">false</codeph>, the spaces between words will be expanded beyond the maximum. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">1.5</codeph></p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:SpaceJustifier:minimumSpacing:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">minimumSpacing</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the minimum spacing (as a multiplier of the width of a normal space) between words to use during justification.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified is less than zero or greater than <codeph class="+ topic/ph pr-d/codeph ">optimumSpacing</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the minimum spacing (as a multiplier of the width of a normal space) between words to use during justification. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">0.5</codeph></p> |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="flash.text.engine:SpaceJustifier:optimumSpacing:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">optimumSpacing</apiName><shortdesc class="- topic/shortdesc "> |
| Specifies the optimum spacing (as a multiplier of the width of a normal space) between words to use during justification.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <codeph class="+ topic/ph pr-d/codeph ">value</codeph> specified is less than <codeph class="+ topic/ph pr-d/codeph ">minimumSpacing</codeph> or greater than <codeph class="+ topic/ph pr-d/codeph ">maximumSpacing</codeph>. |
| |
| </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc "> |
| Specifies the optimum spacing (as a multiplier of the width of a normal space) between words to use during justification. |
| |
| <p class="- topic/p ">The default value is <codeph class="+ topic/ph pr-d/codeph ">1.0</codeph></p> |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier></apiPackage> |
