Referencia de ActionScript® 3.0 para la plataforma de Adobe® Flash®
Inicio  |  Ocultar lista de paquetes y clases |  Paquetes  |  Clases  |  Novedades  |  Índice  |  Apéndices  |  ¿Por qué hay texto en inglés?
Filtros: AIR 30.0 y versiones anteriores, Flash Player 30.0 y versiones anteriores, Flash Lite 4
Flex 4.6 y versiones anteriores, Flash Pro CS6 y versiones anteriores
Ocultar filtros
flashx.textLayout.formats 

TabStopFormat  - AS3

Paqueteflashx.textLayout.formats
Clasepublic class TabStopFormat
HerenciaTabStopFormat Inheritance Object
Implementa ITabStopFormat

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

La clase TabStopFormat representa las propiedades de un tabulador en un párrafo. Puede establecer la propiedad TextLayoutFormat.tabstops como un conjunto de objeto TabStopFormat.

Ver los ejemplos

Elementos de API relacionados



Propiedades públicas
 PropiedadDefinido por
  alignment : *
Alineación de tabulación de la tabulación.
TabStopFormat
 Inheritedconstructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.
Object
  decimalAlignmentToken : *
El símbolo de alineación que se utiliza si alignment es DECIMAL.
TabStopFormat
  defaultFormat : flashx.textLayout.formats:ITabStopFormat
[estática] [solo lectura] Devuelve un objeto TabStopFormat con configuración predeterminada.
TabStopFormat
  position : *
La posición de la tabulación, en píxeles, con relación al inicio del borde de la columna.
TabStopFormat
Métodos públicos
 MétodoDefinido por
  
Crea un nuevo objeto TabStopFormat.
TabStopFormat
  
Sustituye valores de propiedad en este objeto TabStopFormat por los valores de propiedades que se establecen en la instancia incoming de ITabStopFormat.
TabStopFormat
  
Concatena los valores de las propiedades en la instancia incoming de ITabStopFormat con los valores de este objeto TabStopFormat.
TabStopFormat
  
Concatena los valores de las propiedades en la instancia incoming de ITabStopFormat con los valores de este objeto TabStopFormat.
TabStopFormat
  
Copia la configuración de TabStopFormat desde la instancia values de TabStopFormat a este objeto TabStopFormat.
TabStopFormat
  
getStyle(styleName:String):*
Devuelve el valor del estilo especificado por el parámetro styleProp que especifica el nombre del estilo.
TabStopFormat
 Inherited
Indica si un objeto tiene definida una propiedad especificada.
Object
  
[estática] Compara las propiedades de la instancia p1 de ITabStopFormat con las propiedades de la instancia p2 de ITabStopFormat y devuelve true si todas coinciden.
TabStopFormat
 Inherited
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.
Object
 Inherited
Indica si existe la propiedad especificada y si es enumerable.
Object
  
Establece las propiedades de este objeto TabStopFormat como undefined si no coinciden con las de la instancia incoming de ITabStopFormat.
TabStopFormat
  
Establece las propiedades de este objeto TabStopFormat como undefined si coinciden con las de la instancia incoming de ITabStopFormat.
TabStopFormat
 Inherited
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.
Object
  
setStyle(styleName:String, value:*):void
Establece el valor del estilo especificado por el parámetro styleProp que especifica el nombre del estilo en value.
TabStopFormat
 Inherited
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.
Object
 Inherited
Devuelve la representación de cadena del objeto especificado.
Object
 Inherited
Devuelve el valor simple del objeto especificado.
Object
Información sobre propiedades

alignment

propiedad
alignment:*

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Alineación de tabulación de la tabulación.

Los valores aceptados son TabAlignment.START, TabAlignment.CENTER, TabAlignment.END, TabAlignment.DECIMAL, FormatValue.INHERIT.

El valor predeterminado es undefined e indica que no está definido.

Si los valores son undefined durante el proceso, esta propiedad tendrá un valor de TabAlignment.START.



Implementación
    public function get alignment():*
    public function set alignment(value:any):void

Emite
RangeError — Cuando el valor establecido no está dentro del rango de esta propiedad

Elementos de API relacionados

decimalAlignmentToken

propiedad 
decimalAlignmentToken:*

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

El símbolo de alineación que se utiliza si alignment es DECIMAL.

El valor predeterminado es undefined e indica que no está definido.

Si es undefined durante el proceso esta propiedad tendrá siempre un valor de null.



Implementación
    public function get decimalAlignmentToken():*
    public function set decimalAlignmentToken(value:any):void

Emite
RangeError — Cuando el valor establecido no está dentro del rango de esta propiedad

defaultFormat

propiedad 
defaultFormat:flashx.textLayout.formats:ITabStopFormat  [solo lectura]

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Devuelve un objeto TabStopFormat con configuración predeterminada. Esta función siempre devuelve el mismo objeto.



Implementación
    public static function get defaultFormat():flashx.textLayout.formats:ITabStopFormat

position

propiedad 
position:*

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

La posición de la tabulación, en píxeles, con relación al inicio del borde de la columna.

Los valores aceptados oscilan entre 0 y 10.000 y FormatValue.INHERIT.

El valor predeterminado es undefined e indica que no está definido.

Si los valores son undefined durante el proceso, esta propiedad tendrá un valor de 0.



Implementación
    public function get position():*
    public function set position(value:any):void

Emite
RangeError — Cuando el valor establecido no está dentro del rango de esta propiedad

Elementos de API relacionados

Información sobre constructores

TabStopFormat

()Información sobre
public function TabStopFormat(initialValues:flashx.textLayout.formats:ITabStopFormat = null)

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Crea un nuevo objeto TabStopFormat. Todas las configuraciones están vacías o, de forma opcional, se inicializan desde el objeto initialValues suministrado.

Parámetros
initialValues:flashx.textLayout.formats:ITabStopFormat (default = null) — instancia opcional desde la que se copian los valores iniciales.

Elementos de API relacionados

Información sobre métodos

apply

()método
public function apply(incoming:flashx.textLayout.formats:ITabStopFormat):void

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Sustituye valores de propiedad en este objeto TabStopFormat por los valores de propiedades que se establecen en la instancia entrante de ITabStopFormat. Las propiedades undefined en la instancia incoming de ITabStopFormat no se cambian en este objeto.

Parámetros

incoming:flashx.textLayout.formats:ITabStopFormat — instancia cuyos valores de propiedades se aplican a este objeto TabStopFormat.

concat

()método 
public function concat(incoming:flashx.textLayout.formats:ITabStopFormat):void

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Concatena los valores de las propiedades en la instancia incoming de ITabStopFormat con los valores de este objeto TabStopFormat. En este objeto TabStopFormat (el receptor), las propiedades cuyos valores son FormatValue.INHERIT y heredan las propiedades cuyos valores son undefined producirán nuevos valores desde el objeto incoming. Las propiedades no heredadas cuyos valores son undefined recibirán sus valores predeterminados. Todos los demás valores de propiedades permanecerán sin cambios.

Parámetros

incoming:flashx.textLayout.formats:ITabStopFormat — instancia desde la que se concatenan los valores.

Elementos de API relacionados

concatInheritOnly

()método 
public function concatInheritOnly(incoming:flashx.textLayout.formats:ITabStopFormat):void

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Concatena los valores de las propiedades en la instancia incoming de ITabStopFormat con los valores de este objeto TabStopFormat. En este objeto TabStopFormat (el receptor), las propiedades cuyos valores son FormatValue.INHERIT y heredan las propiedades cuyos valores son undefined producirán nuevos valores desde el objeto incoming. Todos los demás valores de propiedades permanecerán sin cambios.

Parámetros

incoming:flashx.textLayout.formats:ITabStopFormat — instancia desde la que se concatenan los valores.

Elementos de API relacionados

copy

()método 
public function copy(values:flashx.textLayout.formats:ITabStopFormat):void

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Copia la configuración de TabStopFormat desde la instancia values de ITabStopFormat a este objeto TabStopFormat. Si values es null, este objeto TabStopFormat se inicializa con valores undefined para todas las propiedades.

Parámetros

values:flashx.textLayout.formats:ITabStopFormat — instancia opcional desde la que se copian los valores.

getStyle

()método 
public function getStyle(styleName:String):*

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Devuelve el valor del estilo especificado por el parámetro styleProp que especifica el nombre del estilo.

Parámetros

styleName:String — El nombre del estilo cuyo valor se va a recuperar.

Valor devuelto
* — El valor del estilo especificado. El tipo varía en función del tipo de estilo al que se accede. Devuelve undefined si no se establece el estilo.

isEqual

()método 
public static function isEqual(p1:flashx.textLayout.formats:ITabStopFormat, p2:flashx.textLayout.formats:ITabStopFormat):Boolean

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Compara las propiedades de la instancia p1 de ITabStopFormat con las propiedades de la instancia p2 de ITabStopFormat y devuelve true si todas coinciden.

Parámetros

p1:flashx.textLayout.formats:ITabStopFormat — instancia para comparar con p2.
 
p2:flashx.textLayout.formats:ITabStopFormat — instancia para comparar con p1.

Valor devuelto
Boolean — true si todas las propiedades coinciden; false en caso contrario.

removeClashing

()método 
public function removeClashing(incoming:flashx.textLayout.formats:ITabStopFormat):void

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Establece las propiedades de este objeto TabStopFormat como undefined si no coinciden con las de la instancia incoming de ITabStopFormat.

Parámetros

incoming:flashx.textLayout.formats:ITabStopFormat — instancia con la que se comparan estos valores de la propiedad de este objeto TabStopFormat.

removeMatching

()método 
public function removeMatching(incoming:flashx.textLayout.formats:ITabStopFormat):void

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Establece las propiedades de este objeto TabStopFormat como undefined si coinciden con las de la instancia incoming de ITabStopFormat.

Parámetros

incoming:flashx.textLayout.formats:ITabStopFormat — instancia con la que se comparan estos valores de la propiedad de este objeto TabStopFormat.

setStyle

()método 
public function setStyle(styleName:String, value:*):void

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Establece el valor del estilo especificado por el parámetro styleProp que especifica el nombre del estilo en value.

Parámetros

styleName:String — El nombre del estilo cuyo valor se va a definir.
 
value:* — El valor para configurar.

TabStopFormat_example.as

Este ejemplo crea un párrafo que utiliza un conjunto con tres tabulaciones: una tabulación alineada a la izquierda a 50 píxeles, una alineada al centro a 150 píxeles y una alineada a la derecha a 250 píxeles.
package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flash.text.engine.TabAlignment;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.compose.StandardFlowComposer;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TabStopFormat;
    import flashx.textLayout.formats.TextLayoutFormat;

    public class TabStopFormat_example extends Sprite
    {
        public function TabStopFormat_example()
        {
            var firstContainer:Sprite = new Sprite();
            this.stage.addChild( firstContainer );
            var textFlow:TextFlow = new TextFlow();
            var format:TextLayoutFormat = new TextLayoutFormat();
            var tabStop1:TabStopFormat = new TabStopFormat();
            var tabStop2:TabStopFormat = new TabStopFormat();
            var tabStop3:TabStopFormat = new TabStopFormat();
            tabStop1.alignment = flash.text.engine.TabAlignment.START;
            tabStop1.position = 50;
            tabStop2.alignment = flash.text.engine.TabAlignment.CENTER;
            tabStop2.position = 150;
            tabStop3.alignment = flash.text.engine.TabAlignment.END;
            tabStop3.position = 250;
            format.tabStops = new Array(tabStop1,tabStop2,tabStop3);
            textFlow.hostFormat = format;
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            span.text = "1\txxx\txxx\txxx\n2\tyyyyyy\tyyyyyy<\tyyyyyy\n3\tzz\tzz\tzz";
            p.addChild(span);
            textFlow.addChild(p);
            textFlow.flowComposer = new StandardFlowComposer();
            var firstController:ContainerController = new ContainerController(firstContainer, 300, 100 );
            textFlow.flowComposer.addController(firstController);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }        
}




[ X ]¿Por qué hay texto en inglés?
Cierto contenido de la Referencia de ActionScript 3.0 se muestra en inglés

No todo el contenido de la Referencia de ActionScript 3.0 se traduce a todos los idiomas. Si un elemento del lenguaje no se traduce, aparecerá en inglés. Por ejemplo, la clase ga.controls.HelpBox no está traducida en ningún idioma. Por lo tanto, en la versión en español de la referencia, la clase ga.controls.HelpBox aparecerá en inglés.