| Paket | flashx.textLayout.compose |
| Schnittstelle | public interface IFlowComposer |
| Umsetzer | StandardFlowComposer |
| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Textflüsse, die mit der Implementierung eines Flow-Composers angezeigt werden, können dynamisch und interaktiv sein. Ein Flow-Composer verwaltet einen oder mehrere Anzeigecontroller. Jeder Controller ist mit einem Anzeigeobjektcontainer (beispielsweise einem Sprite) verknüpft, über den die für den Textfluss erstellten Zeilen endgültig angezeigt werden. Das folgende Diagramm veranschaulicht die Beziehung zwischen TextFlow-, IFlowComposer-, ContainerController- und DisplayObjectContainer-Objekten:
Ein Flow-Composer berechnet, welcher Teil eines Textflusses in jeden Container passt, und fügt die entsprechenden Textzeilen dem Anzeigeobjekt des Containers hinzu. Die IFlowComposer-Schnittstelle definiert separate Methoden für Layoutberechnungen und das Aktualisieren der Anzeige. IFlowComposer definiert auch Methoden, um einen Textfluss inkrementell zu erstellen und zu aktualisieren. Diese Methoden können verwendet werden, um das Blockieren der Benutzeroberfläche beim Aktualisieren langer Textflüsse zu vermeiden.
Zusätzlich zum Verwalten der Texterstellung und -anzeige steuert ein Flow-Composer, welcher Container den Fokus hat, verwaltet die Anzeige der Auswahlhervorhebung (die Containergrenzen überschreiten kann) und bietet Direktzugriff auf alle TextLine-Objekte im Textfluss.
Um eine IFlowComposer-Implementierung zu verwenden, weisen Sie eine Instanz dieser Implementierung der flowComposer-Eigenschaft eines TextFlow-Objekts zu. Rufen Sie die updateAllControllers()-Methode auf, um den Text in den Containern, die an den Flow-Composer angehängt sind, anzuordnen und anzuzeigen.
Hinweis: Für einen einfachen, statischen Textfluss können Sie auch den der Factory-Klassen für die Textzeile verwenden. Diese Factory-Klassen erstellen im Allgemeinen Zeilen mit weniger Aufwand als ein Flow-Composer, aber unterstützen keine Bearbeitung, dynamischen Änderungen oder Benutzerinteraktion.
Verwandte API-Elemente
FlowComposerBase
StandardFlowComposer
TextFlow
StringTextLineFactory
TextFlowTextLineFactory
| Eigenschaft | Definiert von | ||
|---|---|---|---|
| composing : Boolean [schreibgeschützt]
„true“, falls der Flow-Composer derzeit einen Erstellungsvorgang durchführt. | IFlowComposer | ||
| damageAbsoluteStart : int [schreibgeschützt]
Die erste ungültige Position im Stammelement als absolute Position ab Beginn des Textflusses. | IFlowComposer | ||
| numControllers : int [schreibgeschützt]
Die Anzahl der dieser IFlowComposer-Instanz zugewiesenen Container. | IFlowComposer | ||
| numLines : int [schreibgeschützt]
Die Gesamtzahl der Zeilen im Textfluss. | IFlowComposer | ||
| rootElement : ContainerFormattedElement [schreibgeschützt]
Das mit dieser IFlowComposer-Instanz verknüpfte Stammelement. | IFlowComposer | ||
| swfContext : ISWFContext
Die ISWFContext-Instanz, die für Aufrufe, die in einem speziellen SWF-Kontext erfolgen müssen, verwendet wird. In Implementierungen von IFlowComposer sollte diese Eigenschaft so festgelegt werden können, dass Benutzer der Schnittstelle Zeilen in einem anderen SWF-Kontext als dem mit der Implementierung erstellen können. | IFlowComposer | ||
| Methode | Definiert von | ||
|---|---|---|---|
Fügt dieser IFlowComposer-Instanz einen Controller hinzu. | IFlowComposer | ||
Fügt dieser IFlowComposer-Instanz an der angegebenen Indexposition einen Controller hinzu. | IFlowComposer | ||
Berechnet, wie viele Zeilen erforderlich sind, um den Inhalt im Stammelement des Textflusses und die Positionen dieser Zeilen in den Anzeigecontainern des Textflusses anzuzeigen. | IFlowComposer | ||
Erstellt den Inhalt des Stammelements bis zum und einschließlich des Containers an der angegebenen Indexposition. | IFlowComposer | ||
Erstellt den Inhalt des Stammelements bis zur angegebenen Position. | IFlowComposer | ||
Markieren Sie die Zeilen als beschädigt. Dadurch geben Sie an, dass sie neu erstellt werden müssen. | IFlowComposer | ||
Gibt die Indexposition des Controllers zurück, der den Inhalt an der angegebenen Position enthält. | IFlowComposer | ||
findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine
Gibt das TextFlowLine-Objekt mit dem Inhalt an der angegebenen Position zurück. | IFlowComposer | ||
Gibt die sequenzielle Zeilennummer des TextFlowLine-Objekts zurück, das den Inhalt an der angegebenen Position enthält. | IFlowComposer | ||
Gibt das ContainerController-Objekt an der angegebenen Indexposition zurück. | IFlowComposer | ||
Gibt die Indexposition des angegebenen ContainerController-Objekts zurück. | IFlowComposer | ||
Gibt die Zeile mit der angegebenen Zeilennummer zurück. | IFlowComposer | ||
Wird von TextFlow aufgerufen, wenn der Interaktionsmanager sich ändert. | IFlowComposer | ||
Gibt an, ob TextFlowLine-Objekte zwischen dem Beginn des Textflusses und der Zeile mit dem Inhalt an der angegebenen Position als beschädigt markiert sind. | IFlowComposer | ||
Entfernt alle Controller aus dieser IFlowComposer-Instanz. | IFlowComposer | ||
Entfernt einen Controller aus dieser IFlowComposer-Instanz. | IFlowComposer | ||
Entfernt den Controller an der angegebenen Indexposition aus dieser IFlowComposer-Instanz. | IFlowComposer | ||
Legt den Fokus auf den Container, der die vom absolutePosition-Parameter angegebene Position enthält. | IFlowComposer | ||
| IFlowComposer | |||
Erstellt den Inhalt des Stammelements und aktualisiert die Anzeige. | IFlowComposer | ||
Aktualisieren Sie die Längen in den Zeilen, um das Mapping zu TextFlow beizubehalten. | IFlowComposer | ||
Erstellt und aktualisiert die Anzeige bis zum und einschließlich des Containers an der angegebenen Indexposition. | IFlowComposer | ||
composing | Eigenschaft |
damageAbsoluteStart | Eigenschaft |
numControllers | Eigenschaft |
numLines | Eigenschaft |
numLines:int [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Die Gesamtzahl der Zeilen im Textfluss. TLF erstellt standardmäßig nicht den gesamten Textfluss und dieser Wert ist möglicherweise nicht korrekt. Verwenden Sie composeToPosition, damit alle Zeilen erstellt werden.
Implementierung
public function get numLines():introotElement | Eigenschaft |
rootElement:ContainerFormattedElement [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Das mit dieser IFlowComposer-Instanz verknüpfte Stammelement.
Nur ein TextFlow-Objekt kann ein Stammobjekt sein.
Implementierung
public function get rootElement():ContainerFormattedElementVerwandte API-Elemente
swfContext | Eigenschaft |
swfContext:ISWFContext| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Die ISWFContext-Instanz, die für Aufrufe, die in einem speziellen SWF-Kontext erfolgen müssen, verwendet wird.
In Implementierungen von IFlowComposer sollte diese Eigenschaft so festgelegt werden können, dass Benutzer der Schnittstelle Zeilen in einem anderen SWF-Kontext als dem mit der Implementierung erstellen können. Eine Standardimplementierung von ISWFContext sollte auch bereitgestellt werden.
Implementierung
public function get swfContext():ISWFContext public function set swfContext(value:ISWFContext):voidVerwandte API-Elemente
addController | () | Methode |
public function addController(controller:ContainerController):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Fügt dieser IFlowComposer-Instanz einen Controller hinzu.
Der Container wird am Ende der Containerliste hinzugefügt.
Parameter
controller:ContainerController — Das ContainerController-Objekt, das hinzugefügt werden soll.
|
addControllerAt | () | Methode |
public function addControllerAt(controller:ContainerController, index:int):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Fügt dieser IFlowComposer-Instanz an der angegebenen Indexposition einen Controller hinzu.
Die Liste der Controller ist 0-basiert (der erste Controller weist die Indexposition 0 auf).
Parameter
controller:ContainerController — Das ContainerController-Objekt, das hinzugefügt werden soll.
| |
index:int — Eine numerische Indexposition, die die Position in der Controller-Liste angibt, an der das ContainerController-Objekt eingefügt wird.
|
compose | () | Methode |
public function compose():Boolean| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Berechnet, wie viele Zeilen erforderlich sind, um den Inhalt im Stammelement des Textflusses und die Positionen dieser Zeilen in den Anzeigecontainern des Textflusses anzuzeigen.
Implementierungen dieser Methode sollten die Anzeige nicht aktualisieren, sondern die Ergebnisse speichern, sodass spätere Aufrufe von compose() oder updateAllControllers() keine zusätzliche Neuerstellung durchführen, wenn der Inhalt des Textflusses nicht geändert wurde.
Wenn der Inhalt von Containern geändert wurde, muss die Methode true zurückgeben.
Boolean — „true“, wenn etwas geändert wurde.
|
Verwandte API-Elemente
composeToController | () | Methode |
public function composeToController(index:int):Boolean| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Erstellt den Inhalt des Stammelements bis zum und einschließlich des Containers an der angegebenen Indexposition.
Wenn der Inhalt von Containern bis zum und einschließlich des Containers an der angegebenen Indexposition geändert wurde, gibt die Methode true zurück. Wenn index größer als die Anzahl der Controller (oder nicht angegeben) ist, werden alle Container erstellt.
Parameter
index:int (default = NaN) |
Boolean — „true“, wenn etwas geändert wurde.
|
Verwandte API-Elemente
composeToPosition | () | Methode |
public function composeToPosition(absolutePosition:int):Boolean| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Erstellt den Inhalt des Stammelements bis zur angegebenen Position.
Wenn der Inhalt von Containern bis zum und einschließlich des Containers mit dem Inhalt an der angegebenen Position geändert wurde, gibt die Methode true zurück. Wenn absolutePosition größer als die Länge von TextFlow (oder nicht angegeben) ist, dann wird der gesamte Fluss erstellt.
Parameter
absolutePosition:int (default = NaN) |
Boolean — „true“, wenn etwas geändert wurde.
|
Verwandte API-Elemente
damage | () | Methode |
public function damage(startPosition:int, damageLength:int, damageType:String):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Markieren Sie die Zeilen als beschädigt. Dadurch geben Sie an, dass sie neu erstellt werden müssen.
Parameter
startPosition:int — Beginn des beschädigten Bereichs
| |
damageLength:int — Anzahl der beschädigten Zeichen
| |
damageType:String — Typ der Beschädigung. Entspricht einem Typ von flashx.textLayout.compose.FlowDamageType
|
Verwandte API-Elemente
findControllerIndexAtPosition | () | Methode |
public function findControllerIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt die Indexposition des Controllers zurück, der den Inhalt an der angegebenen Position enthält.
Eine Position kann als Trennelement zwischen zwei Zeichen oder anderen Elementen eines Textflusses angesehen werden. Wenn der Wert in absolutePosition eine Position zwischen dem letzten Zeichen eines Containers und dem ersten Zeichen des nächsten ist, wird der vorhergehende Container anschließend zurückgegeben, wenn für den preferPrevious-Parameter true festgelegt wurde, der letzte Container wird zurückgegeben, falls für den preferPrevious-Parameter false festgelegt wurde.
Die Methode muss -1 zurückgeben, wenn der Inhalt an der angegebenen Position nicht in einem Container oder außerhalb des Bereichs der Positionen im Textfluss ist.
Parameter
absolutePosition:int — Die Position des Inhalts, für den die Containerindexposition gesucht wird.
| |
preferPrevious:Boolean (default = false) |
int — Die Indexposition des Container-Controllers oder -1, falls nicht gefunden.
|
findLineAtPosition | () | Methode |
public function findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt das TextFlowLine-Objekt mit dem Inhalt an der angegebenen Position zurück.
Eine Position kann als Trennelement zwischen zwei Zeichen oder anderen Elementen eines Textflusses angesehen werden. Wenn der Wert in absolutePosition eine Position zwischen dem letzten Element einer Zeile und dem ersten Element der nächsten ist, wird die vorhergehende Zeile anschließend zurückgegeben, wenn für den preferPrevious-Parameter true festgelegt wird, die folgende Zeile wird zurückgegeben, falls für den preferPrevious-Parameter false festgelegt wird.
Parameter
absolutePosition:int — Die Position des Inhalts, für den Sie das TextFlowLine-Objekt benötigen.
| |
preferPrevious:Boolean (default = false) |
flashx.textLayout.compose:TextFlowLine — Die TextFlowLine, die den Inhalt an der angegebenen Position enthält, oder „null“, falls nicht gefunden.
|
findLineIndexAtPosition | () | Methode |
public function findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt die sequenzielle Zeilennummer des TextFlowLine-Objekts zurück, das den Inhalt an der angegebenen Position enthält.
Die Nummer der ersten Zeile ist 0 und die Nummer der letzten Zeile ist mit der Anzahl der Zeilen -1 identisch. Wenn die in absolutePosition angegebene Position nach dem Ende des Textflusses ist, muss diese Methode die Nummer zurückgeben, die der nächsten dem Textfluss hinzugefügten neuen Zeile zugewiesen wird. (Dieser Wert stimmt mit der Anzahl der aktuell vorhandenen Zeilen überein.)
Eine Position kann als Trennelement zwischen zwei Zeichen oder anderen Elementen eines Textflusses angesehen werden. Wenn der Wert in absolutePosition eine Position zwischen der letzten Zeile eines Containers und der ersten Zeile des nächsten ist, wird der vorhergehende Container zurückgegeben, wenn für den preferPrevious-Parameter true festgelegt wird, und der folgende Container wird zurückgegeben, wenn für den preferPrevious-Parameter false festgelegt wird.
Parameter
absolutePosition:int — Die Position des Inhalts, für den Sie die Textzeile möchten.
| |
preferPrevious:Boolean (default = false) |
int — Die Indexposition der Textzeile an der angegebenen Position. Falls nicht gefunden, wird sie wie nach dem Ende behandelt und gibt die Anzahl der Zeilen zurück.
|
getControllerAt | () | Methode |
public function getControllerAt(index:int):ContainerController| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt das ContainerController-Objekt an der angegebenen Indexposition zurück.
Parameter
index:int — Die Indexposition des ContainerController-Objekts, das zurückgegeben werden soll.
|
ContainerController — Das ContainerController-Objekt an der angegebenen Position.
|
getControllerIndex | () | Methode |
public function getControllerIndex(controller:ContainerController):int| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt die Indexposition des angegebenen ContainerController-Objekts zurück.
Parameter
controller:ContainerController — Ein Verweis auf das ContainerController-Objekt, nach dem gesucht werden soll.
|
int — Die Indexposition des angegebenen ContainerController-Objekts oder -1, wenn der Controller nicht an diesen Flow-Composer angehängt wird.
|
getLineAt | () | Methode |
public function getLineAt(index:int):flashx.textLayout.compose:TextFlowLine| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt die Zeile mit der angegebenen Zeilennummer zurück.
Die Liste der Zeilen ist von null bis zur Anzahl der Zeilen -1 nummeriert. Wenn der Wert in index außerhalb des Bereichs der Liste der Zeilen liegt, gibt diese Funktion null zurück.
Parameter
index:int — Die Zeilennummer des TextFlowLine-Objekts, das zurückgegeben werden soll.
|
flashx.textLayout.compose:TextFlowLine — TextFlowLine mit der angegebenen Zeilennummer oder null, falls nicht gefunden.
|
interactionManagerChanged | () | Methode |
public function interactionManagerChanged(newInteractionManager:ISelectionManager):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Wird von TextFlow aufgerufen, wenn der Interaktionsmanager sich ändert.
Implementierungen von IFlowComposer sollten Ereignis-Listener und Eigenschaften, die auf den Interaktionsmanager verweisen, aktualisieren.
Parameter
newInteractionManager:ISelectionManager — Die neue ISelectionManager-Instanz.
|
isDamaged | () | Methode |
public function isDamaged(absolutePosition:int):Boolean| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt an, ob TextFlowLine-Objekte zwischen dem Beginn des Textflusses und der Zeile mit dem Inhalt an der angegebenen Position als beschädigt markiert sind.
Parameter
absolutePosition:int — die letzte Position im relevanten Bereich
|
Boolean — „true“, wenn TextFlowLine-Objekte vom Beginn des Textflusses bis zur Zeile, die den Inhalt an absolutePosition enthält, als beschädigt markiert sind.
|
removeAllControllers | () | Methode |
public function removeAllControllers():void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Entfernt alle Controller aus dieser IFlowComposer-Instanz.
removeController | () | Methode |
public function removeController(controller:ContainerController):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Entfernt einen Controller aus dieser IFlowComposer-Instanz.
Parameter
controller:ContainerController — Die ContainerController-Instanz, die entfernt werden soll.
|
removeControllerAt | () | Methode |
public function removeControllerAt(index:int):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Entfernt den Controller an der angegebenen Indexposition aus dieser IFlowComposer-Instanz.
Parameter
index:int — Die Indexposition des ContainerController-Objekts, das entfernt werden soll.
|
setFocus | () | Methode |
public function setFocus(absolutePosition:int, preferPrevious:Boolean = false):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Legt den Fokus auf den Container, der die vom absolutePosition-Parameter angegebene Position enthält.
Die Bedeutung der Einstellung des Fokus wird in der jeweiligen Implementierung definiert. Beispielsweise könnte eine Implementierung die integrierte focus-Eigenschaft des Stage-Objekts verwenden (solange es sich bei den Containern um „InteractiveObjects“ handelte) oder die Implementierung könnte den Fokus auf andere Weise verwalten.
Parameter
absolutePosition:int — Gibt die Position im Textfluss des Containers an, der den Fokus erhalten soll.
| |
preferPrevious:Boolean (default = false) |
Verwandte API-Elemente
setRootElement | () | Methode |
public function setRootElement(newRootElement:ContainerFormattedElement):voidParameter
newRootElement:ContainerFormattedElement |
updateAllControllers | () | Methode |
public function updateAllControllers():Boolean| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Erstellt den Inhalt des Stammelements und aktualisiert die Anzeige.
Das Textlayout besteht im Allgemeinen aus zwei Phasen: Erstellung und Anzeige. In der Erstellungsphase berechnet der Flow-Composer die Anzahl der für die Anzeige des Inhalts erforderlichen Zeilen sowie deren Position in den Anzeigecontainern des Textflusses. In der Anzeigephase aktualisiert der Flow-Composer die untergeordneten Anzeigeobjektelemente seiner Container. Die updateAllControllers()-Methode führt voraussichtlich beide Phasen aus. Eine effiziente Implementierung überwacht Änderungen am Inhalt, sodass ein vollständiger Erstellungs- und Anzeigezyklus nur durchgeführt wird, falls erforderlich.
Diese Methode aktualisiert alle Textzeilen und die Anzeigeliste sofort und synchron.
Wenn der Inhalt von Containern geändert wurde, muss die Methode true zurückgeben.
Boolean — „true“, wenn etwas geändert wurde.
|
updateLengths | () | Methode |
public function updateLengths(startPosition:int, deltaLength:int):void| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Aktualisieren Sie die Längen in den Zeilen, um das Mapping zu TextFlow beizubehalten.
Parameter
startPosition:int — Beginn der Längenänderung
| |
deltaLength:int — Änderung in Zeichenanzahl
|
updateToController | () | Methode |
public function updateToController(index:int):Boolean| Sprachversion: | ActionScript 3.0 |
| Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Erstellt und aktualisiert die Anzeige bis zum und einschließlich des Containers an der angegebenen Indexposition.
Die updateToController()-Methode erstellt voraussichtlich den Inhalt und aktualisiert die Anzeige, sodass alle Container bis zum und einschließlich des Containers an der angegebenen Indexposition aktuell sind. Beispiel: Wenn Sie in einer Kette von 20 Containern die Indexposition 10 angeben, stellt updateToController() sicher, dass die ersten zehn Container (Indizes 0-9) erstellt und angezeigt werden. Die Erstellung kann an diesem Punkt beendet werden. Wenn controllerIndex -1 ist (oder nicht angegeben), müssen alle Container aktualisiert werden.
Diese Methode aktualisiert alle Textzeilen und die Anzeigeliste sofort und synchron.
Wenn der Inhalt von Containern geändert wurde, muss die Methode true zurückgeben.
Parameter
index:int (default = NaN) |
Boolean — „true“, wenn etwas geändert wurde.
|
Tue Jun 12 2018, 10:04 AM Z