IViewport - Adobe ActionScript® 3 (AS3 Flex) API 참조 설명서

패키지	spark.core
인터페이스	public interface IViewport extends IVisualElement , ILayoutElement , ILayoutDirectionElement , IEventDispatcher
구현자	GroupBase, RichEditableText

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

The IViewport interface is implemented by components that support a viewport. If a component's children are larger than the component, and you want to clip the children to the component boundaries, you can define a viewport and scroll bars. A viewport is a rectangular subset of the area of a component that you want to display, rather than displaying the entire component.

A viewport on its own is not movable by the application user. However, you can combine a viewport with scroll bars so the user can scroll the viewport to see the entire content of the component. Use the Scroller component to add scrolbars to the component.

예제 보기

관련 API 요소

spark.components.Scroller

공용 속성

상속되는 공용 속성 숨기기

상속되는 공용 속성 표시

	속성		정의 주체
		alpha : Number 지정된 객체의 알파 투명도 값을 나타냅니다.	IVisualElement
		baseline : Object The vertical distance in pixels from the anchor target to the control's baseline position.	ILayoutElement
		baselinePosition : Number [읽기 전용] The y-coordinate of the baseline of the first line of text of the component.	ILayoutElement
		bottom : Object The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.	ILayoutElement
		clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport.	IViewport
		contentHeight : Number [읽기 전용] The height of the viewport's content.	IViewport
		contentWidth : Number [읽기 전용] The width of the viewport's contents.	IViewport
		depth : Number Determines the order in which items inside of containers are rendered.	IVisualElement
		designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element.	IVisualElement
		hasLayoutMatrix3D : Boolean [읽기 전용] Contains true if the element has 3D Matrix.	ILayoutElement
		height : Number 표시 객체의 높이를 픽셀 단위로 나타냅니다.	IVisualElement
		horizontalCenter : Object The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		horizontalScrollPosition : Number The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.	IViewport
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	ILayoutElement
		is3D : Boolean [읽기 전용] Contains true when the element is in 3D.	IVisualElement
		layoutDirection : String Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit).	ILayoutDirectionElement
		left : Object The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.	ILayoutElement
		owner : DisplayObjectContainer The owner of this IVisualElement object.	IVisualElement
		parent : DisplayObjectContainer [읽기 전용] The parent container or component for this component.	IVisualElement
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	ILayoutElement
		percentWidth : Number Specifies the width of a component as a percentage of its parent's size.	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.	IVisualElement
		right : Object The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.	ILayoutElement
		top : Object The vertical distance in pixels from the top edge of the component to the anchor target's top edge.	ILayoutElement
		verticalCenter : Object The vertical distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		verticalScrollPosition : Number The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.	IViewport
		visible : Boolean Controls the visibility of this visual element.	IVisualElement
		width : Number 표시 객체의 폭을 픽셀 단위로 나타냅니다.	IVisualElement
		x : Number 부모 DisplayObjectContainer의 로컬 좌표를 기준으로 DisplayObject 인스턴스의 x 좌표를 나타냅니다.	IVisualElement
		y : Number 부모 DisplayObjectContainer의 로컬 좌표를 기준으로 DisplayObject 인스턴스의 y 좌표를 나타냅니다.	IVisualElement

공용 메서드

상속되는 공용 메서드 숨기기

상속되는 공용 메서드 표시

	메서드		정의 주체
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 리스너에서 이벤트 알림을 받을 수 있도록 EventDispatcher 객체에 이벤트 리스너 객체를 등록합니다.	IEventDispatcher
		dispatchEvent(event:Event):Boolean 이벤트를 이벤트 흐름으로 전달합니다.	IEventDispatcher
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	ILayoutElement
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	ILayoutElement
		getHorizontalScrollPositionDelta(navigationUnit:uint):Number Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.	IViewport
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	ILayoutElement
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	ILayoutElement
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	ILayoutElement
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	ILayoutElement
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	ILayoutElement
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	ILayoutElement
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	ILayoutElement
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	ILayoutElement
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	ILayoutElement
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	ILayoutElement
		getVerticalScrollPositionDelta(navigationUnit:uint):Number Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.	IViewport
		hasEventListener(type:String):Boolean EventDispatcher 객체에 특정 유형의 이벤트에 대한 리스너가 등록되어 있는지 여부를 확인합니다.	IEventDispatcher
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	ILayoutDirectionElement
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher 객체에서 리스너를 제거합니다.	IEventDispatcher
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	ILayoutElement
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	ILayoutElement
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	ILayoutElement
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	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 A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.	ILayoutElement
		willTrigger(type:String):Boolean 이 EventDispatcher 객체 또는 조상 객체에 지정한 이벤트 유형에 대한 이벤트 리스너가 등록되어 있는지 여부를 확인합니다.	IEventDispatcher

속성 세부 정보

clipAndEnableScrolling

속성

clipAndEnableScrolling:Boolean

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

If true, specifies to clip the children to the boundaries of the viewport. If false, the container children extend past the container boundaries, regardless of the size specification of the component.

기본값: false.

구현
public function get clipAndEnableScrolling():Boolean
public function set clipAndEnableScrolling(value:Boolean):void

contentHeight

속성

contentHeight:Number [읽기 전용]

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

The height of the viewport's content. If clipAndEnabledScrolling is true, the viewport's contentHeight defines the limit for vertical scrolling and the viewport's actual height defines how much of the content is visible. To scroll through the content vertically, vary the verticalScrollPosition between 0 and contentHeight - height.

Implementations of this property must be Bindable and must generate events of type propertyChange.

구현
public function get contentHeight():Number

contentWidth

속성

contentWidth:Number [읽기 전용]

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

The width of the viewport's contents. If clipAndEnabledScrolling is true, the viewport's contentWidth defines the limit for horizontal scrolling and the viewport's actual width defines how much of the content is visible. To scroll through the content horizontally, vary the horizontalScrollPosition between 0 and contentWidth - width.

Implementations of this property must be Bindable and must generate events of type propertyChange.

구현
public function get contentWidth():Number

horizontalScrollPosition

속성

horizontalScrollPosition:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. If clipAndEnableScrolling is true, setting this property typically causes the viewport to be set to:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementations of this property must be Bindable and must generate events of type propertyChange.

기본값: 0.

구현
public function get horizontalScrollPosition():Number
public function set horizontalScrollPosition(value:Number):void

관련 API 요소

target
verticalScrollPosition

verticalScrollPosition

속성

verticalScrollPosition:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. If clipAndEnableScrolling is true, setting this property typically causes the viewport to be set to:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementations of this property must be Bindable and must generate events of type propertyChange.

기본값: 0.

구현
public function get verticalScrollPosition():Number
public function set verticalScrollPosition(value:Number):void

관련 API 요소

horizontalScrollPosition

메서드 세부 정보

getHorizontalScrollPositionDelta

()

메서드

public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.

매개 변수

navigationUnit:uint — The amount to scroll. The value must be one of the following spark.core.NavigationUnit constants:

LEFT
RIGHT
PAGE_LEFT
PAGE_RIGHT
HOME
END

To scroll by a single column, use LEFT or RIGHT. To scroll to the first or last column, use HOME or END.

반환값

Number — The number of pixels to add to horizontalScrollPosition.

관련 API 요소

spark.core.NavigationUnit

getVerticalScrollPositionDelta

()

메서드

public function getVerticalScrollPositionDelta(navigationUnit:uint):Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 4

런타임 버전:

Flash Player 10, AIR 1.5

Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.

매개 변수

navigationUnit:uint — The amount to scroll. The value of unit must be one of the following spark.core.NavigationUnit constants:

UP
DOWN
PAGE_UP
PAGE_DOWN
HOME
END

To scroll by a single row use UP or DOWN. To scroll to the first or last row, use HOME or END.

반환값

Number — The number of pixels to add to verticalScrollPosition.

관련 API 요소

spark.core.NavigationUnit

예제 예제 사용 방법

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>

법적 고지 사항 | 온라인 개인 정보 보호 정책

IViewport - AS3 Flex

패키지x

언어 요소

부록

패키지 spark.core

clipAndEnableScrolling

contentHeight

contentWidth

horizontalScrollPosition

verticalScrollPosition

getHorizontalScrollPositionDelta

getVerticalScrollPositionDelta