Paket | flash.text |
Klass | public class TextFormat |
Arv | TextFormat Object |
Underklasser | UITextFormat |
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Du måste använda konstruktorn new TextFormat()
för att skapa ett TextFormat-objekt innan du kan ange dess egenskaper. När du använder ett TextFormat-objekt i ett textfält med egenskapen TextField.setTextFormat()
eller metoden TextField.setNewTextFormat()
tillämpas endast de definierade egenskaperna. Använd TextField.defaultTextFormat
för att använda formatering INNAN du lägger till text i TextField
och metoden setTextFormat()
för att lägga till formatering EFTER att du har lagt till text i TextField
. TextFormat-egenskaperna är null
som standard. Om du inte anger värden för egenskaperna används Flash Players standardformatering. I Flash Player används följande standardformatering för varje egenskap (om egenskapsvärdet är null
):
align = "left" |
blockIndent = 0 |
bold = false |
bullet = false |
color = 0x000000 |
font = "Times New Roman" (standardteckensnittet är Times på Mac OS X) |
indent = 0 |
italic = false |
kerning = false |
leading = 0 |
leftMargin = 0 |
letterSpacing = 0 |
rightMargin = 0 |
size = 12 |
tabStops = [] (empty array) |
target = "" (empty string) |
underline = false |
url = "" (empty string) |
Standardformateringen för varje egenskap finns också i beskrivningen för egenskaperna.
Relaterade API-element
flash.text.TextField.defaultTextFormat
flash.text.TextField.getTextFormat()
Egenskap | Definieras med | ||
---|---|---|---|
align : String
Anger styckets justering. | TextFormat | ||
blockIndent : Object
Anger blockindrag i pixlar. | TextFormat | ||
bold : Object
Anger om texten är fetstilt. | TextFormat | ||
bullet : Object
Anger att texten är del av en punktlista. | TextFormat | ||
color : Object
Anger textens färg. | TextFormat | ||
constructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans. | Object | ||
font : String
Namnet på teckensnittet för texten i detta textformat, som en sträng. | TextFormat | ||
indent : Object
Anger indraget från den vänstra marginalen till det första tecknet i stycket. | TextFormat | ||
italic : Object
Anger om texten i textformatet är kursiv. | TextFormat | ||
kerning : Object
Ett booleskt värde som anger om kerning används (true) eller inte (false). | TextFormat | ||
leading : Object
Ett heltal som representerar lodrätt utrymme i pixlar (radavstånd) mellan raderna. | TextFormat | ||
leftMargin : Object
Styckets vänstra marginal i pixlar. | TextFormat | ||
letterSpacing : Object
Ett tal som representerar mängden utrymme som är jämnt fördelat mellan alla tecken. | TextFormat | ||
rightMargin : Object
Styckets högra marginal i pixlar. | TextFormat | ||
size : Object
Pixelstorleken för text i det här textformatet. | TextFormat | ||
tabStops : Array
Anger anpassade tabbstopp som en array med positiva heltal. | TextFormat | ||
target : String
Visar målfönstret där hyperlänken visas. | TextFormat | ||
underline : Object
Anger om texten med detta textformat är understruken (true) eller inte (false). | TextFormat | ||
url : String
Anger mål-URL:en för texten i textformatet. | TextFormat |
Metod | Definieras med | ||
---|---|---|---|
TextFormat(font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)
Skapar ett TextFormat-objekt med angivna egenskaper. | TextFormat | ||
Anger om det finns en egenskap angiven för ett objekt. | Object | ||
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter. | Object | ||
Anger om den angivna egenskapen finns och är uppräkningsbar. | Object | ||
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder. | Object | ||
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner. | Object | ||
Returnerar det angivna objektets strängbeteckning. | Object | ||
Returnerar det angivna objektets primitiva värde. | Object |
align | egenskap |
align:String
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger styckets justering. Giltiga värden är TextFormatAlign-konstanter.
Standardvärdet är TextFormatAlign.LEFT.
Implementering
public function get align():String
public function set align(value:String):void
Utlöser
ArgumentError — Det angivna align är inte medlem av flash.text.TextFormatAlign.
|
Relaterade API-element
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
blockIndent | egenskap |
blockIndent:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger blockindrag i pixlar. Blockindrag används på ett helt textblock, på alla rader i texten. Normalt indrag (TextFormat.indent
) påverkar bara den första raden i varje stycke. Om egenskapen är null
anger inte TextFormat-objektet något blockindrag (blockindraget är 0).
Implementering
public function get blockIndent():Object
public function set blockIndent(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
bold | egenskap |
bold:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger om texten är fetstilt. Standardvärdet är null
vilket anger att ingen fetstil används. Om värdet är true
är texten fetstilt.
Implementering
public function get bold():Object
public function set bold(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
bullet | egenskap |
bullet:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger att texten är del av en punktlista. I en punktlista är varje textstycke indraget. Till vänster om den första raden i varje stycke visas en punktsymbol. Standardvärdet är null
vilket anger att ingen punktlista används.
Implementering
public function get bullet():Object
public function set bullet(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
color | egenskap |
color:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger textens färg. Ett tal som innehåller tre 8-bitars RGB-komponenter, till exempel är 0xFF0000 rött och 0x00FF00 grönt. Standardvärdet är null
vilket innebär att Flash Player använder svart färg (0x000000).
Implementering
public function get color():Object
public function set color(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
font | egenskap |
font:String
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Namnet på teckensnittet för texten i detta textformat, som en sträng. Standardvärdet är null
vilket innebär att Flash Player använder teckensnittet Times New Roman i texten.
Implementering
public function get font():String
public function set font(value:String):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
indent | egenskap |
indent:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger indraget från den vänstra marginalen till det första tecknet i stycket. Standardvärdet är null
vilket innebär att inget indrag används.
Implementering
public function get indent():Object
public function set indent(value:Object):void
Relaterade API-element
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
italic | egenskap |
italic:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger om texten i textformatet är kursiv. Standardvärdet är null
vilket innebär att ingen kursivering används.
Implementering
public function get italic():Object
public function set italic(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
kerning | egenskap |
kerning:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9. |
Ett booleskt värde som anger om kerning används (true
) eller inte (false
). Med kerning justeras pixlarna mellan vissa teckenpar för att underlätta läsbarheten. Det bör bara användas när det är nödvändigt, till exempel i rubriker med stora teckensnitt. Kerning kan endast användas med inbäddade teckensnitt.
Vissa teckensnitt, till exempel Verdana och teckensnitt med fast teckenbredd som Courier New, stöder inte kerning.
Standardvärdet är null
vilket innebär att kerning inte är aktiverat.
Implementering
public function get kerning():Object
public function set kerning(value:Object):void
leading | egenskap |
leading:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Ett heltal som representerar lodrätt utrymme i pixlar (radavstånd) mellan raderna. Standardvärdet är null
vilket innebär att radavståndet är 0.
Implementering
public function get leading():Object
public function set leading(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
leftMargin | egenskap |
leftMargin:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Styckets vänstra marginal i pixlar. Standardvärdet är null
vilket innebär att vänstermarginalen är 0 pixlar.
Implementering
public function get leftMargin():Object
public function set leftMargin(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
letterSpacing | egenskap |
letterSpacing:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9. |
Ett tal som representerar mängden utrymme som är jämnt fördelat mellan alla tecken. Värdet anger antalet pixlar som läggs till framflyttningen efter varje tecken. Standardvärdet är null
vilket innebär att teckenavståndet är 0 pixlar. Du kan använda decimaltal, till exempel 1.75
.
Implementering
public function get letterSpacing():Object
public function set letterSpacing(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
rightMargin | egenskap |
rightMargin:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Styckets högra marginal i pixlar. Standardvärdet är null
vilket innebär att högermarginalen är 0 pixlar.
Implementering
public function get rightMargin():Object
public function set rightMargin(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
size | egenskap |
size:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Pixelstorleken för text i det här textformatet. Standardvärdet är null
, vilket innebär att storleken är 12.
Implementering
public function get size():Object
public function set size(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
tabStops | egenskap |
tabStops:Array
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger anpassade tabbstopp som en array med positiva heltal. Alla tabbstopp anges i pixlar. Om anpassade tabbstopp inte anges (null
) är standardtabbstoppet 4 (genomsnittlig teckenbredd).
Implementering
public function get tabStops():Array
public function set tabStops(value:Array):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
target | egenskap |
target:String
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Visar målfönstret där hyperlänken visas. Om målfönstret är en tom sträng visas texten i standardmålfönstret _self
. Du kan välja ett anpassat namn eller ett av följande fyra namn: Med alternativet _self
anges den aktuella bildrutan i aktuellt fönster. _blank
anger ett nytt fönster, _parent
anger den aktuella bildrutans överordnade bildruta och _top
anger bildrutan på översta nivån i aktuellt fönster. Om TextFormat.url
-egenskapen är en tom sträng eller null
kan du hämta eller ställa in egenskapen, men den kommer inte att ha någon effekt.
Implementering
public function get target():String
public function set target(value:String):void
Relaterade API-element
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
underline | egenskap |
underline:Object
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger om texten med detta textformat är understruken (true
) eller inte (false
). Den här understrykningen liknar den som skapas av <U>
-taggen, men den senare är ingen riktig understrykning, eftersom den inte hoppar över nedstaplar på rätt sätt. Standardvärdet är null
vilket innebär att inget understrykning används.
Implementering
public function get underline():Object
public function set underline(value:Object):void
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
url | egenskap |
url:String
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Anger mål-URL:en för texten i textformatet. Om egenskapen url
är en tom sträng har texten ingen hyperlänk. Standardvärdet är null
vilket innebär att texten inte har någon hyperlänk.
Obs! Texten med det tilldelade textformatet måste anges med egenskapen htmlText
för att hyperlänken ska fungera.
Implementering
public function get url():String
public function set url(value:String):void
Relaterade API-element
Exempel
Så här använder du exemplet
Hur den här egenskapen används visas i exemplet för konstruktorn TextFormat().
TextFormat | () | Konstruktor |
public function TextFormat(font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)
Språkversion: | ActionScript 3.0 |
Körningsmiljöversioner: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Skapar ett TextFormat-objekt med angivna egenskaper. Du kan sedan ändra egenskaperna för TextFormat-objektet för att ändra textfältens formatering.
Alla parametrar kan ställas in på null
för att visa att de inte är definierade. Alla parametrar är valfria och alla parametrar som uteslutits behandlas som null
.
font:String (default = null ) — Namnet på teckensnittet för text som en sträng.
| |
size:Object (default = null ) — Ett heltal som anger storleken i pixlar.
| |
color:Object (default = null ) — Färgen på text som använder textformatet. Ett tal som innehåller tre 8-bitars RGB-komponenter, till exempel är 0xFF0000 rött och 0x00FF00 grönt.
| |
bold:Object (default = null ) — Ett booleskt värde som anger om texten är fetstilt.
| |
italic:Object (default = null ) — Ett booleskt värde som anger om texten är kursiv.
| |
underline:Object (default = null ) — Ett booleskt värde som anger om texten är understruken.
| |
url:String (default = null ) — URL-adressen som texten i textformatet hyperlänkar till. Om url är en tom sträng har texten ingen hyperlänk.
| |
target:String (default = null ) — Visar målfönstret där hyperlänken visas. Om målfönstret är en tom sträng visas texten i standardmålfönstret _self . Om url -parametern är en tom sträng eller null kan du hämta eller ställa in egenskapen, men den har ingen effekt.
| |
align:String (default = null ) — Styckets justering som TextFormatAlign-värde.
| |
leftMargin:Object (default = null ) — Visar styckets vänstra marginal i pixlar.
| |
rightMargin:Object (default = null ) — Visar styckets högra marginal i pixlar.
| |
indent:Object (default = null ) — Ett heltal som anger indraget från den vänstra marginalen till det första tecknet i stycket.
| |
leading:Object (default = null ) — Ett tal som anger mängden vågrätt radavstånd.
|
Exempel ( Så här använder du exemplet )
I textfältet formatTextField
listas alla egenskapsalternativ i klassen TextField (med undantag för kerning
) på en separat rad. När användaren klickar på en rad i textfältet formatTextField
anropas metoden formatTextFieldClickHandler()
.
Metoden formatTextFieldClickHandler()
anropar metoden TextField.getLineIndexAtPoint()
för att hämta indexvärdet för raden användaren klickade på. Sedan anropas metoden TextField.getLineText()
för att hämta radens innehåll. Switch-satsen kontrollerar radens innehåll och anger en egenskap i TextFormat-objektet newformat
därefter. Metoden setTextFormat()
ställer sedan in textformatet för textfältet contentTextField()
på det nya formatet. Genom att klicka på olika rader i formatTextField
kan användaren tillämpa olika formateringar i textfältet contentTextField
. (Tabbinställningen är en array som definierar olika tabbstopp för varje tabb på raden.) Om raden url
eller target
markeras måste användaren klicka i textfältet contentTextField
för att aktivera länken och visa innehållet i mål-URL:en (startsidan för Flex). Standardvärdet för egenskapen target
är "_self", vilket innebär att innehållet visas i det aktuella fönstret om användaren markerar raden url
. För att egenskapen target
ska fungera måste en URL redan ha angetts i egenskapen url
.
Om en användare klickar i textfältet contentTextField
aktiveras metoden contentTextFieldClickHandler()
. Metoden anger fältets format och formatet för TextFormat-objektet newFormat
till standardformatet för textfältet. Detta raderar alla formateringsändringar som användaren har gjort.
package { import flash.display.Sprite; import flash.text.TextField; import flash.text.TextFormat; import flash.text.TextFieldAutoSize; import flash.events.MouseEvent; import flash.text.TextFormatAlign; public class TextFormat_constructorExample extends Sprite { private var contentTextField:TextField = new TextField(); private var formatTextField:TextField = new TextField(); private var newFormat:TextFormat = new TextFormat(); public function TextFormat_constructorExample() { contentTextField.x = 10; contentTextField.y = 10; contentTextField.background = true; contentTextField.border = true; contentTextField.multiline = true; contentTextField.wordWrap = true; contentTextField.selectable = false; contentTextField.width = 250; contentTextField.height = 120; contentTextField.htmlText = "<p>The TextFormat class represents character formatting " + "information. Use the TextFormat class to create specific text formatting " + "for text fields." + " </p><br>" + "\tTab One" + "\tTab Two<br>"; formatTextField.x = 10; formatTextField.y = 140; formatTextField.background = true; formatTextField.border = true; formatTextField.autoSize = TextFieldAutoSize.LEFT; formatTextField.text = "align: right\n" + "blockIndent: 10 pixels\n" + "bold:\n" + "bullet:\n" + "color: red\n" + "font: Arial\n" + "indent: 20 pixels\n" + "italic:\n" + "leading: 5 spaces\n" + "leftMargin: 20 pixels\n" + "letterSpacing: 4 pixels\n" + "rightMargin: 20 pixels\n" + "size: 16 point\n" + "target: new window\n" + "tabStops: 50 and 150 pixel\n" + "underline:\n" + "url: Adobe Flex page\n"; formatTextField.addEventListener(MouseEvent.CLICK, formatTextFieldClickHandler); contentTextField.addEventListener(MouseEvent.CLICK, contentTextFieldClickHandler); this.addChild(contentTextField); this.addChild(formatTextField); } private function formatTextFieldClickHandler(e:MouseEvent):void { var value:String= ""; var i:uint = 0; var index:int = formatTextField.getLineIndexAtPoint(e.localX, e.localY); var line:String = formatTextField.getLineText(index);; line = line.substr(0, (line.indexOf(":"))); switch(line) { case "align": newFormat.align = TextFormatAlign.RIGHT; break; case "blockIndent": newFormat.blockIndent = 10; break; case "bold": newFormat.bold = true; break; case "bullet": newFormat.bullet = true; break; case "color": newFormat.color = 0xFF0000; break; case "font": newFormat.font = "Arial"; break; case "indent": newFormat.indent = 20; break; case "italic": newFormat.italic = true; break; case "leading": newFormat.leading = 5; break; case "leftMargin": newFormat.leftMargin = 20; break; case "letterSpacing": newFormat.letterSpacing = 4; break; case "rightMargin": newFormat.rightMargin = 20; break; case "size": newFormat.size = 16; break; case "tabStops": newFormat.tabStops = [50, 150]; break; case "target": newFormat.url = "http://www.adobe.com/products/flex/"; newFormat.target = "_blank"; break; case "underline": newFormat.underline = true; break; case "url": newFormat.url = "http://www.adobe.com/products/flex/"; break; } contentTextField.setTextFormat(newFormat); } private function contentTextFieldClickHandler(e:MouseEvent):void { contentTextField.setTextFormat(contentTextField.defaultTextFormat); newFormat = contentTextField.defaultTextFormat; } } }
- En
label
-egenskap av typen TextField skapas. - Klasskonstruktorn anropar funktionen
configureLabel()
. - Metoden
configureLabel()
skapar först ett nytt TextField-objekt och kopplar det till egenskapenlabel
och ställer sedan in sina parametrar på- Vänsterjustera textfältet
- Aktivera bakgrundsfyllningen
- Aktivera kantlinjen.
- Metoden
configureLabel()
skapar den lokala variabelnformat
och kopplar den till en ny TextFormat-instans med parametrarna inställda på:- Font type = Verdana
- Font Color = solid red
- Font size = 10
- Font underline = true.
- Egenskapen
defaultTextFormat
ställs in påformat
ochlabel
-instansen läggs till i visningslistan som först visar ett textfält utan text (som en liten ruta med vit bakgrund) på scenen. - Slutligen (tillbaka i konstruktorn) anges etikettexten till "Hello World and welcome to the show", vid koordinaterna x = 0, y = 0 genom anrop till
setLabel()
.
package { import flash.display.Sprite; import flash.text.TextField; import flash.text.TextFieldAutoSize; import flash.text.TextFormat; public class TextFormatExample extends Sprite { private var label:TextField; public function TextFormatExample() { configureLabel(); setLabel("Hello World and welcome to the show"); } public function setLabel(str:String):void { label.text = str; } private function configureLabel():void { label = new TextField(); label.autoSize = TextFieldAutoSize.LEFT; label.background = true; label.border = true; var format:TextFormat = new TextFormat(); format.font = "Verdana"; format.color = 0xFF0000; format.size = 10; format.underline = true; label.defaultTextFormat = format; addChild(label); } } }
Tue Jun 12 2018, 01:40 PM Z