ActionScript® 3.0 — dokumentacja dla platformy Adobe® Flash®
Strona główna  |  Ukryj listę pakietów i klas |  Pakiety  |  Klasy  |  Nowości  |  Indeks  |  Dodatki  |  Dlaczego język angielski?
Filtry: Pobieranie danych z serwera...
Pobieranie danych z serwera...
flashx.textLayout.compose 

FlowComposerBase  - AS3

Pakietflashx.textLayout.compose
Klasapublic class FlowComposerBase
DziedziczenieFlowComposerBase Inheritance Object
Podklasy StandardFlowComposer

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Klasa FlowComposerBase jest klasą bazową dla klas układacza przepływu w architekturze Text Layout Framework, które wpływają na kompozycję wierszy tekstu w obiektach ContainerController.

FlowComposerBase to klasa narzędziowa, która implementuje metody oraz właściwości wspólne dla kilku typów układacza przepływu. Kod aplikacji nie tworzy zwykle instancji ani nie korzysta z tej klasy (chyba że został rozszerzony w celu utworzenia niestandardowego układacza przepływu).

Powiązane elementy interfejsu API



Właściwości publiczne
 WłaściwośćZdefiniowane przez
 Inheritedconstructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu.
Object
  damageAbsoluteStart : int
[tylko do odczytu] Bezwzględne położenie bezpośrednio poprzedzające pierwszy element w przepływie tekstu, który wymaga określania układu i aktualizacji.
FlowComposerBase
  numLines : int
[tylko do odczytu] Łączna liczba wierszy umieszczonych w przepływie.
FlowComposerBase
  swfContext : ISWFContext
Instancja klasy ISWFContext służąca do realizacji niezbędnych wywołań mechanizmu FTE.
FlowComposerBase
  textFlow : flashx.textLayout.elements:TextFlow
[tylko do odczytu] Obiekt TextFlow, do którego dołączony jest dany układacz przepływu.
FlowComposerBase
Metody publiczne
 MetodaZdefiniowane przez
  
Konstruktor.
FlowComposerBase
  
damage(startPosition:int, damageLength:int, damageType:String):void
Oznacz wiersze jako uszkodzone i wymagające ponownego ułożenia.
FlowComposerBase
  
findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine
Zwraca obiekt TextFlowLine zawierający zawartość w określonym położeniu.
FlowComposerBase
  
findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int
Zwraca kolejny numer wiersza obiektu TextFlowLine, który zawiera treść w określonym położeniu.
FlowComposerBase
  
Zwraca wiersz o określonym numerze.
FlowComposerBase
 Inherited
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość.
Object
  
isDamaged(absolutePosition:int):Boolean
Wskazuje, czy jakiekolwiek obiekty TextFlowLine między początkiem przepływu a wierszem zawierającym zawartość w określonym położeniu są oznaczone jako uszkodzone.
FlowComposerBase
 Inherited
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr.
Object
 Inherited
Wskazuje, czy określona właściwość istnieje i jest przeliczalna.
Object
 Inherited
Ustawia dostępność właściwości dynamicznej używanej w pętlach.
Object
 Inherited
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych.
Object
 Inherited
Zwraca ciąg reprezentujący określony obiekt.
Object
  
updateLengths(startPosition:int, deltaLength:int):void
Długości w wierszach należy zaktualizować, aby zachować odwzorowanie na obiekt TextFlow.
FlowComposerBase
 Inherited
Zwraca pierwotną wartość dla określonego obiektu.
Object
Szczegół właściwości

damageAbsoluteStart

właściwość
damageAbsoluteStart:int  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Bezwzględne położenie bezpośrednio poprzedzające pierwszy element w przepływie tekstu, który wymaga określania układu i aktualizacji.



Implementacja
    public function get damageAbsoluteStart():int

numLines

właściwość 
numLines:int  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Łączna liczba wierszy umieszczonych w przepływie. Domyślnie architektura TLF nie tworzy kompozycji całego, dlatego ta wartość może nie być dokładna. Kompozycję ze wszystkimi wierszami można utworzyć za pomocą metody composeToPosition.



Implementacja
    public function get numLines():int

swfContext

właściwość 
swfContext:ISWFContext

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Wystąpienie klasy ISWFContext służące do realizacji niezbędnych wywołań mechanizmu FTE.

Domyślnie implementacją klasy ISWFContext jest ten obiekt FlowComposerBase. Aplikacje mogą udostępniać niestandardowe implementacje w celu użycia czcionek osadzonych w innym pliku SWF lub w celu buforowania i ponownego użycia wierszy tekstu.



Implementacja
    public function get swfContext():ISWFContext
    public function set swfContext(value:ISWFContext):void

Powiązane elementy interfejsu API

textFlow

właściwość 
textFlow:flashx.textLayout.elements:TextFlow  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Obiekt TextFlow, do którego dołączony jest dany układacz przepływu.



Implementacja
    public function get textFlow():flashx.textLayout.elements:TextFlow

Powiązane elementy interfejsu API

Konstruktor Szczegół

FlowComposerBase

()Konstruktor
public function FlowComposerBase()

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Konstruktor.

Szczegół metody

damage

()metoda
public function damage(startPosition:int, damageLength:int, damageType:String):void

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Oznacz wiersze jako uszkodzone i wymagające ponownego ułożenia.

Parametry

startPosition:int — początek zakresu do oznaczenia uszkodzenia.
 
damageLength:int — liczba znaków do oznaczenia jako uszkodzone.
 
damageType:String — typ uszkodzenia. Jedna z wartości klasy flashx.textLayout.compose.FlowDamageType.

findLineAtPosition

()metoda 
public function findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Zwraca obiekt TextFlowLine zawierający treść w określonym położeniu.

Położenie może być traktowane jako mniejsze przedziały między dwoma znakami lub innymi elementami przepływu tekstu. Jeśli wartość absolutePosition jest położeniem między ostatnim elementem w jednym wierszu a pierwszym elementem w następnym wierszu, wówczas poprzedzający wiersz zostanie zwrócony, jeśli parametr preferPrevious zostanie ustawiony na true, a kolejny wiersz zostanie zwrócony, jeśli dla parametru preferPrevious zostanie ustawiona wartość false.

Parametry

absolutePosition:int — Położenie treści, dla którego wymagany jest obiekt TextFlowLine.
 
preferPrevious:Boolean (default = false) — Określa, który wiersz jest zwracany, gdy położenie znajduje się między ostatnim elementem jednego wiersza a pierwszym elementem następnego wiersza.

Zwraca
flashx.textLayout.compose:TextFlowLine — Obiekt TextFlowLine zawierający treść w określonym położeniu lub null, jeśli nie został znaleziony.

findLineIndexAtPosition

()metoda 
public function findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Zwraca kolejny numer wiersza obiektu TextFlowLine, który zawiera zawartość w określonym położeniu.

Pierwszy wiersz ma numer 0, a numer ostatniego wiersza jest równy liczbie wierszy pomniejszonej o jeden. Jeśli położenie określone w parametrze absolutePosition wypada za końcem przepływu tekstu, ta metoda musi zwrócić liczbę, jaka zostanie przypisana do następnego nowego wiersza dodanego do przepływu tekstu (równa liczbie bieżących wierszy).

Położenie może być traktowane jako mniejsze przedziały między dwoma znakami lub innymi elementami przepływu tekstu. Jeśli wartość absolutePosition jest położeniem między ostatnim wierszem w jednym kontenerze a pierwszym wierszem w następnym kontenerze, wówczas poprzedzający kontener zostanie zwrócony, jeśli parametr preferPrevious zostanie ustawiony na true, a kolejny kontener zostanie zwrócony, jeśli dla parametru preferPrevious zostanie ustawiona wartość false.

Parametry

absolutePosition:int — Położenie treści, dla którego wymagany jest wiersz tekstu.
 
preferPrevious:Boolean (default = false) — Określa indeks kontenera, który będzie zwracany, gdy położenie znajduje się między ostatnim wierszem w jednym kontenerze a pierwszym wierszem w następnym kontenerze.

Zwraca
int — indeks wiersza tekstu w określonym położeniu. Jeśli nie zostanie znaleziony, kod traktuje to jako przekroczenie końca i zwraca liczbę wierszy.

getLineAt

()metoda 
public function getLineAt(index:int):flashx.textLayout.compose:TextFlowLine

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Zwraca wiersz o określonym numerze.

Lista wierszy jest ponumerowana od zera do liczby wierszy pomniejszonej o jeden. Jeśli wartość w index znajduje się poza granicami listy wierszy, wówczas ta funkcja zwraca null.

Parametry

index:int — Liczba wierszy obiektu TextFlowLine do zwrócenia.

Zwraca
flashx.textLayout.compose:TextFlowLine — Obiekt TextFlowLine z określoną liczbą wierszy lub null, jeśli obiekt nie został znaleziony.

isDamaged

()metoda 
public function isDamaged(absolutePosition:int):Boolean

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Wskazuje, czy jakiekolwiek obiekty TextFlowLine między początkiem przepływu a wierszem zawierającym treść w określonym położeniu są oznaczone jako uszkodzone.

Parametry

absolutePosition:int — ostatnie położenie w obszarze zainteresowania

Zwraca
Boolean — True, jeśli dowolny z obiektów TextFlowLine od początku przepływu aż do wiersza zawierającego treść w położeniu absolutePosition jest oznaczony jako uszkodzony.

updateLengths

()metoda 
public function updateLengths(startPosition:int, deltaLength:int):void

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Długości w wierszach należy zaktualizować, aby zachować odwzorowanie na obiekt TextFlow.

Parametry

startPosition:int — początek zmiany długości
 
deltaLength:int — zmiana w ilości znaków.





[ X ]Dlaczego język angielski?
Treść dokumentacji języka ActionScript 3.0 wyświetlana w języku angielskim

Niektóre części dokumentacji języka ActionScript 3.0 nie są przetłumaczone na poszczególne języki. Gdy element nie jest przetłumaczony na dany język, jest wyświetlany tekst angielski. Na przykład opis klasy ga.controls.HelpBox nie jest przetłumaczony na żaden dodatkowy język. Z tego powodu polska wersja dokumentacji zawiera opis klasy ga.controls.HelpBox w języku angielskim.