FlowElement  - AS3

TextLayoutFormat: określa linię bazową, do której wyrównywana jest dominująca linia bazowa. Na przykład, jeśli właściwość dominantBaseline zostanie ustawiona na wartość ASCENT, ustawienie właściwości alignmentBaseline na DESCENT powoduje wyrównanie górnej krawędzi tekstu z linią bazową DESCENT lub umieszczenie jej pod tą linią. Największy element w wierszu zwykle określa linie bazowe.

Wartości dozwolone: TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, TextBaseline.USE_DOMINANT_BASELINE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość TextBaseline.USE_DOMINANT_BASELINE.

Powiązane elementy interfejsu API

TextLayoutFormat: wartość alfa (przezroczystość) dla tła (jeśli przekazana kaskadowo wartość nie jest zdefiniowana, przyjmowana jest wartość domyślna). Wartość 0 określa całkowitą przezroczystość, a wartość 1 określa całkowitą nieprzezroczystość. Obiekty wyświetlane z wartością alpha ustawioną na 0 są aktywne, mimo iż są niewidoczne.

Wartości dozwolone to liczby od 0 do 1 oraz FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, zostanie przyjęta wartość 1.

TextLayoutFormat: kolor tła tekstu (jeśli zostanie przekazana kaskadowo wartość undefined, przyjmowana jest wartość domyślna). Może być wartością stałą BackgroundColor.TRANSPARENT lub wartością szesnastkową, która określa trzy 8-bitowe wartości RGB (czerwony, zielony, niebieski); na przykład 0xFF0000 to kolor czerwony, a 0x00FF00 to kolor zielony.

Wartości dozwolone to ciągi BackgroundColor.TRANSPARENT i FormatValue.INHERIT oraz liczby całkowite bez znaku od 0x0 do 0xffffffff.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość BackgroundColor.TRANSPARENT.

Powiązane elementy interfejsu API

TextLayoutFormat: przesunięcie linii bazowej względem wartości dominantBaseline. Jednostką są piksele lub odsetek wartości fontSize (w tym drugim przypadku należy podać ciąg znaków, np. 140%). Wartości dodatnie powodują przesunięcie w górę dla tekstu poziomego (w prawo dla pionowego), a wartości ujemne powodują przesunięcie w dół dla tekstu poziomego (w lewo dla pionowego).

Wartości dozwolone: BaselineShift.SUPERSCRIPT, BaselineShift.SUBSCRIPT, FormatValue.INHERIT.

Poprawne wartości liczbowe należą do zakresu od -1000 do 1000.

Dozwolone wartości procentowe należą do zakresu od -1000 do 1000.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.0.

Powiązane elementy interfejsu API

TextLayoutFormat: określa pionowy lub poziomy przyrost położenia przy rozmieszczaniu wierszy. Wiersze są rozmieszczane od góry do dołu (BlockProgression.TB — dla tekstu poziomego) lub z prawej na lewą (BlockProgression.RL — dla tekstu pionowego).

Wartości dozwolone: BlockProgression.RL, BlockProgression.TB, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość BlockProgression.TB.

Powiązane elementy interfejsu API

TextLayoutFormat: steruje miejscem dozwolonego podziału wierszy przy zawijaniu tekstu. Wartość BreakOpportunity.AUTO powoduje normalne dzielenie tekstu na wiersze. Wartość BreakOpportunity.NONE powoduje, że tekst nie jest dzielony, chyba że doszłoby do przekroczenia wymiaru i nie ma innych możliwych miejsc podziału wiersza. Wartość BreakOpportunity.ANY zezwala teraz na dzielenie wierszy w dowolnych miejscach, nie tylko między wyrazami. Wartość BreakOpportunity.ALL powoduje, że każdy klaster typograficzny będzie umieszczany w osobnym wierszu (jest to użyteczne przy umieszczaniu tekstu na ścieżce).

Wartości dozwolone: BreakOpportunity.ALL, BreakOpportunity.ANY, BreakOpportunity.AUTO, BreakOpportunity.NONE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość BreakOpportunity.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: typ przyciągania CFF użyty dla tego tekstu. Typ przyciągania CFF określa, czy środowisko wykonawcze Flash wymusza dopasowanie grubych kresek poziomych do siatki pikseli. Ta właściwość ma zastosowanie tylko wówczas, gdy właściwość renderingMode jest ustawiona na RenderingMode.CFF, a czcionka jest osadzona (właściwość fontLookup jest ustawiona na FontLookup.EMBEDDED_CFF). Przyciąganie pozwala na uzyskanie wyraźnego tekstu czytelnego dla ludzi także przy niskich rozdzielczościach.

Wartości dozwolone: CFFHinting.NONE, CFFHinting.HORIZONTAL_STEM, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość CFFHinting.HORIZONTAL_STEM.

Powiązane elementy interfejsu API

TextLayoutFormat: Steruje sposobem zawijania tekstu wokół obiektu ruchomego. Wartość none (brak) powoduje zawijanie tekstu możliwie najbliżej obiektu ruchomego. Wartość left (na lewo) powoduje omijanie przez tekst wszystkich części kontenera mających wartość float równą left. Wartość right (na prawo) powoduje omijanie przez tekst wszystkich części kontenera mających wartość float równą right. Wartość both (obie strony) powoduje, że tekst omija wszystkie obiekty ruchome.

Wartości dozwolone: ClearFloats.START, ClearFloats.END, ClearFloats.LEFT, ClearFloats.RIGHT, ClearFloats.BOTH, ClearFloats.NONE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość ClearFloats.NONE.

Powiązane elementy interfejsu API

TextLayoutFormat: kolor tekstu. Liczba szesnastkowa, która określa trzy 8-bitowe wartości RGB (czerwony, zielony, niebieski); na przykład: 0xFF0000 to kolor czerwony, a 0x00FF00 to zielony.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

TextLayoutFormat: liczba kolumn tekstu (jeśli kaskadowo zostanie przekazana wartość undefined, przyjmowana jest wartość domyślna). Liczba kolumn przesłania inne ustawienia kolumn. Wartość jest liczbą całkowitą; jeśli nie zostanie określona, przyjmowana jest wartość FormatValue.AUTO. Jeśli wartość columnCount nie jest określona, wówczas wartość columnWidth jest wykorzystywana w celu utworzenia tak dużej liczby kolumn, jaka może zmieścić się w kontenerze.

Poprawne wartości to ciągi FormatValue.AUTO i FormatValue.INHERIT oraz liczby całkowite od 1 do 50.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: określa odstęp między kolumnami w pikselach (jeśli przekazana kaskadowo wartość jest równa undefined, przyjmowana jest wartość domyślna). Wartość jest liczbą

Wartości dozwolone to liczby od 0 do 1000 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, zostanie przyjęta wartość 20.

TextLayoutFormat: szerokość kolumny w pikselach (jeśli przekazana kaskadowo wartość jest równa undefined, przyjmowana jest wartość domyślna). Jeśli zostanie określona szerokość kolumny, ale nie zostanie określona liczba kolumn, TextLayout utworzy maksymalną liczbę kolumn o określonej szerokości, z uwzględnieniem szerokości kontenera i ustawień columnGap. Ewentualne wolne miejsce jest pozostawiane za ostatnią kolumną. Wartość jest liczbą.

Wartości dozwolone to ciągi FormatValue.AUTO i FormatValue.INHERIT oraz liczby od 0 do 8000.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

Zwraca obliczone atrybuty formatu, które obowiązują dla danego elementu. Uwzględnia dziedziczenie atrybutów z elementów nadrzędnych.

Powiązane elementy interfejsu API

Zwraca właściwość coreStyles tego obiektu FlowElement. Metoda pobierająca tworzy kopię słownika stylów głównych. Obiekt coreStyles opakowuje formaty zdefiniowane w klasie TextLayoutFormat i podane we właściwości TextLayoutFormat.description. Obiekt coreStyles składa się z tablicy par nazwa_stylu-wartość.

Powiązane elementy interfejsu API

TextLayoutFormat: sposób różnicowania wielkości cyfr w tekście. Wartość DigitCase.OLD_STYLE powoduje, że cyfry są zbliżone wielkością do małych liter, z różną wielkością elementów górnych i dolnych. Liczby są rozkładane w sposób proporcjonalny. Ten styl jest dostępny tylko w niektórych krojach pisma, w szczególności w czcionce dodatkowej lub klasy ekspert. Ustawienie DigitCase.LINING powoduje, że cyfry mają wielkość kapitalików i zwykle mają stałą szerokość, tak aby można je było wyrównać w kolumnach tabel.

Wartości dozwolone: DigitCase.DEFAULT, DigitCase.LINING, DigitCase.OLD_STYLE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość DigitCase.DEFAULT.

Powiązane elementy interfejsu API

TextLayoutFormat: Szerokość cyfr stosowana w tym tekście. Możliwe ustawienia to DigitWidth.PROPORTIONAL, z którym najlepiej prezentują się pojedyncze liczby, oraz DigitWidth.TABULAR, z którym najlepiej prezentują się liczby w tabelach, zestawieniach i wierszach obróconych do pionu.

Wartości dozwolone: DigitWidth.DEFAULT, DigitWidth.PROPORTIONAL, DigitWidth.TABULAR, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość DigitWidth.DEFAULT.

Powiązane elementy interfejsu API

TextLayoutFormat: określa domyślny dwukierunkowy poziom osadzenia tekstu w bloku tekstu. Kolejność odczytu od lewej do prawej, jak w skryptach w stylu łacińskim, lub od prawej do lewej, jak w języku arabskim lub hebrajskim. Ta właściwość wpływa również na kierunek kolumny po zastosowaniu jej na poziomie kontenera. Kolumny mogą być czytane od lewej do prawej lub na odwrót, podobnie jak tekst. Poniżej przedstawiono kilka przykładów:

Wartości dozwolone: Direction.LTR, Direction.RTL, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość Direction.LTR.

Powiązane elementy interfejsu API

TextLayoutFormat: określa, która linia bazowa elementów jest przyciągana do linii alignmentBaseline w celu ustalenia pionowego położenia elementu w wierszu. Wartość TextBaseline.AUTO powoduje, że dominująca linia bazowa jest wybierana na podstawie właściwości locale nadrzędnego akapitu. W językach japońskim i chińskim wybraną wartością linii bazowej jest TextBaseline.IDEOGRAPHIC_CENTER; we wszystkich innych językach wybierana jest wartość TextBaseline.ROMAN. Te ustawienia linii bazowych są określane w zależności od czcionki oraz rozmiaru czcionki.

Wartości dozwolone: FormatValue.AUTO, TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: określa położenie linii bazowej dla pierwszego wiersza w kontenerze. Ustawienia narodowe na poziomie kontenera określają, do której linii bazowej odwołuje się ta właściwość. W językach japońskim i chińskim przyjmowana jest wartość TextBaseline.IDEOGRAPHIC_BOTTOM; we wszystkich innych językach przyjmowana jest wartość TextBaseline.ROMAN. Przesunięcie od górnego zwężenia (lub prawego zwężenia, jeśli blockProgression ma wartość RL) kontenera do linii bazowej pierwszego wiersza może mieć wartość BaselineOffset.ASCENT, co oznacza równość górnemu wydłużeniu wiersza; BaselineOffset.LINE_HEIGHT, co oznacza równość wysokości pierwszego wiersza, lub dowolną stałą wartość w celu określenia odległości bezwzględnej. BaselineOffset.AUTO zrównuje wydłużenie górne wiersza z górnym zwężeniem kontenera.

Wartości dozwolone to ciągi BaselineOffset.AUTO, BaselineOffset.ASCENT, BaselineOffset.LINE_HEIGHT i FormatValue.INHERIT oraz liczby od 0 do 1000.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość BaselineOffset.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: nazwa użytej czcionki lub lista nazw czcionek oddzielonych od siebie przecinkami. Środowisko wykonawcze Flash renderuje element za pomocą pierwszej dostępnej czcionki na liście. Na przykład „Arial, Helvetica, _sans” powoduje, że odtwarzacz wyszukuje czcionkę „Arial”, a w przypadku nieznalezienia czcionki Arial — „Helvetica”, a jeśli obie powyższe czcionki nie zostaną znalezione, wyszukuje czcionkę _sans.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość Arial.

TextLayoutFormat: sposób wyszukiwania czcionek. Wartość FontLookup.DEVICE powoduje użycie czcionek zainstalowanych w systemie, w którym jest uruchomiony plik SWF. Wybranie czcionek urządzenia powoduje wyświetlanie filmów mniejszej wielkości, ale tekst nie jest zawsze renderowany w ten sam sposób, na różnych systemach i platformach. Wartość FontLookup.EMBEDDED_CFF powoduje użycie konturów czcionek osadzonych w opublikowanym pliku SWF. Czcionki osadzone zwiększają wielkość pliku SWF (czasami bardzo istotnie), ale tekst jest stale wyświetlany w wybranej czcionce.

Wartości dozwolone FontLookup.DEVICE, FontLookup.EMBEDDED_CFF, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość FontLookup.DEVICE.

Powiązane elementy interfejsu API

TextLayoutFormat: rozmiar tekstu w pikselach.

Wartości dozwolone to liczby od 1 do 720 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 12.

TextLayoutFormat: styl tekstu. Możliwe wartości to FontPosture.NORMAL, czyli tekst zwykły, albo FontPosture.ITALIC, czyli kursywa. Ta właściwość ma zastosowanie tylko do czcionek urządzenia (właściwość fontLookup jest ustawiona na flash.text.engine.FontLookup.DEVICE).

Wartości dozwolone: FontPosture.NORMAL, FontPosture.ITALIC, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość FontPosture.NORMAL.

Powiązane elementy interfejsu API

TextLayoutFormat: grubość tekstu. Możliwe wartości to FontWeight.NORMAL, czyli tekst zwykły, albo FontWeight.BOLD, czyli tekst pogrubiony. Stosowane tylko do czcionek urządzenia (właściwość fontLookup jest ustawiona na flash.text.engine.FontLookup.DEVICE).

Wartości dozwolone: FontWeight.NORMAL, FontWeight.BOLD, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość FontWeight.NORMAL.

Powiązane elementy interfejsu API

Właściwości TextLayoutFormat są stosowane bezpośrednio do tego elementu.

Każdy element może zawierać właściwości stosowane do niego jako część formatu. Właściwości stosowane dla tego elementu przesłaniają właściwości dziedziczone z elementu nadrzędnego. Właściwości zastosowane do tego elementu będą dziedziczone przez jego elementy podrzędne, pod warunkiem że nie zostaną przesłonięte w elemencie podrzędnym. Jeśli żadne wartości nie zostaną zastosowane do elementu, będzie to wartość null.

Powiązane elementy interfejsu API

Przypisuje identyfikującą nazwę do elementu, umożliwiając ustawienie stylu dla elementu poprzez utworzenie odniesienia do identyfikatora. Na przykład: poniższy wiersz ustawia kolor dla obiektu SpanElement, który ma identyfikator o wartości span1:

         textFlow.getElementByID("span1").setStyle("color", 0xFF0000);
         

Powiązane elementy interfejsu API

TextLayoutFormat: reguła justowania tekstu w akapicie. Wartość domyślna, FormatValue.AUTO, oznacza justowanie tekstu zgodnie z właściwością locale akapitu. W przypadku wszystkich języków z wyjątkiem japońskiego i chińskiego wartość FormatValue.AUTO jest równoważna wartości JustificationRule.SPACE, co powoduje powiększanie spacji. W przypadku języków japońskiego i chińskiego wartość FormatValue.AUTO jest równoważna JustficationRule.EAST_ASIAN. Justowanie do pewnego stopnia zależy od odstępów między znakami interpunkcyjnymi. W tekście łacińskim i japońskim kropki zajmują szerokość całego znaku, ale w językach wschodnioazjatyckich tylko połowę szerokości znaku. Ponadto w tekście w językach wschodnioazjatyckich odstępy między sąsiednimi znakami interpunkcyjnymi są zmniejszone, zgodnie z tradycyjnymi wschodnioazjatyckimi konwencjami typograficznymi. W poniższym przykładzie należy ponadto zwrócić uwagę na interlinię drugiego wiersza każdego akapitu. W wersji East Asian dwa ostatnie wiersze są przesunięte w lewo. W wersji Roman drugi i kolejne wiersze są przesunięte w lewo.

Wartości dozwolone: JustificationRule.EAST_ASIAN, JustificationRule.SPACE, FormatValue.AUTO, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: styl justowania akapitu. Używane tylko w połączeniu z ustawieniem justificationRule JustificationRule.EAST_ASIAN. Wartość domyślna FormatValue.AUTO jest przy wszystkich ustawieniach narodowych równoważna wartości JustificationStyle.PUSH_IN_KINSOKU. Stałe zdefiniowane w klasie JustificationStyle określają opcje obsługujące znaki kinsoku, będące znakami w alfabecie japońskim, które nie mogą pojawiać się na początku ani na końcu wiersza. W celu zwiększenia odstępów między znakami w tekście należy wybrać JustificationStyle.PUSH-OUT-ONLY. W celu uzyskania efektu przypominającego zastosowanie reguły justificationRule z JustificationRule.SPACE należy użyć stylu JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT.

Wartości dozwolone: JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, JustificationStyle.PUSH_IN_KINSOKU, JustificationStyle.PUSH_OUT_ONLY, FormatValue.AUTO, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: kerning dopasowuje piksele pomiędzy określonymi parami znaków w celu poprawienia czytelności. Kerning jest obsługiwany dla wszystkich rodzajów czcionek zawierających tabele kerningu.

Wartości dozwolone: Kerning.ON, Kerning.OFF, Kerning.AUTO, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość Kerning.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: określa model interlinii, czyli ustawienia podstawy i kierunku interlinii. Podstawą odstępu między wierszami jest linia bazowa, do której odwołuje się właściwość lineHeight. Kierunek odstępu między wierszami określa, czy właściwość lineHeight dotyczy odległości linii bazowej wiersza od linii bazowej poprzedniego, czy następnego wiersza. Wartość domyślna FormatValue.AUTO jest interpretowana na podstawie właściwości locale akapitu. W przypadku języka japońskiego i chińskiego przyjmowana jest wartość LeadingModel.IDEOGRAPHIC_TOP_DOWN, a we wszystkich pozostałych językach — wartość LeadingModel.ROMAN_UP.

Podstawa interlinii:

Kierunek interlinii:

Wartości dozwolone: LeadingModel.ROMAN_UP, LeadingModel.IDEOGRAPHIC_TOP_UP, LeadingModel.IDEOGRAPHIC_CENTER_UP, LeadingModel.IDEOGRAPHIC_TOP_DOWN, LeadingModel.IDEOGRAPHIC_CENTER_DOWN, LeadingModel.APPROXIMATE_TEXT_FIELD, LeadingModel.ASCENT_DESCENT_UP, LeadingModel.BOX, LeadingModel.AUTO, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość LeadingModel.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: określa, które z ligatur zdefiniowanych w czcionce mogą być używane w tekście. Ligatury, jakie pojawiają się dla poszczególnych tych ustawień, są uzależnione od czcionki. Ligatura pojawia się w miejscach, w których dwie lub większa liczba liter jest połączona w jeden glif. Ligatury zazwyczaj zastępują sąsiednie znaki ze wspólnymi typowymi składnikami, takie jak pary liter „fi”, „fl” czy „ae”. Używane są zarówno z zestawami znaków łacińskich, jak i niełacińskich. Zbiory ligatur aktywowane przez wartości klasy LigatureLevel — MINIMUM, COMMON, UNCOMMON i EXOTIC — sumują się. Każda wartość zezwala teraz na użycie nowego zbioru ligatur, ale jednocześnie obejmuje poprzednie zbiory.

Uwaga: Podczas pracy z czcionkami języka arabskiego lub syryjskiego wartość ligatureLevel należy ustawić na MINIMUM lub większą.

Wartości dozwolone: LigatureLevel.MINIMUM, LigatureLevel.COMMON, LigatureLevel.UNCOMMON, LigatureLevel.EXOTIC, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość LigatureLevel.COMMON.

Powiązane elementy interfejsu API

TextLayoutFormat: steruje podziałem wyrazów między wiersze w kontenerze (jeśli wartość przekazana kaskadowo jest równa undefined, przyjmowana jest wartość domyślna). Tekst w kontenerze można ustawić w taki sposób, aby był dopasowany do szerokości kontenera (LineBreak.TO_FIT), lub w taki sposób, aby podział wiersza był dozwolony tylko przy znakach powrotu lub nowego wiersza (LineBreak.EXPLICIT).

Wartości dozwolone: LineBreak.EXPLICIT, LineBreak.TO_FIT, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, zostanie przyjęta wartość LineBreak.TO_FIT.

Powiązane elementy interfejsu API

TextLayoutFormat: specyfikacja interlinii tekstu. Odległość od linii bazowej poprzedniego lub następnego wiersza (w zależności od LeadingModel) do linii bazowej bieżącego wiersza jest równa maksymalnej odległości odstępu między wierszami zastosowanej dla dowolnego znaku w wierszu. Jest to liczba lub wartość procentowa. Jeśli określona jest wartość procentowa, należy wprowadzić ciąg znaków, np. 140%.

Poprawne wartości liczbowe należą do zakresu od -720 do 720.

Dozwolone są wartości procentowe z zakresu od -1000% do 1000%.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 120%.

TextLayoutFormat: wartość true powoduje zastosowanie przekreślenia, czyli linii biegnącej przez środek wiersza tekstu.

Wartości dozwolone to true, false oraz FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość false.

TextLayoutFormat: Definiuje atrybuty formatujące używane dla łączy w stanie normalnym. Ta wartość jest przekazywana w dół w hierarchii i jest stosowana do wszystkich podrzędnych łączy. Akceptuje wartość inherit zdefiniowaną w klasie ITextLayoutFormat lub konwertuje tablicę obiektów z kluczami i wartościami na obiekt TextLayoutFormat.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość null.

TextLayoutFormat: Definiuje atrybuty formatowania używane dla łączy w stanie wskazywania, gdy wskaźnik myszy znajduje się w obrębie obwiedni łącza (nasuwanie kursora). Ta wartość jest przekazywana w dół w hierarchii i jest stosowana do wszystkich podrzędnych łączy. Akceptuje wartość inherit zdefiniowaną w klasie ITextLayoutFormat lub konwertuje tablicę obiektów z kluczami i wartościami na obiekt TextLayoutFormat.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość null.

TextLayoutFormat: Definiuje atrybuty formatujące używane dla łączy w stanie normalnym. Ta wartość jest przekazywana w dół w hierarchii i jest stosowana do wszystkich podrzędnych łączy. Akceptuje wartość inherit zdefiniowaną w klasie ITextLayoutFormat lub konwertuje tablicę obiektów z kluczami i wartościami na obiekt TextLayoutFormat.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość null.

TextLayoutFormat: Określa automatyczne wcięcie dla krawędzi początkowych list w przypadkach, gdy wartość dopełnienia listy po danej stronie wynosi auto.

Wartości dozwolone to liczby od –1000 do 1000 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość 40.

TextLayoutFormat: Definiuje znaczniki formatowania list atrybutów. Ta wartość jest przekazywana w dół w hierarchii i jest stosowana do wszystkich łączy potomnych. Akceptuje wartość inherit zdefiniowaną w klasie IListMarkerFormat lub konwertuje tablicę obiektów z kluczami i wartościami na obiekt ListMarkerFormat.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość null.

TextLayoutFormat:

Wartości dozwolone: ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość ListStylePosition.OUTSIDE.

Powiązane elementy interfejsu API

TextLayoutFormat:

Wartości dozwolone: 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.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość ListStyleType.DISC.

Powiązane elementy interfejsu API

TextLayoutFormat: ustawienia narodowe tekstu. Steruje przekształceniami i ustalaniem kształtów dla wielkości liter. Używane są standardowe identyfikatory ustawień narodowych opisane w standardzie technicznym Unicode nr 35. Na przykład: en, en_US i en-US oznaczają język angielski, ja oznacza język japoński Japanese.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość en.

TextLayoutFormat: Wstawka dolna w pikselach. Domyślne ustawienie automatyczne wynosi zero z wyjątkiem list, w przypadku których początkowe dopełnienie boczne wynosi 45. (W przypadku wartości undefined przekazanej kaskadowo jest przyjmowana wartość domyślna). Odstęp między dolną krawędzią kontenera a tekstem. Wartości dozwolone to liczby i ciąg auto.

W przypadku tekstu poziomego w kontenerach przewijanych z wieloma kolumnami pierwsza kolumna i kolejne kolumny przedstawiają dopełnienie jako odstęp u dołu kontenera, ale w przypadku ostatniej kolumny (jeśli cały tekst się nie mieści) konieczne może być przewinięcie w celu wyświetlenia dopełnienia.

Wartości dozwolone to ciągi FormatValue.AUTO i FormatValue.INHERIT oraz liczby od –8000 do 8000.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: Lewa wstawka w pikselach. Domyślne ustawienie automatyczne wynosi zero z wyjątkiem list, w przypadku których początkowe dopełnienie boczne wynosi 45. (W przypadku wartości undefined przekazanej kaskadowo jest przyjmowana wartość domyślna). Odstęp między lewą krawędzią kontenera a tekstem. Wartości dozwolone to liczby i ciąg auto.

W przypadku tekstu pionowego w kontenerach przewijanych z wieloma kolumnami pierwsze i kolejne kolumny przedstawiają dopełnienie jako pusty odstęp na końcu kontenera, ale w przypadku ostatniej kolumny (jeśli cały tekst się nie mieści) konieczne może być przewinięcie w celu wyświetlenia dopełnienia.

Wartości dozwolone to ciągi FormatValue.AUTO i FormatValue.INHERIT oraz liczby od –8000 do 8000.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: Prawa wstawka w pikselach. Domyślne ustawienie automatyczne wynosi zero z wyjątkiem list, w przypadku których początkowe dopełnienie boczne wynosi 45. (W przypadku wartości undefined przekazanej kaskadowo jest przyjmowana wartość domyślna). Odstęp między prawą krawędzią kontenera a tekstem. Wartości dozwolone to liczby i ciąg auto.

Wartości dozwolone to ciągi FormatValue.AUTO i FormatValue.INHERIT oraz liczby od –8000 do 8000.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: Górna wstawka w pikselach. Domyślne ustawienie automatyczne wynosi zero z wyjątkiem list, w przypadku których początkowe dopełnienie boczne wynosi 45. (W przypadku wartości undefined przekazanej kaskadowo jest przyjmowana wartość domyślna). Odstęp między górną krawędzią kontenera a tekstem. Wartości dozwolone to liczby i ciąg auto.

Wartości dozwolone to ciągi FormatValue.AUTO i FormatValue.INHERIT oraz liczby od –8000 do 8000.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość FormatValue.AUTO.

Powiązane elementy interfejsu API

TextLayoutFormat: liczba określająca (w pikselach) wielkość wcięcia końcowej krawędzi akapitu. Oznacza prawą krawędź w tekście zapisanym od lewej do prawej i lewą krawędź w tekście zapisanym od prawej do lewej strony.

Wartości dozwolone to liczby od 0 do 8000 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

TextLayoutFormat: liczba, która określa w pikselach ilość miejsca, jaką należy pozostawić za akapitem. Zwijane razem z odstępem paragraphSpaceBefore.

Wartości dozwolone to liczby od 0 do 8000 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

TextLayoutFormat: liczba, która określa w pikselach ilość miejsca, jaką należy pozostawić przed akapitem. Zwijane razem z odstępem paragraphSpaceAfter.

Wartości dozwolone to liczby od 0 do 8000 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

TextLayoutFormat: liczba określająca (w pikselach) wielkość wcięcia początkowej krawędzi akapitu. Oznacza lewą krawędź w tekście zapisanym od lewej do prawej i prawą krawędź w tekście zapisanym od prawej do lewej strony.

Wartości dozwolone to liczby od 0 do 8000 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

Zwraca obiekt nadrzędny danego obiektu FlowElement. Każdy obiekt FlowElement ma maksymalnie jeden element nadrzędny.

Zwraca względny koniec danego obiektu FlowElement w elemencie nadrzędnym. Jeśli obiekt nadrzędny ma wartość null, wówczas zwracana jest zawsze wartość textLength. Jeśli obiekt nadrzędny ma wartość inną niż null, wartość jest sumą długości danego tekstu i wszystkich poprzednich obiektów siostrzanych, co zwykle określa położenie pierwszego znaku w kolejnym obiekcie FlowElement.

Powiązane elementy interfejsu API

Zwraca względny początek danego obiektu FlowElement w elemencie nadrzędnym. Jeśli element nadrzędny ma wartość null, ta wartość jest zawsze równa zero. Jeśli element nadrzędny nie jest równy null, ta wartość jest sumą długości tekstów z wszystkich poprzednich obiektów siostrzanych.

Powiązane elementy interfejsu API

TextLayoutFormat: tryb renderowania używany dla tego tekstu. Ma zastosowanie tylko do czcionek osadzonych (właściwość fontLookup ustawiona na FontLookup.EMBEDDED_CFF).

Wartości dozwolone: RenderingMode.NORMAL, RenderingMode.CFF, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość RenderingMode.CFF.

Powiązane elementy interfejsu API

TextLayoutFormat: Przypisuje klasę identyfikującą do elementu, umożliwiając ustawienie stylu dla elementu za pomocą odniesienia do właściwości styleName.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, zostanie przyjęta wartość null.

Zwraca właściwość styles tego obiektu FlowElement. Metoda pobierająca tworzy kopię słownika stylów. Zwrócony obiekt opakowuje wszystkie style ustawione we właściwości format, również styl główny i style użytkownika. Zwracany obiekt składa się z tablicy par nazwa_stylu-wartość.

Powiązane elementy interfejsu API

TextLayoutFormat: określa znaczniki tabulacji skojarzone z akapitem. Metody ustawiające mogą przyjmować tablicę obiektów TabStopFormat, zagęszczoną reprezentację ciągu, wartość undefined lub wartość FormatValue.INHERIT. Zagęszczona reprezentacja ciągu jest zawsze konwertowana na tablicę obiektów TabStopFormat.

Format oparty na łańcuchu jest listą znaczników tabulacji, gdzie każdy znacznik jest ograniczony przez jedną lub większą liczbę spacji.

Znacznik tabulacji ma następującą formę: <typ wyrównania><położenie wyrównania>|<token wyrównania>.

Typ wyrównania jest jednym znakiem i może to być znak S, E, C lub D (albo równoważniki w postaci małych liter). S lub s dla rozpoczęcia, E lub e dla zakończenia, C lub c dla środka, D lub d dla wartości dziesiętnej. Typ wyrównania jest opcjonalny i nie jest określony z domyślną wartością S.

Pozycją wyrównania jest liczba, która jest określona zgodnie ze specyfikacją FXG dla liczb (zapis dziesiętny lub naukowy). Położenie wyrównania jest wymagane.

Pasek pionowy służy do oddzielania położenia wyrównania od tokenu wyrównania i powinien być używany tylko wówczas, gdy istnieje token wyrównania.

Token wyrównania jest opcjonalny, jeśli typem wyrównania jest D i nie powinien być określany, jeśli typ wyrównania jest inny niż D. Token wyrównania może być dowolną sekwencją znaków zakończoną spacją, która kończy znacznik tabulatora (w przypadku ostatniego znacznika tabulatora znak spacji jest opcjonalny; przyjmowany jest koniec tokenu wyrównania). Spacja może być częścią tokenu wyrównania, jeśli token jest zakończony ukośnikiem w lewo (\). Ukośnik w lewo może być częścią tokenu wyrównania, jeśli jest on zakończony kolejnym ukośnikiem w lewo (\\). Jeśli typ wyrównania to D, a token wyrównania nie jest określony, przyjmie on wartość domyślną null.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość null.

Powiązane elementy interfejsu API

TextLayoutFormat: wyrównanie wierszy akapitu względem kontenera. TextAlign.LEFT powoduje wyrównywanie wierszy do lewej krawędzi kontenera. TextAlign.RIGHT powoduje wyrównywanie do prawej krawędzi. TextAlign.CENTER powoduje, że wiersz jest ustawiany w równej odległości od lewej i prawej krawędzi. TextAlign.JUSTIFY powoduje rozstrzelenie wierszy tak, aby zajmowały całe dostępne miejsce. TextAlign.START to równoważnik ustawienia „left” w tekście zapisanym od lewej do prawej albo ustawienia „right” w tekście zapisanym od prawej do lewej. TextAlign.END to równoważnik ustawienia „right” w tekście zapisanym od lewej do prawej albo ustawienia „left” w tekście zapisanym od prawej do lewej.

Wartości dozwolone: TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość TextAlign.START.

Powiązane elementy interfejsu API

TextLayoutFormat: wyrównanie ostatniego (lub jedynego) wiersza tekstu justowanego w akapicie względem kontenera. Jeśli właściwość textAlign jest ustawiona na TextAlign.JUSTIFY, textAlignLast określa sposób wyrównania ostatniego wiersza (lub jedynego wiersza w bloku jednowierszowym). Wartości są podobne do textAlign.

Wartości dozwolone: TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość TextAlign.START.

Powiązane elementy interfejsu API

TextLayoutFormat: wartość Alfa (przezroczystość) dla tekstu. Wartość 0 określa całkowitą przezroczystość, a wartość 1 określa całkowitą nieprzezroczystość. Obiekty wyświetlane z właściwością textAlpha ustawioną na 0 są aktywne, mimo że są niewidoczne.

Wartości dozwolone to liczby od 0 do 1 oraz FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 1.

TextLayoutFormat: dekoracja tekstu. Używane w celu zastosowania podkreślenia; domyślnie: none.

Wartości dozwolone: TextDecoration.NONE, TextDecoration.UNDERLINE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość TextDecoration.NONE.

Powiązane elementy interfejsu API

TextLayoutFormat: liczba określająca w pikselach wcięcie pierwszego wiersza akapitu. Wcięcie ujemne spowoduje przesunięcie wiersza na margines — prawdopodobne jest również przesunięcie poza kontener.

Wartości dozwolone to liczby od –8000 do 8000 oraz ciąg FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

TextLayoutFormat: określa opcje justowania tekstu. Wartość domyślna TextJustify.INTER_WORDoznacza powiększanie znaków spacji. TextJustify.DISTRIBUTE powoduje powiększanie znaków spacji i odstępów między literami. Ta wartość jest używana tylko wtedy, gdy właściwość justificationRule jest równa JustificationRule.SPACE.

Wartości dozwolone: TextJustify.INTER_WORD, TextJustify.DISTRIBUTE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość TextJustify.INTER_WORD.

Powiązane elementy interfejsu API

Zwraca całkowitą długość tekstu, którego właścicielem jest obiekt FlowElement oraz jego obiekty podrzędne. Jeśli element nie zawiera tekstu, wartość textLength jest zwykle równa zero.

Końcowe zakresy w obiektach ParagraphElement zawierają znak zakończenia akapitu dla ostatniego obiektu SpanElement. Znak zakończenia akapitu jest zawarty w wartości textLength obiektu SpanElement oraz wszystkich jego elementów nadrzędnych. Znak nie znajduje się we właściwości text obiektu SpanElement.

Powiązane elementy interfejsu API

TextLayoutFormat: kąt obrotu tego tekstu w stopniach.

Wartości dozwolone: TextRotation.ROTATE_0, TextRotation.ROTATE_180, TextRotation.ROTATE_270, TextRotation.ROTATE_90, TextRotation.AUTO, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość TextRotation.AUTO.

Powiązane elementy interfejsu API

Ustawia światło i działa tak samo, jak właściwość trackingRight. Określone jako liczba pikseli lub procent fontSize.

Powiązane elementy interfejsu API

TextLayoutFormat: liczba pikseli (lub procent wartości fontSize, np. 120%) wskazująca ilość światła (kerning ręczny) do zastosowania po lewej stronie każdego znaku. Jeśli kerning został włączony, wartość trackingLeft jest dodawana do wartości w tabeli kerningu czcionki. Jeśli kerning został wyłączony, wartość trackingLeft jest używana jako wartość kerningu ręcznego. Obsługuje wartości dodatnie i ujemne.

Poprawne wartości liczbowe należą do zakresu od –1000 do 1000.

Dozwolone są wartości procentowe z zakresu od -1000% do 1000%.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

TextLayoutFormat: liczba pikseli (lub procent wartości fontSize, np. 120%) wskazująca ilość światła (kerning ręczny) do zastosowania po prawej stronie każdego znaku. Jeśli kerning został włączony, wartość trackingRight jest dodawana do wartości w tabeli kerningu czcionki. Jeśli kerning został wyłączony, wartość trackingRight jest używana jako wartość kerningu ręcznego. Obsługuje wartości dodatnie i ujemne.

Poprawne wartości liczbowe należą do zakresu od –1000 do 1000.

Dozwolone są wartości procentowe z zakresu od -1000% do 1000%.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli w żadnym obiekcie nadrzędnym ta właściwość nie będzie ustawiona, przyjęta zostanie wartość 0.

Każdy obiekt FlowElement ma właściwość typeName. Właściwość typeName jest domyślnie ciągiem użytym we właściwości TextConverter obiektu textLayoutFormat. Ten interfejs API pozwala ustawić inną właściwość typeName obiektu FlowElement. Zwykle ma to na celu zapewnienie obsługi selektorów type w arkuszach CSS.

Sposób ich używania opisano w dokumentacji właściwości TEXT_FIELD_HTML_FORMAT.

Powiązane elementy interfejsu API

TextLayoutFormat: sposób różnicowania wielkości liter w tekście. Oto kilka przykładów:

Wartości dozwolone: TLFTypographicCase.DEFAULT, TLFTypographicCase.CAPS_TO_SMALL_CAPS, TLFTypographicCase.UPPERCASE, TLFTypographicCase.LOWERCASE, TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość TLFTypographicCase.DEFAULT.

Powiązane elementy interfejsu API

Umożliwia odczytywanie i zapisywanie stylów użytkownika w obiekcie FlowElement. Odczytanie tej właściwości powoduje wykonanie kopii właściwości userStyles ustawionej w formacie tego elementu.

TextLayoutFormat: wyrównanie pionowe lub justowanie (jeśli wartość przekazana kaskadowo jest równa undefined, przyjmowana jest wartość domyślna). Określa, w jaki sposób elementy TextFlow są wyrównywane w kontenerze.

Wartości dozwolone: VerticalAlign.TOP, VerticalAlign.MIDDLE, VerticalAlign.BOTTOM, VerticalAlign.JUSTIFY, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli przekazana kaskadowo właściwość będzie miała wartość undefined, ta właściwość przyjmie wartość VerticalAlign.TOP.

Powiązane elementy interfejsu API

TextLayoutFormat: powoduje usuwanie albo zachowywanie białych znaków podczas importowania tekstu do obiektu TextFlow. WhiteSpaceCollapse.PRESERVE powoduje zachowywanie wszystkich białych znaków. WhiteSpaceCollapse.COLLAPSE powoduje usuwanie znaków nowego wiersza, znaków tabulacji i spacji wiodących lub końcowych z bloku importowanego tekstu. Zachowywane są znaczniki podziału wiersza () oraz znaki separatorów wiersza Unicode.

Wartości dozwolone: WhiteSpaceCollapse.PRESERVE, WhiteSpaceCollapse.COLLAPSE, FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość WhiteSpaceCollapse.COLLAPSE.

Powiązane elementy interfejsu API

TextLayoutFormat: Określa optymalny, minimalny i maksymalny odstęp między wyrazami (jako mnożnik szerokości normalnego odstępu) obowiązujący przy justowaniu. Optymalny odstęp pozwala określić żądany rozmiar odstępu jako ułamek wartości zdefiniowanej w czcionce. Wartości minimalna i maksymalna są używane, gdy właściwość textJustify ma wartość distribute. Określają graniczne szerokości odstępów między wyrazami, których przekroczenie powoduje justowanie wiersza na podstawie odstępów między literami.

Dozwolone są wartości procentowe z zakresu od -1000% do 1000%.

Wartość dozwolona: FormatValue.INHERIT.

Wartość domyślna, undefined, oznacza, że właściwość nie jest ustawiona.

Jeśli wartość undefined zostanie przekazana kaskadowo, właściwość odziedziczy wartość z obiektu nadrzędnego. Jeśli ta właściwość nie będzie ustawiona w żadnym obiekcie macierzystym, przyjęta zostanie wartość 100%, 50%, 150%.

Klasa bazowa — wywołanie nowej metody FlowElement() powoduje zgłoszenie wyjątku.

Usuwa styl określony przez parametr styleProp z danego obiektu FlowElement. Ustawia wartość undefined.

Parametry

Powiązane elementy interfejsu API

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 FlowElement_clearStyleExample extends Sprite{    
        public function FlowElement_clearStyleExample()
        {
            // create a container and a TextFlow object
            var container:Sprite = new Sprite();
            this.addChild(container);
            var textFlow:TextFlow = new TextFlow();
            
            // create a paragraph and set lineThrough style to true 
            var paragraph:ParagraphElement = new ParagraphElement();
            paragraph.setStyle("color", 204);
            // create two spans of text
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();            
            span1.text = "After calling clearStyle(), the value of color for span1 is: ";     
            span2.text = " but the value of span1.getStyle() for color is ";
            span3.text = " because getStyle() returns the inherited value that's applied to the style.";
            span1.clearStyle("color");        // undefined
            span1.text += span1.color;
            paragraph.addChild(span1);
            paragraph.addChild(span2);
            span2.text += span1.getStyle("color");    //204 
            paragraph.addChild(span3);
            
            textFlow.addChild(paragraph);
            // add controller, then update controller to display text
            var firstController:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(firstController);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

Tworzy głęboką kopię tego obiektu FlowElement wraz z wszelkimi elementami potomnymi, kopiując zawartość między dwoma określonymi położeniami znaków oraz zwracając kopię jako obiekt FlowElement.

W przypadku braku argumentów metoda deepCopy() domyślnie kopiuje cały element.

Parametry

Powiązane elementy interfejsu API

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 FlowElement_deepCopyExample extends Sprite{    
        public function FlowElement_deepCopyExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            // add text to the spans and spans to the paragraph
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            // make a deep copy of paragraph p, starting at relative offset 3; copy to end
            var p2:ParagraphElement = p.deepCopy(3, -1) as ParagraphElement; 
            // add copied paragraph (p2) to textflow; add composer and controller 
            // and update controller to display text
            textFlow.addChild(p2);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();    // 'lo, World!'
        }
    }
}

Porównanie stylów userStyle danej kopii ze stylami userStyle innego elementu otherElement.

Parametry

Powiązane elementy interfejsu API

Zwraca położenie początkowe elementu w przepływie tekstu w postaci indeksu bezwzględnego. Pierwszy znak w przepływie ma położenie 0.

Powiązane elementy interfejsu API

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 FlowElement_getAbsoluteStartExample extends Sprite
    {    
        public function FlowElement_getAbsoluteStartExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            // add text to the spans, spans to the paragraph, and paragraph to the text flow
            span1.text = "The start of span2 ";
            span2.text = "in this paragraph is at index: ";
            p.fontSize = 20;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            // find the starting position of span2 and update controller to display text
            span2.text += span2.getAbsoluteStart();  // 19
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

Zwraca znak w określonym położeniu względem danego obiektu FlowElement. Pierwszy znak znajduje się w położeniu względnym 0.

Parametry

Powiązane elementy interfejsu API

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 FlowElement_getCharAtPositionExample extends Sprite
    {        
        public function FlowElement_getCharAtPositionExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
                        
            //create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to the two spans, calling getCharAtPosition() to return the
            // character at relative position 27 in the first span
            span1.text = "The character at offset 27 in this paragraph is: ";
            span2.text =  span1.getCharAtPosition(27) + ".";    // i
            
            // add spans to paragraph p   
            p.addChild(span1);
            p.addChild(span2);
            
            // add paragraph p to text flow and update controller to display it
            textFlow.addChild(p);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

Zwraca kod znaku w określonym położeniu względem danego obiektu FlowElement. Pierwszy znak znajduje się w położeniu względnym 0.

Parametry

Powiązane elementy interfejsu API

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 FlowElement_getCharCodeAtPositionExample extends Sprite
    {        
        public function FlowElement_getCharCodeAtPositionExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
            
            //create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to spans; use getCharCodeAtPosition() to add char code from pos. 16
            // of span1
            
            span1.text = "The character code at offset 16 in this paragraph is: ";
            span2.text =  String(span1.getCharCodeAtPosition(16)) + ".";    // 100 (d)
            
            // add spans to paragraph p   
            p.addChild(span1);
            p.addChild(span2);
            
            // add paragraph p to text flow and update controller to display it
            textFlow.addChild(p);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

Zwraca początek tego elementu względem elementu przodka. Zakłada, że element przodka znajduje się łańcuchu nadrzędnym. Jeśli element przodka jest elementem nadrzędnym, wówczas początek jest taki sam, jak this.parentRelativeStart. Jeśli element przodka jest wyżej w hierarchii niż jego bezpośredni element nadrzędny, wówczas początek jest taki sam, jak wyznaczony przez sumę parentRelativeStart plus parent.parentRelativeStart itd.

Parametry

Powiązane elementy interfejsu API

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getElementRelativeStartExample extends Sprite
    {        
        public function FlowElement_getElementRelativeStartExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
            
            //create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();
            
            // add text to first two spans
            span1.text = "The relative start of the link SpanElement (";
            span2.text =  ") in this paragraph is at position ";
            
            // create link span, add text and corresponding URL and add to link
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "Adobe's website";
            link.href = "http://www.adobe.com";
            link.addChild(linkSpan);
            
            // add first span, link, and second span to paragraph p   
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            
            // call getElementRelativeStart() to get start of linkSpan and add to span 3
            span3.text = String(linkSpan.getElementRelativeStart(p)) + ".";  // 44.
            p.addChild(span3);
            
            // add paragraph p to text flow and update controller to display it
            textFlow.addChild(p);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

Zwraca następny obiekt równorzędny FlowElement z hierarchii przepływu tekstu.

Powiązane elementy interfejsu API

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 FlowElement_getNextSiblingExample extends Sprite
    {        
        public function FlowElement_getNextSiblingExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var nextSpanElement:SpanElement = new SpanElement();
            // add text, set font size, add spans to paragraph, add paragraph to text flow
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            // get next SpanElement for span1 and set its color to red; display text
            nextSpanElement = SpanElement(span1.getNextSibling());
            nextSpanElement.color = 0xCC0000;
            textFlow.flowComposer.addController(new ContainerController(this,stage.stageWidth,stage.stageHeight));
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

Zwraca obiekt ParagraphElement skojarzony z danym elementem. Przeszukuje hierarchię przepływu tekstu i zwraca obiekt ParagraphElement.

Powiązane elementy interfejsu API

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getParagraphExample extends Sprite
    {        
        public function FlowElement_getParagraphExample()
        {
            // create a container and a controller for it and add to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
                        
            //create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to first span
            span1.text = "Text that includes a link to ";
            
            // create link span, add text and corresponding URL and add to link
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "Adobe's website";
            link.href = "http://www.adobe.com";
            link.addChild(linkSpan);
            
            // add text to second span and add spans and link to paragraph p
            span2.text = ". Notice that paragraph p2 is identical to paragraph p."; 
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            
            // call getParagraph() to retrieve paragaph for LinkElement 
            var p2:ParagraphElement = link.getParagraph();
            
            // add paragraph p2 to the text flow and display it
            textFlow.addChild(p2);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

Zwraca poprzedni siostrzany obiekt FlowElement z hierarchii przepływu tekstu.

Powiązane elementy interfejsu API

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 FlowElement_getPreviousSiblingExample extends Sprite
    {        
        public function FlowElement_getPreviousSiblingExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var prevSpanElement:SpanElement = new SpanElement();
            // add text, set font size, add spans to paragraph, add paragraph to text flow
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            // get previous SpanElement for span2 and set its color to red; display text
            prevSpanElement = SpanElement(span2.getPreviousSibling());
            prevSpanElement.color = 0xCC0000;
            textFlow.flowComposer.addController(new ContainerController(this,400,200));
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

Zwraca wartość stylu określonego przez parametr styleProp, który określa nazwę stylu oraz może zawierać dowolną nazwę stylu użytkownika. Uzyskuje dostęp do istniejącego stylu zakresu, akapitu, przepływu tekstu lub kontenera. Przeszukuje nadrzędne drzewo, jeśli styl ma wartość undefined w konkretnym elemencie.

Parametry

Powiązane elementy interfejsu API

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 FlowElement_getStyleExample extends Sprite
    {        
        public function FlowElement_getStyleExample()
        {
            // create a container and a TextFlow object
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            var textFlow:TextFlow = new TextFlow();
            
            // create a paragraph and set lineThrough style to true 
            var paragraph:ParagraphElement = new ParagraphElement();
            paragraph.setStyle("lineThrough", true);
            // create two spans of text
            var p1Span1:SpanElement = new SpanElement();
            var p1Span2:SpanElement = new SpanElement();            
            p1Span1.text = "It was a dark and stormy night. ";
            p1Span2.text = "The quick red fox jumped over the lazy brown dog.";
            paragraph.addChild(p1Span1);
            paragraph.addChild(p1Span2);
            
            // call getStyle() for 1st span to see if lineThrough is on
            if(p1Span1.getStyle("lineThrough") == true)
                p1Span1.setStyle("lineThrough", false)    // if so, turn it off for this span
            textFlow.addChild(paragraph);
            
            // add composer and controller, then update controller to display text
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

Pobiera określony zakres tekstu z elementu przepływu.

Parametry

Przechodzi do coraz wyższych poziomów w hierarchii przepływu tekstu w celu zwrócenia głównego obiektu TextFlow dla elementu.

Powiązane elementy interfejsu API

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getTextFlowExample extends Sprite
    {        
        public function FlowElement_getTextFlowExample()
        {
            // create a container and a controller for it and add to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController(container, 400, 200);
            this.stage.addChild( container );
                        
            //create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to first span
            span1.text = "Text that includes a link to ";
            
            // create link span, add text and corresponding URL and add to link
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "Adobe's website";
            link.href = "http://www.adobe.com";
            link.addChild(linkSpan);
            
            // add text to second span, add spans and link to paragraph p, and
            // add paragraph p to textFlow
            span2.text = ". Notice that textFlow2 is identical to textFlow."; 
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            textFlow.addChild(p);
            
            // use getTextFlow() with LinkElement to return its TextFlow; update controller
            // and display it
            var textFlow2:TextFlow = link.getTextFlow();     
            textFlow2.flowComposer.addController( controller );                               
            textFlow2.flowComposer.updateAllControllers();
        }
    }
}

Wywoływany dla obiektów MXML po utworzeniu obiektu implementującego, gdy zainicjowano wszystkie właściwości składnika określonego w znaczniku MXML.

Parametry

Ustawia styl określony przez parametr styleProp na wartość określoną przez parametr newValue. Możliwe jest ustawienie stylu zakresu, akapitu, przepływu tekstu lub kontenera z uwzględnieniem dowolnej pary nazwa-wartość.

Uwaga: W przypadku przypisania stylu niestandardowego specyfikacja Text Layout Framework może importować i eksportować styl, ale skompilowany kod MXML nie może obsługiwać stylu.

Parametry

Powiązane elementy interfejsu API

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flash.text.engine.FontPosture;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_setStyleExample extends Sprite
    {        
        public function FlowElement_setStyleExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
            
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to the spans
            span1.text = "Hello, ";
            span2.text = "World!";
            
            // set the color style for span2 and add spans to paragraph p
            span2.setStyle("color", 0xCC0000);
            p.addChild(span1);
            p.addChild(span2);
            
            // add paragraph to text flow, set fontStyle for the text flow to italic,
            // and update controller to display the paragraph
            textFlow.addChild(p);
            textFlow.setStyle("fontStyle", FontPosture.ITALIC);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

Tworzy kopię danego obiektu FlowElement, kopiując treść między dwoma określonymi położeniami znaków. Zwraca kopię jako nowy obiekt FlowElement. Metoda shallowCopy() — inaczej niż metoda deepCopy() — nie kopiuje żadnego elementu podrzędnego obiektu FlowElement.

W przypadku braku argumentów metoda shallowCopy() domyślnie kopiuje całą treść.

Parametry

Powiązane elementy interfejsu API

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 FlowElement_shallowCopyExample extends Sprite
    {        
        public function FlowElement_shallowCopyExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();
            // add text to the spans, spans to the paragraph
            span1.text = "paragraph2 has  ";
            span3.text = " children, so it would display nothing."
            p.fontSize = 20;
            p.addChild(span1);
            p.addChild(span2);
            p.addChild(span3);
            // create paragraph p2 as a shallow copy of paragraph p
            var p2:ParagraphElement = p.shallowCopy(3, -1) as ParagraphElement; 
            // add the number of children that p2 has to span2 for paragraph p
            span2.text += p2.numChildren;    // 0
            // add paragraph p to textFlow and update controller to display it
            textFlow.addChild(p);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

Dzieli obiekt FlowElement w miejscu określonym przez parametr relativePosition, co stanowi względne położenie tego elementu w tekście. Ta metoda dzieli tylko obiekty SpanElement i FlowGroupElement.

Parametry