| Paquete | flash.text |
| Clase | public class TextFormat |
| Herencia | TextFormat Object |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9 |
Debe utilizar el constructor new TextFormat() para crear un objeto TextFormat antes de establecer sus propiedades. Las propiedades de TextFormat son null de forma predeterminada, ya que, si no se proporcionan valores para ellas, Flash Player utiliza su propio formato predeterminado. El formato predeterminado que utiliza Flash Player para cada propiedad (si el valor de la propiedad es null) es el siguiente:
| align = "left" |
| blockIndent = 0 |
| bold = false |
| bullet = false |
| color = 0x000000 |
| font = "Times New Roman" (la fuente predeterminada es Times en Mac OS X) |
| indent = 0 |
| italic = false |
| kerning = false |
| leading = 0 |
| leftMargin = 0 |
| letterSpacing = 0 |
| rightMargin = 0 |
| size = 12 |
| tabStops = [] (matriz vacía) |
| target = "" (cadena vacía) |
| underline = false |
| url = "" (cadena vacía) |
El formato predeterminado de cada propiedad también se describe en la información correspondiente de cada propiedad.
Véase también
| Propiedad | Definido por | ||
|---|---|---|---|
| align : String
Indica la alineación del párrafo.
| TextFormat | ||
| blockIndent : Object
Indica la sangría de bloque, expresada en píxeles.
| TextFormat | ||
| bold : Object
Especifica si el texto está en negrita.
| TextFormat | ||
| bullet : Object
Indica que el texto forma parte de una lista con viñetas.
| TextFormat | ||
| color : Object
Indica el color del texto.
| TextFormat | ||
![]() | constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.
| Object | |
| font : String
El nombre de la fuente del texto con este formato, expresado como una cadena.
| TextFormat | ||
| indent : Object
Indica la sangría desde el margen izquierdo hasta el primer carácter del párrafo.
| TextFormat | ||
| italic : Object
Indica si el texto de este formato está en cursiva.
| TextFormat | ||
| kerning : Object
Un valor booleano que indica si el kerning está activado (true) o desactivado (false).
| TextFormat | ||
| leading : Object
Un entero que representa la cantidad de espacio vertical entre líneas (denominado interlineado).
| TextFormat | ||
| leftMargin : Object
El margen izquierdo del párrafo, expresado en píxeles.
| TextFormat | ||
| letterSpacing : Object
Un número que representa la cantidad de espacio distribuido uniformemente entre todos los caracteres.
| TextFormat | ||
![]() | prototype : Object
[static]
Una referencia al objeto prototipo de una clase u objeto de función.
| Object | |
| rightMargin : Object
El margen derecho del párrafo, expresado en píxeles.
| TextFormat | ||
| size : Object
El tamaño en puntos del texto con este formato de texto.
| TextFormat | ||
| tabStops : Array
Especifica las tabulaciones personalizadas como una matriz de enteros no negativos.
| TextFormat | ||
| target : String
Indica la ventana de destino en la que se muestra el hipervínculo.
| TextFormat | ||
| underline : Object
Indica si el texto que utiliza este formato de texto está subrayado (true) o no (false).
| TextFormat | ||
| url : String
Indica la URL de destino para el texto en este formato de texto.
| TextFormat | ||
| Método | Definido por | ||
|---|---|---|---|
|
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)
Crea un objeto TextFormat con las propiedades especificadas.
| TextFormat | ||
![]() |
Indica si un objeto tiene definida una propiedad especificada.
| Object | |
![]() |
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.
| Object | |
![]() |
Indica si existe la propiedad especificada y si es enumerable.
| Object | |
![]() |
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.
| Object | |
![]() |
Devuelve la representación de cadena del objeto especificado.
| Object | |
![]() |
Devuelve el valor simple del objeto especificado.
| Object | |
| align | propiedad |
align:String [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica la alineación del párrafo. Los valores válidos son constantes TextFormatAlign:
El valor predeterminado es TextFormatAlign.LEFT.
public function get align():String
public function set align(value:String):void
ArgumentError — La cadena align especificada no es un miembro de flash.text.TextFormatAlign.
|
Véase también
| blockIndent | propiedad |
blockIndent:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica la sangría de bloque, expresada en píxeles. La sangría de bloque se aplica a un bloque de texto completo; es decir, a todas las líneas del texto. Por el contrario, la sangría normal (TextFormat.indent) sólo afecta a la primera línea de cada párrafo. Si esta propiedad tiene el valor null, el objeto TextFormat no especifica la sangría de bloque (que es 0).
public function get blockIndent():Object
public function set blockIndent(value:Object):void
| bold | propiedad |
bold:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Especifica si el texto está en negrita. El valor predeterminado es null, lo que indica que no se utiliza la negrita. Si el valor es true, el texto está en negrita.
public function get bold():Object
public function set bold(value:Object):void
| bullet | propiedad |
bullet:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica que el texto forma parte de una lista con viñetas. En una lista con viñetas, todos los párrafos de texto están sangrados. A la izquierda de la primera línea de cada párrafo se muestra un símbolo de viñeta. El valor predeterminado es null, lo que indica que no se utiliza ninguna lista con viñetas.
public function get bullet():Object
public function set bullet(value:Object):void
| color | propiedad |
color:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica el color del texto. Número que contiene tres componentes RGB de 8 bits; por ejemplo, 0xFF0000 es rojo y 0x00FF00, verde. El valor predeterminado es null, lo que indica que Flash Player utiliza el color negro (0x000000).
public function get color():Object
public function set color(value:Object):void
| font | propiedad |
font:String [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
El nombre de la fuente del texto con este formato, expresado como una cadena. El valor predeterminado es null, lo que indica que Flash Player utiliza la fuente Times New Roman para el texto.
public function get font():String
public function set font(value:String):void
| indent | propiedad |
indent:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica la sangría desde el margen izquierdo hasta el primer carácter del párrafo. El valor predeterminado es null, que indica que no se utiliza ninguna sangría.
public function get indent():Object
public function set indent(value:Object):void
Véase también
| italic | propiedad |
italic:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica si el texto de este formato está en cursiva. El valor predeterminado es null, lo que indica que no se utiliza la cursiva.
public function get italic():Object
public function set italic(value:Object):void
| kerning | propiedad |
kerning:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Un valor booleano que indica si el ajuste de caracteres está activado (true) o desactivado (false). El kerning ajusta los píxeles entre determinadas parejas de caracteres para que puedan leerse mejor. Sólo debe utilizarse cuando sea necesario, por ejemplo, en los encabezados con fuentes grandes. El kerning sólo se admite en las fuentes incorporadas.
Determinadas fuentes, como Verdana y las fuentes con espacio fijo (como Courier New), no admiten el kerning.
El valor predeterminado es null, que indica que el kerning está desactivado.
public function get kerning():Object
public function set kerning(value:Object):void
| leading | propiedad |
leading:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Un entero que representa la cantidad de espacio vertical entre líneas (denominado interlineado). El valor predeterminado es null, lo que indica que el interlineado utilizado es 0.
public function get leading():Object
public function set leading(value:Object):void
| leftMargin | propiedad |
leftMargin:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
El margen izquierdo del párrafo, expresado en píxeles. El valor predeterminado es null, lo que indica que el margen izquierdo es de 0 píxeles.
public function get leftMargin():Object
public function set leftMargin(value:Object):void
| letterSpacing | propiedad |
letterSpacing:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Un número que representa la cantidad de espacio distribuido uniformemente entre todos los caracteres. El valor especifica el número de píxeles que se añaden después de cada carácter durante el avance. El valor predeterminado es null, lo que indica que se utilizan 0 píxeles para el espaciado entre caracteres. Puede utilizar valores decimales como 1.75.
public function get letterSpacing():Object
public function set letterSpacing(value:Object):void
| rightMargin | propiedad |
rightMargin:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
El margen derecho del párrafo, expresado en píxeles. El valor predeterminado es null, lo que indica que el margen derecho es de 0 píxeles.
public function get rightMargin():Object
public function set rightMargin(value:Object):void
| size | propiedad |
size:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
El tamaño en puntos del texto con este formato de texto. El valor predeterminado es null, lo que indica que el tamaño en puntos utilizado es 12.
public function get size():Object
public function set size(value:Object):void
| tabStops | propiedad |
tabStops:Array [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Especifica las tabulaciones personalizadas como una matriz de enteros no negativos. Cada tabulación se especifica en píxeles. Si no se han especificado tabulaciones personalizadas (null), la tabulación predeterminada es 4 (la anchura media de los caracteres).
public function get tabStops():Array
public function set tabStops(value:Array):void
| target | propiedad |
target:String [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica la ventana de destino en la que se muestra el hipervínculo. Si la ventana de destino es una cadena vacía, el texto se muestra en la ventana de destino predeterminada, _self. Puede elegir un nombre personalizado o uno de los cuatro nombres siguientes: La opción _self especifica el marco actual de la ventana actual, _blank especifica una ventana nueva, _parent especifica el nivel superior del marco actual y _top el marco del nivel más alto de la ventana actual. Si la propiedad TextFormat.url es una cadena vacía o tiene el valor null, puede obtener o definir esta propiedad, pero ésta no tendrá ningún efecto.
public function get target():String
public function set target(value:String):void
Véase también
| underline | propiedad |
underline:Object [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica si el texto que utiliza este formato de texto está subrayado (true) o no (false). Este subrayado es similar al que se obtiene mediante la etiqueta <U>, aunque ésta última no es un subrayado real, ya que no omite los trazos descendentes correctamente. El valor predeterminado es null, que indica que no se utiliza ningún subrayado.
public function get underline():Object
public function set underline(value:Object):void
| url | propiedad |
url:String [read-write]
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Indica la URL de destino para el texto en este formato de texto. Si la propiedad url es una cadena vacía, el texto no tiene hipervínculo. El valor predeterminado es null, lo que indica que el texto no tiene hipervínculo.
Nota: el texto con el formato de texto asignado debe definirse con la propiedad htmlText para que funcione el hipervínculo.
public function get url():String
public function set url(value:String):void
Véase también
| TextFormat | () | constructor |
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)
| Versión del lenguaje: | ActionScript 3.0 |
| Versión del reproductor: | Flash Player 9. |
Crea un objeto TextFormat con las propiedades especificadas. Puede cambiar las propiedades del objeto TextFormat para cambiar el formato de los campos de texto.
Cualquier parámetro puede establecerse en null para indicar que no está definido. Todos los parámetros son opcionales; se considerará que los parámetros que se omitan tienen el valor null.
font:String (default = null) — El nombre de una fuente de texto como cadena.
|
|
size:Object (default = null) — Un entero que indica el tamaño en puntos.
|
|
color:Object (default = null) — El color del texto que utiliza este formato de texto. Número que contiene tres componentes RGB de 8 bits; por ejemplo, 0xFF0000 es rojo y 0x00FF00, verde.
|
|
bold:Object (default = null) — Un valor booleano que especifica si el texto está en negrita.
|
|
italic:Object (default = null) — Un valor booleano que especifica si el texto está en cursiva.
|
|
underline:Object (default = null) — Un valor booleano que especifica si el texto está subrayado.
|
|
url:String (default = null) — La URL con la que está vinculado el texto con este formato de texto. Si url es una cadena vacía, el texto no tiene hipervínculo.
|
|
target:String (default = null) — La ventana de destino en la que se muestra el hipervínculo. Si la ventana de destino es una cadena vacía, el texto se muestra en la ventana de destino predeterminada, _self. Si el parámetro url se define como una cadena vacía o en el valor null, puede obtener o establecer esta propiedad, pero ésta no tendrá ningún efecto.
|
|
align:String (default = null) — La alineación del párrafo, como un valor TextFormatAlign.
|
|
leftMargin:Object (default = null) — Indica el margen izquierdo del párrafo, expresado en píxeles.
|
|
rightMargin:Object (default = null) — Indica el margen derecho del párrafo, expresado en píxeles.
|
|
indent:Object (default = null) — Un entero que indica la sangría desde el margen izquierdo hasta el primer carácter del párrafo.
|
|
leading:Object (default = null) — Un número que indica la cantidad de espacio vertical entre las líneas (interlineado).
|
El campo de texto formatTextField enumera todas las opciones de propiedades de la clase TextField (con la excepción de kerning) en otra línea distinta. Cuando el usuario hace clic en alguna línea del campo de texto formatTextField, se activa el método formatTextFieldClickHandler().
El método formatTextFieldClickHandler() llama al método TextField.getLineIndexAtPoint() para obtener el índice de la línea seleccionada y llama después al método TextField.getLineText() para obtener el contenido de la línea. La sentencia switch comprueba a continuación el contenido de la línea y establece en consecuencia una propiedad del objeto TextFormat newformat. El método setTextFormat() establece después el formato de texto del campo de texto contentTextField con el nuevo formato. Al hacer clic en diferentes líneas formatTextField, los usuarios pueden aplicar una serie de diferentes formatos al campo de texto contentTextField. (Tenga en cuenta que el valor de tabulación es una matriz que define una tabulación independiente por cada tabulación de la línea. Si se selecciona la línea url o target, el usuario debe hacer clic en el campo de texto contentTextField para activar el vínculo y que se muestre el contenido de la URL (página de inicio de flex) de destino. El valor predeterminado de la propiedad target es "_self", lo que significa que el contenido se mostrará en la ventana actual si el usuario selecciona la línea url. Para que funcione la propiedad target, es necesario que esté establecida una URL en la propiedad url.
Si el usuario hace clic en el campo de texto contentTextField, se activa el método contentTextFieldClickHandler(), que establece el formato del campo así como el objeto TextFormat newFormat con el formato de campo de texto predeterminado (original). Esto borrará todos los cambios de formato que el usuario haya realizado.
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;
}
}
}
label de tipo TextField.configureLabel().configureLabel() crea primero un nuevo objeto TextField y lo asigna a la propiedad label; a continuación, establece sus parámetros del modo siguiente:
configureLable() crea la variable local format y la asigna a una nueva instancia de TextFormat con los parámetros establecidos del siguiente modo:
defaultTextFormat de la etiqueta se define como format y la instancia label se añade a la lista de visualización, que muestra inicialmente un campo de texto sin texto (un cuadro diminuto con un fondo blanco) en el escenario.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);
}
}
}
Enviarme un mensaje de correo electrónico cuando se añadan comentarios a esta página | Informe de comentarios
Página actual: http://livedocs.adobe.com/flash/9.0_es/ActionScriptLangRefV3/flash/text/TextFormat.html