Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
flashx.textLayout.compose 

TextFlowLine  - AS3

Pacoteflashx.textLayout.compose
Classepublic final class TextFlowLine
HerançaTextFlowLine Inheritance Object
Implementações IVerticalJustificationLine

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A classe TextFlowLine representa uma única linha de texto de um fluxo de texto.

Use esta classe para acessar informações sobre como uma linha de texto foi composta: sua posição, altura, largura, etc. Quando o fluxo de texto (TextFlow) for modificado, as linhas que estiverem imediatamente antes do local da modificação e nesse local serão marcadas como inválidas porque precisam ser recompostas. É possível que as linhas que estiverem depois do local da modificação não sejam danificadas imediatamente, mas elas podem ser regeneradas depois que o texto for composto. Você pode acessar uma TextFlowLine que foi danificada, mas todos os valores que você acessar refletirão o estado antigo do TextFlow. Quando o TextFlow for recomposto, ele gerará novas linhas e você poderá ler a nova linha de uma determinada posição ao chamar TextFlow.flowComposer.findLineAtPosition().



Propriedades públicas
 PropriedadeDefinido por
  absoluteStart : int
[somente leitura] A localização de uma linha como a posição absoluta de um caractere no objeto TextFlow.
TextFlowLine
  ascent : Number
[somente leitura] Especifica o número de pixels da linha de base até a parte superior dos caracteres mais altos da linha.
TextFlowLine
  columnIndex : int
[somente leitura] O número da coluna na qual a linha foi colocada, sendo a primeira coluna igual a 0.
TextFlowLine
 Inheritedconstructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.
Object
  controller : ContainerController
[somente leitura] O controlador (objeto ContainerController) do contêiner no qual a linha foi colocada.
TextFlowLine
  descent : Number
[somente leitura] Especifica o número de pixels da linha de base até a parte inferior dos caracteres mais baixos da linha.
TextFlowLine
  height : Number
[somente leitura] Altura da linha, em pixels.
TextFlowLine
  lineOffset : Number
[somente leitura] O deslocamento da linha, em pixels, do início apropriado do contêiner (conforme definido pela direção do parágrafo e a progressão do bloco do contêiner), antes do alinhamento das linhas do parágrafo.
TextFlowLine
  location : int
[somente leitura] Um dos valores de TextFlowLineLocation para especificar a localização de uma linha dentro de um parágrafo.
TextFlowLine
  paragraph : ParagraphElement
[somente leitura] O parágrafo (ParagraphElement) no qual a linha reside.
TextFlowLine
  spaceAfter : Number
[somente leitura] A quantidade de espaço a ser deixado após a linha.
TextFlowLine
  spaceBefore : Number
[somente leitura] A quantidade de espaço a ser deixado antes da linha.
TextFlowLine
  textHeight : Number
[somente leitura] A altura da linha de texto, que é igual à subida + descida.
TextFlowLine
  textLength : int
[somente leitura] O número de caracteres até a próxima linha, inclusive os espaços à esquerda.
TextFlowLine
  textLineExists : Boolean
[somente leitura] Indica se o objeto flash.text.engine.TextLine desta TextFlowLine existe.
TextFlowLine
  unjustifiedTextWidth : Number
[somente leitura] A largura da linha, caso não esteja justificada.
TextFlowLine
  validity : String
[somente leitura] A validade da linha.
TextFlowLine
  x : Number
A posição horizontal da linha em relação ao seu container, expresso como o deslocamento em pixels da esquerda do container.
TextFlowLine
  y : Number
A posição vertical da linha em relação ao seu container, expresso como o deslocamento em pixels da parte superior do container.
TextFlowLine
Métodos públicos
 MétodoDefinido por
  
TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0)
Construtor - cria uma nova instância de TextFlowLine.
TextFlowLine
  
Gera os limites da linha como um retângulo.
TextFlowLine
  
Gera o objeto flash.text.engine.TextLine desta linha, que pode ser recriado se não existir devido à coleta de lixo.
TextFlowLine
 Inherited
Indica se um objeto tem uma propriedade especificada definida.
Object
 Inherited
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.
Object
 Inherited
Indica se a propriedade especificada existe e é enumerável.
Object
 Inherited
Define a disponibilidade de uma propriedade dinâmica para operações de repetição.
Object
 Inherited
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.
Object
 Inherited
Retorna a representação de string do objeto especificado.
Object
 Inherited
Retorna o valor primitivo do objeto especificado.
Object
Detalhes da propriedade

absoluteStart

propriedade
absoluteStart:int  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A localização de uma linha como a posição absoluta de um caractere no objeto TextFlow.



Implementação
    public function get absoluteStart():int

Elementos da API relacionados

ascent

propriedade 
ascent:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Especifica o número de pixels da linha de base até a parte superior dos caracteres mais altos da linha. Para um TextLine que contenha apenas um elemento gráfico, ascent é definido como 0.



Implementação
    public function get ascent():Number

columnIndex

propriedade 
columnIndex:int  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

O número da coluna na qual a linha foi colocada, sendo a primeira coluna igual a 0.



Implementação
    public function get columnIndex():int

controller

propriedade 
controller:ContainerController  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

O controlador (objeto ContainerController) do contêiner no qual a linha foi colocada.



Implementação
    public function get controller():ContainerController

Elementos da API relacionados

descent

propriedade 
descent:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Especifica o número de pixels da linha de base até a parte inferior dos caracteres mais baixos da linha. Para um TextLine que contenha apenas um elemento gráfico, descent é definido como 0.



Implementação
    public function get descent():Number

height

propriedade 
height:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Altura da linha, em pixels.



Implementação
    public function get height():Number

lineOffset

propriedade 
lineOffset:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

O deslocamento da linha, em pixels, do início apropriado do contêiner (conforme definido pela direção do parágrafo e a progressão do bloco do contêiner), antes do alinhamento das linhas do parágrafo.



Implementação
    public function get lineOffset():Number

location

propriedade 
location:int  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Um dos valores de TextFlowLineLocation para especificar a localização de uma linha dentro de um parágrafo.



Implementação
    public function get location():int

Elementos da API relacionados

paragraph

propriedade 
paragraph:ParagraphElement  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

O parágrafo (ParagraphElement) no qual a linha reside.



Implementação
    public function get paragraph():ParagraphElement

Elementos da API relacionados

spaceAfter

propriedade 
spaceAfter:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A quantidade de espaço a ser deixado após a linha.

Se a linha for a última linha de um parágrafo que tiver um espaço após, a linha terá um valor spaceAfter. Se a linha vier na parte inferior de uma coluna, spaceAfter será ignorado. Caso contrário, a linha virá antes de outra linha na coluna, e a linha seguinte deverá ser posicionada na vertical para garantir que haja pelo menos esse espaço restante entre essa última linha do parágrafo e a primeira linha do parágrafo seguinte.



Implementação
    public function get spaceAfter():Number

Elementos da API relacionados

spaceBefore

propriedade 
spaceBefore:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A quantidade de espaço a ser deixado antes da linha.

Se a linha for a primeira linha de um parágrafo que tiver um 'espaço antes' aplicado, a linha terá um valor spaceBefore. Se a linha vier no alto de uma coluna, spaceBefore será ignorado. Caso contrário, a linha seguirá outra linha da coluna e será posicionada na vertical para garantir que haja pelo menos esse espaço restante entre essa linha e a última linha do parágrafo anterior.



Implementação
    public function get spaceBefore():Number

Elementos da API relacionados

textHeight

propriedade 
textHeight:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A altura lógica da linha de texto, que é igual a subida + descida. O valor é calculado com base na diferença entre as linhas de base que juntam a linha, seja alto e baixo ideográfico ou subida e descida, dependendo do fato de a posição da linha de base em y=0 ser ideográfica (por exemplo, TextBaseline.IDEOGRAPHIC_TOP) ou não.



Implementação
    public function get textHeight():Number

Elementos da API relacionados

textLength

propriedade 
textLength:int  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

O número de caracteres até a próxima linha, inclusive os espaços à esquerda.



Implementação
    public function get textLength():int

textLineExists

propriedade 
textLineExists:Boolean  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Indica se o objeto flash.text.engine.TextLine desta TextFlowLine existe. O valor é true se o objeto TextLine não passou pela coleta de lixo, e false se passou.



Implementação
    public function get textLineExists():Boolean

Elementos da API relacionados

unjustifiedTextWidth

propriedade 
unjustifiedTextWidth:Number  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A largura da linha, caso não esteja justificada. Para o texto não justificado, esse valor é igual ao textLength. Para o texto justificado, esse valor é o comprimento sem justificação, e textLength representa a largura real da linha. Por exemplo, quando a seguinte string é justificada e recebe a largura de 500, ela tem uma largura real de 500 e uma largura não justificada de 268.9921875.



Implementação
    public function get unjustifiedTextWidth():Number

validity

propriedade 
validity:String  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A validade da linha.

Uma linha pode ser inválida se o texto, os atributos aplicados a ele ou as configurações do controlador tiverem mudado desde a criação da linha. Uma linha inválida ainda pode ser exibida, e você pode usá-la, mas os valores usados serão os valores do momento em que ela foi criada. A linha representada por getTextLine() também estará em um estado inválido.



Implementação
    public function get validity():String

Elementos da API relacionados

x

propriedade 
x:Number

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A posição horizontal da linha em relação ao seu container, expresso como o deslocamento em pixels da esquerda do container.

Nota: embora esta propriedade seja tecnicamente read-write, você deve tratá-la como read-only. O setter existe apenas para atender às exigências da interface de IVerticalJustificationLine que define tanto um getter como setter desta propriedade. O uso de setter, embora possível, levará a resultados imprevisíveis.



Implementação
    public function get x():Number
    public function set x(value:Number):void

Elementos da API relacionados

y

propriedade 
y:Number

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A posição vertical da linha em relação ao seu container, expresso como o deslocamento em pixels da parte superior do container.

Nota: embora esta propriedade seja tecnicamente read-write, você deve tratá-la como read-only. O setter existe apenas para atender às exigências da interface de IVerticalJustificationLine que define tanto um getter como setter desta propriedade. O uso de setter, embora possível, levará a resultados imprevisíveis.



Implementação
    public function get y():Number
    public function set y(value:Number):void

Elementos da API relacionados

Detalhes do construtor

TextFlowLine

()Construtor
public function TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0)

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Construtor - cria uma nova instância de TextFlowLine.

Observação: Nenhum cliente deve chamá-lo. Está exposto para escrever o seu próprio compositor.

Parâmetros
textLine:flash.text.engine:TextLine — A TextLine exibe o objeto a ser usado nesta linha.
 
paragraph:ParagraphElement — O parágrafo (ParagraphElement) no qual a linha será colocada.
 
outerTargetWidth:Number (default = 0) — Largura na qual a linha será composta, exceto os recuos.
 
lineOffset:Number (default = 0) — O deslocamento da linha, em pixels, do início apropriado do contêiner (conforme definido pela direção do parágrafo e a progressão do bloco do contêiner), antes do alinhamento das linhas do parágrafo.
 
absoluteStart:int (default = 0) — A posição do caractere no fluxo de texto no qual a linha começa.
 
numChars:int (default = 0) — O número de caracteres na linha.

Elementos da API relacionados

Detalhes do método

getBounds

()método
public function getBounds():Rectangle

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Gera os limites da linha como um retângulo.

Retorna
Rectangle — um retângulo que representa os limites da linha.

getTextLine

()método 
public function getTextLine(forceValid:Boolean = false):flash.text.engine:TextLine

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Gera o objeto flash.text.engine.TextLine desta linha, que pode ser recriado se não existir devido à coleta de lixo. Atribui a forceValid o valor true para fazer com que a TextLine seja novamente gerada. Gera null se não for possível recriar a TextLine.

Parâmetros

forceValid:Boolean (default = false) — se for true, a TextLine será gerada novamente, se existir, mas for inválida.

Retorna
flash.text.engine:TextLine — objeto desta linha, ou null se o objeto TextLine não ode ser recriado.

Elementos da API relacionados





[ X ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.