IViewport - Adobe ActionScript® 3 (AS3 Flex) API-Referenz

Paket	spark.core
Schnittstelle	public interface IViewport extends IVisualElement , ILayoutElement , ILayoutDirectionElement , IEventDispatcher
Umsetzer	GroupBase, RichEditableText

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Die IViewport-Schnittstelle wird von den Komponenten implementiert, die einen Viewport unterstützen. Wenn die untergeordneten Elemente einer Komponente größer als die Komponente sind und Sie die untergeordneten Elemente auf die Begrenzungen der Komponente kürzen möchten, können Sie einen Viewport und Bildlaufleisten definieren. Bei einem Viewport handelt es sich um eine rechteckige Untergruppe des Bereichs einer Komponente, die Sie anzeigen möchten, und nicht um die Anzeige der gesamten Komponente.

Ein Viewport kann nicht durch den Anwendungsbenutzer bewegt werden. Sie können jedoch einen Viewport mit Bildlaufleisten kombinieren, sodass der Benutzer einen Bildlauf im Viewport durchführen kann, um den gesamten Inhalt der Komponente anzuzeigen. Verwenden Sie die Scroller-Komponente, um Bildlaufleisten zu der Komponente hinzuzufügen.

Beispiele anzeigen

Verwandte API-Elemente

spark.components.Scroller

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		alpha : Number Gibt den Alphatransparenzwert des angegebenen Objekts an.	IVisualElement
		baseline : Object Der vertikale Abstand in Pixeln vom Ankerziel zur Grundlinienposition des Steuerelements.	ILayoutElement
		baselinePosition : Number [schreibgeschützt] Die y-Koordinate der Grundlinie der ersten Textzeile der Komponente.	ILayoutElement
		bottom : Object Der vertikale Abstand in Pixeln vom unteren Rand der Komponente zum unteren Rand des Ankerziels.	ILayoutElement
		clipAndEnableScrolling : Boolean Mit „true“ wird angegeben, dass die untergeordneten Elemente auf die Begrenzungen des Viewports gekürzt werden.	IViewport
		contentHeight : Number [schreibgeschützt] Die Höhe des Inhalts des Viewports.	IViewport
		contentWidth : Number [schreibgeschützt] Die Breite des Inhalts des Viewports.	IViewport
		depth : Number Bestimmt die Reihenfolge, in der die Elemente innerhalb von Containern gerendert werden.	IVisualElement
		designLayer : DesignLayer Gibt die optionale DesignLayer-Instanz zurück, die mit diesem visuellen Element verknüpft ist.	IVisualElement
		hasLayoutMatrix3D : Boolean [schreibgeschützt] Enthält „true“, wenn das Element eine 3D-Matrix hat.	ILayoutElement
		height : Number Gibt die Höhe des Anzeigeobjekts in Pixeln an.	IVisualElement
		horizontalCenter : Object Der horizontale Abstand in Pixeln vom Mittelpunkt der Komponente zum Mittelpunkt des Inhaltsbereichs des Ankerziels.	ILayoutElement
		horizontalScrollPosition : Number Die x-Koordinate im Ursprung des Viewports im Koordinatensystem der Komponente. Der Standardwert lautet (0,0) und entspricht der linken oberen Ecke der Komponente.	IViewport
		includeInLayout : Boolean Gibt an, ob diese Komponente im Layout des übergeordneten Containers enthalten ist.	ILayoutElement
		is3D : Boolean [schreibgeschützt] Enthält „true“, wenn das Element in 3D vorliegt.	IVisualElement
		layoutDirection : String Legt die gewünschte Layoutrichtung für ein Element fest: entweder LayoutDirection.LTR (von links nach rechts), LayoutDirection.RTL (von rechts nach links) oder null (vererben).	ILayoutDirectionElement
		left : Object Der horizontale Abstand in Pixeln vom linken Rand der Komponente zum linken Rand des Ankerziels.	ILayoutElement
		owner : DisplayObjectContainer Der Eigentümer dieses IVisualElement-Objekts.	IVisualElement
		parent : DisplayObjectContainer [schreibgeschützt] Der übergeordnete Container bzw. die übergeordnete Komponente dieser Komponente.	IVisualElement
		percentHeight : Number Legt die Höhe einer Komponente als Prozentsatz der Größe ihres übergeordneten Objekts fest.	ILayoutElement
		percentWidth : Number Legt die Breite einer Komponente als Prozentsatz der Größe ihres übergeordneten Objekts fest.	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets Definiert Anpassungen, die auf die Transformation des Objekts angewendet werden können, jedoch für das Layout des übergeordneten Objekts unsichtbar bleiben.	IVisualElement
		right : Object Der horizontale Abstand in Pixeln von der rechten Kante der Komponente zur rechten Kante des Ankerziels.	ILayoutElement
		top : Object Der vertikale Abstand in Pixeln vom oberen Rand der Komponente zum oberen Rand des Ankerziels.	ILayoutElement
		verticalCenter : Object Der vertikale Abstand in Pixeln von der Mitte der Komponente zur Mitte des Inhaltsbereichs des Ankerziels.	ILayoutElement
		verticalScrollPosition : Number Die y-Koordinate im Ursprung des Viewports im Koordinatensystem der Komponente. Der Standardwert lautet (0,0) und entspricht der linken oberen Ecke der Komponente.	IViewport
		visible : Boolean Steuert die Sichtbarkeit dieses visuellen Elements.	IVisualElement
		width : Number Gibt die Breite des Anzeigeobjekts in Pixeln an.	IVisualElement
		x : Number Gibt die x-Koordinate der DisplayObject-Instanz relativ zu den lokalen Koordinaten des übergeordneten DisplayObjectContainer-Objekts an.	IVisualElement
		y : Number Gibt die y-Koordinate der DisplayObject-Instanz relativ zu den lokalen Koordinaten des übergeordneten DisplayObjectContainer-Objekts an.	IVisualElement

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	IEventDispatcher
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	IEventDispatcher
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Gibt die x-Koordinate der Grenzen des Elements für die angegebene Elementgröße zurück.	ILayoutElement
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Gibt die y-Koordinate der Grenzen des Elements für die angegebene Elementgröße zurück.	ILayoutElement
		getHorizontalScrollPositionDelta(navigationUnit:uint):Number Gibt die Anzahl zurück, die zur aktuellen horizontalScrollPosition des Viewports hinzuzufügen ist, um einen Bildlauf mit der angeforderten Bildlaufeinheit durchzuführen.	IViewport
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Gibt die Layouthöhe des Elements zurück.	ILayoutElement
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Gibt die Layoutbreite des Elements zurück.	ILayoutElement
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Gibt die x-Koordinate zurück, die für das Zeichnen des Elements auf dem Bildschirm verwendet wird.	ILayoutElement
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Gibt die y-Koordinate zurück, die für das Element beim Zeichnen auf dem Bildschirm verwendet wird.	ILayoutElement
		getLayoutMatrix():Matrix Gibt die Transformationsmatrix zurück, die zur Berechnung des Layouts der Komponente relativ zu ihren Parallelobjekten verwendet wird.	ILayoutElement
		getLayoutMatrix3D():Matrix3D Gibt die Layouttransformations-Matrix3D für dieses Element zurück.	ILayoutElement
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Gibt die maximale Höhe des Elements zurück.	ILayoutElement
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Gibt die maximale Breite des Elements zurück.	ILayoutElement
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Gibt die Mindesthöhe des Elements zurück.	ILayoutElement
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Gibt die Mindestbreite des Elements zurück.	ILayoutElement
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Gibt die bevorzugte Höhe des Elements zurück.	ILayoutElement
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Gibt die bevorzugte Breite des Elements zurück.	ILayoutElement
		getVerticalScrollPositionDelta(navigationUnit:uint):Number Gibt die Anzahl zurück, die zur aktuellen verticalScrollPosition des Viewports hinzuzufügen ist, um einen Bildlauf mit der angeforderten Bildlaufeinheit durchzuführen.	IViewport
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	IEventDispatcher
		invalidateLayoutDirection():void Elemente müssen diese Methode aufrufen, wenn ihre eigene layoutDirection oder die layoutDirection des übergeordneten Elements geändert wird.	ILayoutDirectionElement
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	IEventDispatcher
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Legt die Koordinaten fest, die für das Zeichnen des Elements auf dem Bildschirm verwendet werden.	ILayoutElement
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Legt die Layoutgröße des Elements fest.	ILayoutElement
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Legt die Transformationsmatrix fest, die verwendet wird, um die Layoutgröße der Komponente und die Position relativ zu den Geschwisterelementen zu berechnen.	ILayoutElement
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Legt die Transformations-Matrix3D fest, die zur Berechnung der Layoutgröße und -position der Komponenete relativ zu ihren Parallelobjekten verwendet wird.	ILayoutElement
		transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void Eine Dienstprogrammmethode zum Aktualisieren der Drehung, Skalierung und Versetzung der Transformation, während gleichzeitig ein im Koordinatenraum der Komponente selbst angegebener bestimmter Punkt im übergeordneten Koordinatenraum unverändert erhalten bleibt.	ILayoutElement
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	IEventDispatcher

Eigenschaftendetails

clipAndEnableScrolling

Eigenschaft

clipAndEnableScrolling:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Mit true wird angegeben, dass die untergeordneten Elemente auf die Begrenzungen des Viewports gekürzt werden. Mit false wird angegeben, dass die untergeordneten Elemente des Containers über die Begrenzungen des Containers hinausragen, und zwar unabhängig von den Größenspezifikationen der Komponente.

Der Standardwert ist false.

Implementierung
public function get clipAndEnableScrolling():Boolean
public function set clipAndEnableScrolling(value:Boolean):void

Verwandte API-Elemente

spark.layouts.supportClasses.LayoutBase.updateScrollRect
verticalScrollPosition
horizontalScrollPosition

contentHeight

Eigenschaft

contentHeight:Number [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Die Höhe des Inhalts des Viewports. Wenn clipAndEnabledScrolling den Wert „true“ aufweist, wird durch contentHeight des Viewports die Begrenzung für den vertikalen Bildlauf bestimmt. Durch die tatsächliche Höhe des Viewports wird bestimmt, wie viel vom Inhalt sichtbar ist. Sie können vertikal durch den Inhalt blättern, indem Sie für verticalScrollPosition einen Wert zwischen 0 und contentHeight - height verwenden.

Implementierungen dieser Eigenschaft müssen bindbar sein und müssen Ereignisse des Typs propertyChange generieren.

Implementierung
public function get contentHeight():Number

contentWidth

Eigenschaft

contentWidth:Number [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Die Breite des Inhalts des Viewports. Wenn clipAndEnabledScrolling den Wert „true“ aufweist, wird durch contentWidth des Viewports die Begrenzung für den horizontalen Bildlauf bestimmt. Durch die tatsächliche Breite des Viewports wird bestimmt, wie viel vom Inhalt sichtbar ist. Sie können horizontal durch den Inhalt blättern, indem Sie für horizontalScrollPosition einen Wert zwischen 0 und contentWidth - width verwenden.

Implementierungen dieser Eigenschaft müssen bindbar sein und müssen Ereignisse des Typs propertyChange generieren.

Implementierung
public function get contentWidth():Number

horizontalScrollPosition

Eigenschaft

horizontalScrollPosition:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Die x-Koordinate im Ursprung des Viewports im Koordinatensystem der Komponente. Der Standardwert lautet (0,0) und entspricht der linken oberen Ecke der Komponente. Wenn clipAndEnableScrolling auf true eingestellt ist, führt das Einstellen dieser Eigenschaft normalerweise dazu, dass für den Viewport Folgendes festgelegt wird:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementierungen dieser Eigenschaft müssen bindbar sein und müssen Ereignisse des Typs propertyChange generieren.

Der Standardwert ist 0.

Implementierung
public function get horizontalScrollPosition():Number
public function set horizontalScrollPosition(value:Number):void

Verwandte API-Elemente

target
verticalScrollPosition

verticalScrollPosition

Eigenschaft

verticalScrollPosition:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Die y-Koordinate im Ursprung des Viewports im Koordinatensystem der Komponente. Der Standardwert lautet (0,0) und entspricht der linken oberen Ecke der Komponente. Wenn clipAndEnableScrolling auf true eingestellt ist, führt das Einstellen dieser Eigenschaft normalerweise dazu, dass für den Viewport Folgendes festgelegt wird:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementierungen dieser Eigenschaft müssen bindbar sein und müssen Ereignisse des Typs propertyChange generieren.

Der Standardwert ist 0.

Implementierung
public function get verticalScrollPosition():Number
public function set verticalScrollPosition(value:Number):void

Verwandte API-Elemente

horizontalScrollPosition

Methodendetails

getHorizontalScrollPositionDelta

()

Methode

public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Gibt die Anzahl zurück, die zur aktuellen horizontalScrollPosition des Viewports hinzuzufügen ist, um einen Bildlauf mit der angeforderten Bildlaufeinheit durchzuführen.

Parameter

navigationUnit:uint — Die Anzahl für den Bildlauf. Der Wert muss eine der folgenden spark.core.NavigationUnit-Konstanten sein:

LEFT
RIGHT
PAGE_LEFT
PAGE_RIGHT
HOME
END

Für einen Bildlauf über eine einzelne Spalte verwenden Sie LEFT oder RIGHT. Für einen Bildlauf zur ersten oder letzten Spalte verwenden Sie HOME oder END.

Rückgabewerte

Number — Die Anzahl an Pixeln, die zu horizontalScrollPosition hinzuzufügen ist.

Verwandte API-Elemente

spark.core.NavigationUnit

getVerticalScrollPositionDelta

()

Methode

public function getVerticalScrollPositionDelta(navigationUnit:uint):Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Gibt die Anzahl zurück, die zur aktuellen verticalScrollPosition des Viewports hinzuzufügen ist, um einen Bildlauf mit der angeforderten Bildlaufeinheit durchzuführen.

Parameter

navigationUnit:uint — Die Anzahl für den Bildlauf. Der Wert der Einheit muss eine der folgenden spark.core.NavigationUnit-Konstanten sein:

UP
DOWN
PAGE_UP
PAGE_DOWN
HOME
END

Für einen Bildlauf über eine einzelne Spalte verwenden Sie UP oder DOWN. Für einen Bildlauf zur ersten oder letzten Zeile verwenden Sie HOME oder END.

Rückgabewerte

Number — Die Anzahl an Pixeln, die zu verticalScrollPosition hinzuzufügen ist.

Verwandte API-Elemente

spark.core.NavigationUnit

Beispiele Verwendung dieses Beispiels

IViewportExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate Spark IViewport interface -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:mx="library://ns.adobe.com/flex/mx" 
    xmlns:s="library://ns.adobe.com/flex/spark" >
    <s:layout>
        <s:HorizontalLayout/>
    </s:layout>
    
    <s:Panel title="IViewport Component Example"
        width="75%" height="75%" 
        horizontalCenter="0" verticalCenter="0"> 

        <s:Label text="The Group container implements IViewport. Therefore, you can clip its contents and use it with scrollbars."
            color="blue"
            top="10"/>
        <s:Group id="myGroup" width="100" height="100"
            clipAndEnableScrolling="true"
            horizontalScrollPosition="50" verticalScrollPosition="50" 
            left="100" top="40"> 
            <mx:Image width="300" height="400" 
                source="@Embed(source='/assets/logo.jpg')"/>
        </s:Group>
        <s:VScrollBar viewport="{myGroup}" height="100" left="210" top="40"/>
        <s:HScrollBar viewport="{myGroup}" width="100" left="100" top="150"/>

    </s:Panel>
</s:Application>

Rechtliche Hinweise | Onlinedatenschutzerklärung

IViewport - AS3 Flex

Klassen x

clipAndEnableScrolling

contentHeight

contentWidth

horizontalScrollPosition

verticalScrollPosition

getHorizontalScrollPositionDelta

getVerticalScrollPositionDelta