FlowGroupElement

Pacote	flashx.textLayout.elements
Classe	public class FlowGroupElement
Herança	FlowGroupElement FlowElement Object
Subclasses	ParagraphFormattedElement, SubParagraphGroupElementBase

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

A classe FlowGroupElement é a classe básica dos objetos FlowElement que podem ter uma matriz de descendentes (filhos). Essas classes contêm TextFlow, ParagraphElement, DivElement e LinkElement.

Não é possível criar diretamente um objeto FlowGroupElement. A chamada de new FlowGroupElement() gera uma exceção de erro.

Propriedade MXML padrãomxmlChildren

Elementos da API relacionados

DivElement
LinkElement
ParagraphElement
TextFlow

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		alignmentBaseline : * TextLayoutFormat: especifica a linha de base à qual a linha de base dominante se alinha.	FlowElement
		backgroundAlpha : * TextLayoutFormat: Valor de Alfa (transparência) do plano de fundo (adota o valor padrão se não for definido durante o cascateamento).	FlowElement
		backgroundColor : * TextLayoutFormat: Cor do plano de fundo do texto (adota o valor padrão se não for definido durante o cascateamento).	FlowElement
		baselineShift : * TextLayoutFormat: quantidade para deslocar a linha de base do valor dominantBaseline.	FlowElement
		blockProgression : * TextLayoutFormat: especifica uma progressão vertical ou horizontal da colocação de linha.	FlowElement
		breakOpportunity : * TextLayoutFormat: controla onde as linhas são permitidas para quebrar o texto em diversas linhas.	FlowElement
		cffHinting : * TextLayoutFormat: O tipo de referência CFF usado nesse texto.	FlowElement
		clearFloats : * TextLayoutFormat: Controla como texto envolve um float.	FlowElement
		color : * TextLayoutFormat: Cor do texto.	FlowElement
		columnCount : * TextLayoutFormat: o número de colunas de texto (adota o valor padrão se indefinido durante a cascata).	FlowElement
		columnGap : * TextLayoutFormat: especifica a quantidade do espaço de sarjeta, em pixels, para dobra de colunas (adota o valor padrão se indefinido durante a cascata).	FlowElement
		columnWidth : * TextLayoutFormat: a largura da coluna em pixels (adota o valor padrão se indefinido durante a cascata).	FlowElement
		computedFormat : flashx.textLayout.formats:ITextLayoutFormat [somente leitura] Gera os atributos calculados de formato válidos para este elemento.	FlowElement
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		coreStyles : Object [somente leitura] Retorna os coreStyles neste FlowElement.	FlowElement
		digitCase : * TextLayoutFormat: o tipo da caixa de dígito usado para este texto.	FlowElement
		digitWidth : * TextLayoutFormat: o tipo da largura de dígito usado para este texto.	FlowElement
		direction : * TextLayoutFormat: Especifica o nível de incorporação bidirecional padrão do texto no bloco de texto.	FlowElement
		dominantBaseline : * TextLayoutFormat: especifica que linha de base de elemento se ajusta ao alignmentBaseline para determinar a posição vertical do elemento na linha.	FlowElement
		firstBaselineOffset : * TextLayoutFormat: especifica a posição de linha de base da primeira linha no container.	FlowElement
		fontFamily : * TextLayoutFormat: O nome da fonte a ser usada ou uma lista dos nomes de fonte separados por vírgulas.	FlowElement
		fontLookup : * TextLayoutFormat: busca de fonte para usar.	FlowElement
		fontSize : * TextLayoutFormat: o tamanho do texto em pixels.	FlowElement
		fontStyle : * TextLayoutFormat: estilo de texto.	FlowElement
		fontWeight : * TextLayoutFormat: espessura do texto.	FlowElement
		format : flashx.textLayout.formats:ITextLayoutFormat Propriedades do TextLayoutFormat aplicadas diretamente a este elemento.	FlowElement
		id : String Atribui um nome identificador ao elemento, possibilitando definir um estilo para o elemento através da referência à id.	FlowElement
		justificationRule : * TextLayoutFormat: regra usada para justificar o texto em um parágrafo.	FlowElement
		justificationStyle : * TextLayoutFormat: o estilo usado para a justificação do parágrafo.	FlowElement
		kerning : * TextLayoutFormat: O kerning ajusta os pixels entre determinados pares de caracteres para aprimorar a legibilidade.	FlowElement
		leadingModel : * TextLayoutFormat: especifica o modelo de entrelinha, que é uma combinação de base e direção de entrelinha.	FlowElement
		ligatureLevel : * TextLayoutFormat: controla quai das ligaduras que são definidas na fonte podem ser usadas no texto.	FlowElement
		lineBreak : * TextLayoutFormat: controla a quebra de texto dentro do container (adota o valor padrão se indefinido durante a cascata).	FlowElement
		lineHeight : * TextLayoutFormat: controles de entrelinha do texto.	FlowElement
		lineThrough : * TextLayoutFormat: se verdadeiro, aplica-se tachado, uma linha desenhada no meio do texto.	FlowElement
		linkActiveFormat : * TextLayoutFormat: define os atributos de formatação usados para links em estado normal.	FlowElement
		linkHoverFormat : * TextLayoutFormat: define os atributos de formatação utilizados para links em estado de foco, quando o mouse está sobre os limites (rolando sobre) um link.	FlowElement
		linkNormalFormat : * TextLayoutFormat: define os atributos de formatação usados para links em estado normal.	FlowElement
		listAutoPadding : * TextLayoutFormat: isto especifica um recuo automático da borda inicial de listas quando o valor de preenchimento da lista neste lado é automático.	FlowElement
		listMarkerFormat : * TextLayoutFormat: define a formatação dos marcadores de lista de atributos.	FlowElement
		listStylePosition : * TextLayoutFormat: os valores permitidos são ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. O valor padrão é indefinido indicando não configurado. Se não for definido durante o cascateamento, esta propriedade herdará seu valor de um ancestral.	FlowElement
		listStyleType : * TextLayoutFormat: Os valores permitidos são ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT. O valor padrão é indefinido indicando não configurado. Se não for definido durante o cascateamento, esta propriedade herdará seu valor de um ancestral.	FlowElement
		locale : * TextLayoutFormat: O local do texto.	FlowElement
		mxmlChildren : Array Acrescenta uma matriz de filhos a este objeto.	FlowGroupElement
		numChildren : int [somente leitura] Gera o número de filhos do FlowElement que este objeto FlowGroupElement possui.	FlowGroupElement
		paddingBottom : * TextLayoutFormat: inserção inferior em pixels.	FlowElement
		paddingLeft : * TextLayoutFormat: Inserção esquerda em pixels.	FlowElement
		paddingRight : * TextLayoutFormat: inserção direita em pixels.	FlowElement
		paddingTop : * TextLayoutFormat: inserção superior em pixels.	FlowElement
		paragraphEndIndent : * TextLayoutFormat: um número que especifica, em pixels, a quantidade para recuar a borda de fim do parágrafo.	FlowElement
		paragraphSpaceAfter : * TextLayoutFormat: Um Número que especifica a quantidade de espaço, em pixels, a ser deixada após o parágrafo.	FlowElement
		paragraphSpaceBefore : * TextLayoutFormat: Um Número que especifica a quantidade de espaço, em pixels, a ser deixada antes do parágrafo.	FlowElement
		paragraphStartIndent : * TextLayoutFormat: um número que especifica, em pixels, a quantidade para recuar a borda inicial do parágrafo.	FlowElement
		parent : FlowGroupElement [somente leitura] Gera o pai deste objeto FlowElement.	FlowElement
		parentRelativeEnd : int [somente leitura] Gera o fim relativo deste objeto FlowElement no pai.	FlowElement
		parentRelativeStart : int [somente leitura] Gera o início relativo deste objeto FlowElement no pai.	FlowElement
		renderingMode : * TextLayoutFormat: O modo de renderização usado nesse texto.	FlowElement
		styleName : * TextLayoutFormat: atribui uma classe de identificação ao elemento, permitindo definir um estilo para o elemento por meio da referência a styleName.	FlowElement
		styles : Object [somente leitura] Retorna os estilos neste FlowElement.	FlowElement
		tabStops : * TextLayoutFormat: especifica as paradas de tabulação associadas ao parágrafo.	FlowElement
		textAlign : * TextLayoutFormat: alinhamento de linhas no parágrafo em relação ao container.	FlowElement
		textAlignLast : * TextLayoutFormat: alinhamento da última (ou única) linha no parágrafo em relação ao container em texto justificado.	FlowElement
		textAlpha : * TextLayoutFormat: Valor Alfa (transparência) do texto.	FlowElement
		textDecoration : * TextLayoutFormat: decoração no texto.	FlowElement
		textIndent : * TextLayoutFormat: um número que especifica, em pixels, a quantidade para recuar a primeira linha do parágrafo.	FlowElement
		textJustify : * TextLayoutFormat: especifica opções para justificar o texto.	FlowElement
		textLength : int [somente leitura] Gera o comprimento total de texto de propriedade deste objeto FlowElement e do seu filho.	FlowElement
		textRotation : * TextLayoutFormat: determina o número de graus para girar este texto.	FlowElement
		tracking : Object [somente gravação] Define o controle e é sinônimo da propriedade trackingRight.	FlowElement
		trackingLeft : * TextLayoutFormat: Número, em pixels (ou porcentagem de fontSize, como 120%) que indica a quantidade de rastreamento (kerning manual) a ser aplicado à esquerda de cada caractere.	FlowElement
		trackingRight : * TextLayoutFormat: Número, em pixels (ou porcentagem de fontSize, como 120%) que indica a quantidade de rastreamento (kerning manual) a ser aplicado à direita de cada caractere.	FlowElement
		typeName : String Cada FlowElement tem um typeName.	FlowElement
		typographicCase : * TextLayoutFormat: o tipo de caixa tipográfica usado para este texto.	FlowElement
		userStyles : Object Permite ler e gravar estilos de usuários em um objeto FlowElement.	FlowElement
		verticalAlign : * TextLayoutFormat: o alinhamento vertical ou a justificação (adota o valor padrão se indefinido durante a cascata).	FlowElement
		whiteSpaceCollapse : * TextLayoutFormat: oculta ou mantém espaços em branco ao importar texto em um TextFlow.	FlowElement
		wordSpacing : * TextLayoutFormat: especifica o espaçamento ideal, mínimo e máximo (como um multiplicador da largura de um espaço normal) entre palavras a ser utilizado durante a justificação.	FlowElement

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		FlowGroupElement() Classe básica – chamar um novo FlowGroupElement() gera uma exceção de erro.	FlowGroupElement
		addChild(child:FlowElement):FlowElement Anexa um objeto FlowElement filho.	FlowGroupElement
		addChildAt(index:uint, child:FlowElement):FlowElement Acrescenta um objeto FlowElement filho na posição de índice especificada.	FlowGroupElement
		clearStyle(styleProp:String):void Apaga o estilo especificado por styleProp a partir deste objeto FlowElement.	FlowElement
		deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Faz uma cópia profunda deste objeto FlowElement, inclusive os filhos, copiando o conteúdo entre as duas posições de caracteres especificadas e gerando a cópia como um objeto FlowElement.	FlowElement
		equalUserStyles(otherElement:FlowElement):Boolean Compare o userStyles deste com o userStyles de otherElement.	FlowElement
		findChildIndexAtPosition(relativePosition:int):int Dada uma posição relativa de texto, localiza o índice do primeiro FlowElement filho que contenha a posição relativa.	FlowGroupElement
		findLeaf(relativePosition:int):FlowLeafElement Dada uma posição relativa de texto, localizar o elemento de folha que contém a posição.	FlowGroupElement
		getAbsoluteStart():int Gera o local inicial do elemento no fluxo de texto como um índice absoluto.	FlowElement
		getCharAtPosition(relativePosition:int):String Gera o caractere na posição especificada, em relação a este objeto FlowElement.	FlowElement
		getCharCodeAtPosition(relativePosition:int):int Gera o código do caractere na posição especificada, em relação a este FlowElement.	FlowElement
		getChildAt(index:int):FlowElement Gera o FlowElement filho no índice especificado.	FlowGroupElement
		getChildIndex(child:FlowElement):int Pesquisa nos filhos o objeto FlowElement especificado e gera sua posição no índice.	FlowGroupElement
		getElementRelativeStart(ancestorElement:FlowElement):int Gera o início deste elemento em relação a um elemento precedente.	FlowElement
		getFirstLeaf():FlowLeafElement Gera o primeiro descendente FlowLeafElement deste grupo.	FlowGroupElement
		getLastLeaf():FlowLeafElement Gera o último descendente FlowLeafElement deste grupo.	FlowGroupElement
		getNextSibling():FlowElement Gera o próximo irmão FlowElement na hierarquia do fluxo de texto.	FlowElement
		getParagraph():ParagraphElement Gera o objeto ParagraphElement associado a este elemento.	FlowElement
		getPreviousSibling():FlowElement Gera o irmão FlowElement anterior na hierarquia do fluxo de texto.	FlowElement
		getStyle(styleProp:String):* Gera o valor do estilo especificado pelo parâmetro styleProp, que especifica o nome do estilo e pode conter qualquer nome de estilo do usuário.	FlowElement
		getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String [substituir]	FlowGroupElement
		getTextFlow():flashx.textLayout.elements:TextFlow Sobe na hierarquia do fluxo de texto para gerar o objeto TextFlow de raiz do elemento.	FlowElement
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		initialized(document:Object, id:String):void Uma chamada dos objetos MXML depois do objeto de implementação foi criada, e todas as propriedades componentes especificadas na tag de MXML foram inicializadas.	FlowElement
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeChild(child:FlowElement):FlowElement Retira do grupo o objeto FlowElement filho especificado.	FlowGroupElement
		removeChildAt(index:uint):FlowElement Retira o objeto FlowElement filho da posição especificada do índice.	FlowGroupElement
		replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void Substitui elementos filhos no grupo pelos novos elementos especificados.	FlowGroupElement
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		setStyle(styleProp:String, newValue:*):void Define o estilo especificado pelo parâmetro styleProp para o valor especificado pelo parâmetro newValue.	FlowElement
		shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Produz uma cópia deste objeto FlowElement, copiando o conteúdo entre duas posições especificadas de caracteres.	FlowElement
		splitAtIndex(childIndex:int):FlowGroupElement Divide este objeto na posição especificada pelo parâmetro childIndex.	FlowGroupElement
		splitAtPosition(relativePosition:int):FlowElement Divide este objeto FlowElement na posição especificada pelo parâmetro relativePosition, que é uma posição relativa deste elemento no texto.	FlowElement
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object

Detalhes da propriedade

mxmlChildren

propriedade

mxmlChildren:Array

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Acrescenta uma matriz de filhos a este objeto. Usa o método replaceChildren() para acrescentar cada elemento na matriz. Destinado para uso durante uma importação compilada de mxml.

Implementação
public function get mxmlChildren():Array
public function set mxmlChildren(value:Array):void

Lança

TypeError — se o elemento da matriz não for um FlowElement nem uma string

Elementos da API relacionados

FlowGroupElement.replaceChildren()

numChildren

propriedade

numChildren:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Gera o número de filhos do FlowElement que este objeto FlowGroupElement possui.

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

Detalhes do construtor

()

Construtor

public function FlowGroupElement()

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Classe básica – chamar um novo FlowGroupElement() gera uma exceção de erro.

Detalhes do método

addChild

()

método

public function addChild(child:FlowElement):FlowElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Anexa um objeto FlowElement filho. O novo filho é incluído no final da lista de filhos.

Parâmetros

child:FlowElement — O elemento filho a ser anexado.

Retorna

FlowElement — o filho FlowElement adicionado

Exemplo ( Como usar este exemplo )

Este exemplo chama addChild() para adicionar uma extensão a um parágrafo e adicionar o parágrafo ao fluxo de texto.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_addChildExample extends Sprite
    {        
        public function FlowGroupElement_addChildExample()
        {
            // create string for text flow
            var simpleText:String = "It was a dark and stormy night.";        
                    
            // define TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();            
            var paragraph:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement;
            span.text = simpleText;
            // add span to paragraph and add paragraph to text flow
            paragraph.addChild(span);
            textFlow.addChild(paragraph);
            // assign composer and controller and update controller to display text
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

addChildAt

()

método

public function addChildAt(index:uint, child:FlowElement):FlowElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Acrescenta um objeto FlowElement filho na posição de índice especificada.

Parâmetros

	`index:uint` — índice da posição na qual o elemento filho deve ser incluído, sendo a primeira igual a 0.

	`child:FlowElement` — O elemento filho a ser incluído.

Retorna

FlowElement — o filho FlowElement adicionado

Lança

RangeError — O index está fora do intervalo.

Exemplo ( Como usar este exemplo )

Este exemplo invoca addChildAt para adicionar três extensões em um parágrafo.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_addChildAtExample extends Sprite
    {        
        public function FlowGroupElement_addChildAtExample()
        {
            // define text strings for the contents of the text flow
            var textA:String = "It was a dark and stormy night. ";
            var textB:String = "The quick red fox jumped over the lazy brown dog. ";
            var textC:String = "Mary had a little lamb. ";
            // define TextFlow, ParagraphElement and SpanElement objects
            var textFlow:TextFlow = new TextFlow();            
            var paragraph:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();
            span1.text = textA;
            span2.text = textB;
            span3.text = textC;
            // add spans at specified positions
            paragraph.addChildAt(0, span2);
            paragraph.addChildAt(0, span1);
            paragraph.addChildAt(1, span3);
            textFlow.addChild(paragraph);
            // assign composer, controller, and update to display text
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

findChildIndexAtPosition

()

método

public function findChildIndexAtPosition(relativePosition:int):int

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Dada uma posição relativa de texto, localiza o índice do primeiro FlowElement filho que contenha a posição relativa. Mais de um filho pode conter uma posição relativa devido a FlowElements de comprimento zero.

Examine os filhos para encontrar o FlowElement que contém a posição relativa. A posição relativa informada é relativa a este FlowElement.

Parâmetros

relativePosition:int — a posição relativa a este elemento

Retorna

int — índice do primeiro elemento filho que contém relativePosition

Exemplo ( Como usar este exemplo )

Este exemplo localiza o índice do filho em uma posição relativa no texto e define o vermelho como sua cor.

    
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_findChildIndexAtPositionExample extends Sprite
    {        
        public function FlowGroupElement_findChildIndexAtPositionExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // find the index of the child containing relative offset 21; set color to red
            var index:int = textFlow.findChildIndexAtPosition(21);
            textFlow.getChildAt(index).color = 0xFF0000;
            // display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

findLeaf

()

método

public function findLeaf(relativePosition:int):FlowLeafElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Dada uma posição relativa de texto, localizar o elemento de folha que contém a posição.

Examina a hierarquia de elementos de fluxo para encontrar o FlowLeafElement que contém a posição especificada. A posição especificada é relativa a este objeto FlowElement.

Parâmetros

relativePosition:int — índice de texto relativo a ser consultado.

Retorna

FlowLeafElement — o elemento de folha que contém a posição relativa.

Exemplo ( Como usar este exemplo )

Este exemplo cria dois parágrafos, localiza o FlowLeafElement na posição relativa 55 e define o vermelho como sua cor.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_findLeafExample extends Sprite
    {        
        public function FlowGroupElement_findLeafExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a dark and stormy night</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // find the FlowLeafElement object containing relative offset 55; set color to red
            var leaf:SpanElement = textFlow.findLeaf(55) as SpanElement;
            leaf.color = 0xFF0000;
            // display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getChildAt

()

método

public function getChildAt(index:int):FlowElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Gera o FlowElement filho no índice especificado.

Parâmetros

index:int — a posição na qual encontrar o objeto FlowElement.

Retorna

FlowElement — o objeto filho FlowElement na posição especificada.

Exemplo ( Como usar este exemplo )

Este exemplo usa o método getChildAt() para acessar um parágrafo no fluxo de texto e mudar a cor de uma de suas extensões para vermelho.

    
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_getChildAtExample extends Sprite
    {        
        public function FlowGroupElement_getChildAtExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // find the paragraph at index position 1
            var para:ParagraphElement = textFlow.getChildAt(1) as ParagraphElement;
            // find the span at index position 1 of the paragraph and color it red
            para.getChildAt(1).color = 0xFF0000;
            // display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getChildIndex

()

método

public function getChildIndex(child:FlowElement):int

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Pesquisa nos filhos o objeto FlowElement especificado e gera sua posição no índice.

Parâmetros

child:FlowElement — O item de objeto FlowElement a ser localizado entre os filhos.

Retorna

int — A posição de índice do filho especificado. Se child não for encontrado, gera o valor -1.

getFirstLeaf

()

método

public function getFirstLeaf():FlowLeafElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Gera o primeiro descendente FlowLeafElement deste grupo.

Retorna

FlowLeafElement — o primeiro objeto FlowLeafElement.

Exemplo ( Como usar este exemplo )

Este exemplo cria dois parágrafos, localiza o primeiro objeto FlowLeafElement e define o vermelho como sua cor.

        
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_getFirstLeafExample extends Sprite
    {        
        public function FlowGroupElement_getFirstLeafExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a </flow:span>"+
                        "<flow:span fontStyle=\"italic\">dark and stormy</flow:span>"+
                        "<flow:span> night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a peck of pickle peppers. </flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // get first FlowLeafElement object and set its color to red
            var leaf:SpanElement = textFlow.getFirstLeaf() as SpanElement;
            leaf.color = 0xFF0000;
            // add composer and controller and update controller to display text
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getLastLeaf

()

método

public function getLastLeaf():FlowLeafElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Gera o último descendente FlowLeafElement deste grupo.

Retorna

FlowLeafElement — o último objeto FlowLeafElement.

Exemplo ( Como usar este exemplo )

Este exemplo cria dois parágrafos, localiza o último objeto FlowLeafElement e define o vermelho como sua cor.

    
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_getLastLeafExample extends Sprite
    {        
        public function FlowGroupElement_getLastLeafExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a dark and stormy night</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            //find last leaf, set its color to red and display text
            var leaf:SpanElement = textFlow.getLastLeaf() as SpanElement;
            leaf.color = 0xFF0000;
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getText

()

método

override public function getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String

Parâmetros

	`relativeStart:int` (default = `0`)

	`relativeEnd:int` (default = `-1`)

	`paragraphSeparator:String` (default = " ")

Retorna

String

removeChild

()

método

public function removeChild(child:FlowElement):FlowElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Retira do grupo o objeto FlowElement filho especificado.

Parâmetros

child:FlowElement — O elemento filho a ser retirado.

Retorna

FlowElement — o objeto FlowElement filho retirado

Lança

ArgumentError — child não foi encontrado.

Exemplo ( Como usar este exemplo )

Este exemplo remove a terceira extensão no segundo parágrafo do fluxo de texto.

        
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_removeChildExample extends Sprite
    {        
        public function FlowGroupElement_removeChildExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p id='para1'>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p id='para2'>"+
                        "<flow:span id='span2'>Peter Piper picked a </flow:span>"+
                        "<flow:span id='span3' fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span id='span4'>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            // get paragraph with ID = 'para2' and remove its child with name = 'span4'
            var parent:ParagraphElement = textFlow.getElementByID("para2") as ParagraphElement;
            parent.removeChild(textFlow.getElementByID("span4"));
            // update controller to display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

removeChildAt

()

método

public function removeChildAt(index:uint):FlowElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Retira o objeto FlowElement filho da posição especificada do índice.

Parâmetros

index:uint — posição na qual o elemento filho deve ser retirado.

Retorna

FlowElement — o objeto filho FlowElement removido da posição especificada.

Lança

RangeError — O index está fora do intervalo.

Exemplo ( Como usar este exemplo )

Este exemplo chama removeChildAt() para remoer o segundo dos três parágrafos.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_removeChildAtExample extends Sprite
    {        
        public function FlowGroupElement_removeChildAtExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a dark and stormy night. </flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a peck of pickle peppers. </flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Mary had a little lamb. </flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow, import text, add composer and controller 
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // remove child at index position 1 (with first position = 0); display text
            textFlow.removeChildAt(1);
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

replaceChildren

()

método

public function replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Substitui elementos filhos no grupo pelos novos elementos especificados. Use os parâmetros beginChildIndex e endChildIndex para controlar a operação da seguinte maneira:

Para excluir elementos, não transmita nenhum elemento de substituição.
Para inserir elementos, transmita o mesmo valor de beginChildIndex e endChildIndex. Os novos elementos são inseridos antes do índice especificado.
Para anexar elementos, transmita numChildren para beginChildIndex e endChildIndex.

Caso contrário, este método substitui os elementos especificados, a partir do elemento em beginChildIndex e até, mas sem incluir, endChildIndex.

Parâmetros

	`beginChildIndex:int` — O valor de índice da posição inicial do intervalo de substituição na matriz de filhos.

	`endChildIndex:int` — O valor de índice após a posição final do intervalo de substituição na matriz de filhos.

	`... rest` — Os elementos que devem substituir o intervalo de elementos especificado. Pode ser uma sequência que contém elementos de fluxo ou matrizes de vetores dos mesmos.

Lança

RangeError — O beginChildIndex ou endChildIndex especificado está fora do intervalo.

Exemplo ( Como usar este exemplo )

Este exemplo substitui as três extensões no segundo parágrafo por duas novas.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_replaceChildrenExample extends Sprite
    {        
        public function FlowGroupElement_replaceChildrenExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p id='para1'>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p id='para2'>"+
                        "<flow:span id='span2'>Peter Piper picked a </flow:span>"+
                        "<flow:span id='span3' fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span id='span4'>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
            
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // define two new SpanElement objects
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            span1.text = "Mary had a little lamb. ";
            span2.text = "And this little pig stayed home. ";
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,600));
            // get paragraph with ID = 'para2' and replace its children with span1 and span2
            var parent:ParagraphElement = textFlow.getElementByID("para2") as ParagraphElement;
            parent.replaceChildren(0, 3, [span1, span2]);
            // update controller to display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

splitAtIndex

()

método

public function splitAtIndex(childIndex:int):FlowGroupElement

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10, AIR 1.5

Divide este objeto na posição especificada pelo parâmetro childIndex. Se este elemento de grupo tiver um pai, cria uma cópia rasa deste objeto e substitui seus filhos pelos elementos até o índice. Transfere os elementos após childIndex para a cópia.

Parâmetros

childIndex:int

Retorna

FlowGroupElement — o novo objeto FlowGroupElement.

Lança

RangeError — se childIndex for maior que o comprimento do filho.

Aspectos jurídicos | Política de privacidade on-line

FlowGroupElement - AS3

Pacotesx

Elementos de linguagem

Apêndices

Pacote flashx.textLayout.elements

mxmlChildren

numChildren