mx.effects.MaskEffect (Flex™ 2 레퍼런스 가이드)

Package	mx.effects
Class	public class MaskEffect
Inheritance	MaskEffect Effect EventDispatcher Object
Subclasses	Iris , WipeDown , WipeLeft , WipeRight , WipeUp

MaskEffect 클래스는, Wipe effect나 Iris effect등과 같이 마스크를 애니메이션화하는 모든 effect의 추상 기본 클래스입니다. 이 클래스는, 마스크 베이스의 effect 모두에게 공통의 Methods와 property를 캡슐화합니다.

마스크 effect에서는, 마스크로 불리는 오버레이에 의해 effect가 실행됩니다. 디폴트에서는, 마스크는 타겟 컴퍼넌트와 같은 크기의 구형입니다.

마스크 effect에서는, effect 적용전 또는 적용 후의 타겟 컴퍼넌트 상태를 불가시로 할 필요가 있습니다. 즉, 마스크 effect를 적용하면, 타겟 컴퍼넌트가 항상 화면상에 표시되는지, 비표시가 됩니다.

마스크의 초기 배율과 최종 배율은,scaleXFrom,scaleYFrom,scaleXTo,scaleX 의 각 property를 사용해 지정합니다. 예를 들어, 1.0 을 지정하면 마스크의 크기는 타겟 컴퍼넌트와 같게 됩니다. 2.0 을 지정하면 마스크의 크기는 컴퍼넌트의 2 배가 됩니다. 0.5 를 지정하면 마스크의 크기는 컴퍼넌트의 반이 됩니다. 4 개의 property 모든 것을 지정하면, 어느 property도 사용할 수 있게 됩니다.

타겟 컴퍼넌트에 대한 마스크의 초기 상대 위치와 최종 상대 위치의 좌표는,xFrom,yFrom,xTo,yTo 의 각 property를 사용해 지정합니다. (0, 0)(은)는 타겟의 좌상구석을 나타냅니다. 4 개의 property 모든 것을 지정하면, 어느 property도 사용할 수 있게 됩니다.

마스크의 초기 위치와 최종 위치의 좌표는, effect의 종류와show property의 값이 true 와 false 의 어디에서 있을까에 따라서 다릅니다. 예를 들어, WipeLeft effect로 show 의 값이 false 로 설정되어 있는 경우, 마스크의 초기 위치의 좌표는 (0, 0), 즉 타겟의 좌상구석이 됩니다. 또, 최종 위치의 좌표는 타겟의 우상의 구석, 즉 (타겟의 폭, 0)이 됩니다.

WipeLeft effect로 show 가 true 로 설정되어 있는 경우, 마스크의 초기 위치는 (타겟의 폭, 0)으로, 최종 위치는 (0, 0)이 됩니다.

MXML 문장구조법 expanded

MXML 문장구조법의 비표시

다음의 property가 MaskEffect 클래스에서 정의되어 이 클래스의 모든 서브 클래스에 Inheritance됩니다.

 <mx:태그명 createMaskFunction="" moveEasingFunction="" scaleEasingFunction="" scaleXFrom="" scaleXTo="" scaleYFrom="" scaleYTo="" show="true|false" xFrom="" xTo="" yFrom="" yTo="" />

	property	정의
		className : String `"Fade"` 등, effect 클래스의 이름입니다.	Effect
		constructor : Object 특정의 object 인스턴스의 클래스 object 또는 constructor　　 함수에의 참조입니다.	Object
		createMaskFunction : Function effect에 의해 마스크가 작성될 때에 불려 가는 함수를 나타냅니다.	MaskEffect
		customFilter : EffectTargetFilter effect를 재생하는 타겟을 특정하기 위해서, effect에 의해 사용되는 타입 EffectTargetFilter 의 custom 필터 object를 지정합니다.	Effect
		duration : Number effect의 계속 시간을 나타냅니다 (밀리 세컨드 단위).	Effect
		filter : String effect의 타겟을 필터링 하는 알고리즘을 지정합니다.	Effect
		instanceClass : Class 이 effect 클래스의 effect 인스턴스 클래스를 지정하는 Class 형의 object를 나타냅니다.	Effect
		isPlaying : Boolean effect의 인스턴스중 한쪽이 현재 재생중의 경우에 true, 그렇지 않은 경우에 false 가 되는 읽기 전용(read-only) 플래그입니다.	Effect
		moveEasingFunction : Function 마스크를 이동시키는데 사용하는 이징 함수를 나타냅니다.	MaskEffect
		prototype : Object [static] 클래스 또는 함수 object의 prototype object에의 참조입니다.	Object
		relevantProperties : Array 필터링 실행시에 사용하는 property명의 배열을 나타냅니다.	Effect
		relevantStyles : Array 필터링 실행시에 사용하는 스타일명의 배열을 나타냅니다.	Effect
		repeatCount : int = 1 effect를 반복하는 회수를 나타냅니다.	Effect
		repeatDelay : int = 0 effect를 반복하기 전의 대기 시간을 나타냅니다 (밀리 세컨드 단위).	Effect
		scaleEasingFunction : Function 마스크를 신축시키는데 사용하는 이징 함수를 나타냅니다.	MaskEffect
		scaleXFrom : Number 마스크의 초기 scaleX 를 나타냅니다.	MaskEffect
		scaleXTo : Number 마스크의 종료 scaleX 를 나타냅니다.	MaskEffect
		scaleYFrom : Number 마스크의 초기 scaleY 를 나타냅니다.	MaskEffect
		scaleYTo : Number 마스크의 종료 scaleY 를 나타냅니다.	MaskEffect
		showTarget : Boolean 타겟 컴퍼넌트를 보이도록(듯이) 하는 경우는 `true` 로 설정해, 안보이게 되도록(듯이) 하는 경우는 `false` 로 설정합니다.	MaskEffect
		startDelay : int = 0 effect를 개시하기 전의 대기 시간을 나타냅니다 (밀리 세컨드 단위).	Effect
		suspendBackgroundProcessing : Boolean = false `true` 의 경우, effect의 재생중에 모든 백그라운드 처리를 블록 합니다.	Effect
		target : Object 이 effect가 적용되는 UIComponent object를 나타냅니다.	Effect
		targets : Array effect의 타겟인 UIComponent object의 배열을 나타냅니다.	Effect
		xFrom : Number 마스크의 초기 위치의 x 좌표를 나타냅니다.	MaskEffect
		xTo : Number 마스크의 이동처의 위치의 x 좌표를 나타냅니다.	MaskEffect
		yFrom : Number 마스크의 초기 위치의 y 좌표를 나타냅니다.	MaskEffect
		yTo : Number 마스크의 이동처의 위치의 y 좌표를 나타냅니다.	MaskEffect

	Methods	정의
		MaskEffect (target:Object = null) constructor　　.	MaskEffect
		addEventListener (type:String , listener:Function , useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void event listener objects를 EventDispatcher object에 등록해, listener가 이벤트의 통지를 받도록(듯이) 합니다.	EventDispatcher
		captureStartValues ():void effect의 타겟으로 두어 관련하는 property의 현재가를 capther 합니다.	Effect
		createInstance (target:Object = null):EffectInstance 1 개의 effect 인스턴스를 작성해, 그것을 초기화합니다.	Effect
		createInstances (targets:Array = null):Array 타겟 object의 배열을 취득해, 각 타겟으로 `createInstance()` Methods를 호출합니다.	Effect
		dispatchEvent (event:Event ):Boolean 이벤트를 event 플로우(flow)에 dispatch합니다.	EventDispatcher
		end (effectInstance:EffectInstance = null):void 현재 재생중의 effect를 모두 중단해, 즉시 effect의 끝나에 점프 합니다.	Effect
		getAffectedProperties ():Array 이 effect에 의해 변경된 컴퍼넌트 property를 돌려줍니다.	MaskEffect
		hasEventListener (type:String ):Boolean EventDispatcher object에, 특정의 event 타입에 대해서 등록된 listener가 있을지 어떨지를 확인합니다.	EventDispatcher
		hasOwnProperty (name:String ):Boolean object로 지정된 property가 정의되고 있는지 어떤지를 나타냅니다.	Object
		isPrototypeOf (theClass:Object ):Boolean Object 클래스의 인스턴스가, Parameters로서 지정된 object의 prototype 체인내에 있을지 어떨지를 나타냅니다.	Object
		pause ():void `resume()` Methods를 호출할 때까지, effect를 일시정지합니다.	Effect
		play (targets:Array = null, playReversedFromEnd:Boolean = false):Array effect의 재생을 개시합니다.	Effect
		propertyIsEnumerable (name:String ):Boolean 지정된 property가 존재해, 열거 가능한가 어떤가를 나타냅니다.	Object
		removeEventListener (type:String , listener:Function , useCapture:Boolean = false):void EventDispatcher object로부터 listener를 삭제합니다.	EventDispatcher
		resume ():void `pause()` Methods를 호출해, effect를 일시정지한 후, 재개시킵니다.	Effect
		reverse ():void effect가 현재 재생중의 경우에, effect의 현재 위치로부터 개시해, 역순서로 effect를 재생합니다.	Effect
		setPropertyIsEnumerable (name:String , isEnum:Boolean = true):void 루프 처리에 대한 다이나믹 property의 가용성을 설정합니다.	Object
		toString ():String 지정된 object의 string 표현을 돌려줍니다.	Object
		valueOf ():Object 지정된 object의 원시적치를 돌려줍니다.	Object
		willTrigger (type:String ):Boolean 지정된 event 타입에 대해, 이 EventDispatcher object 또는 그 조상에게 event listener가 등록되어 있는지 어떤지를 확인합니다.	EventDispatcher

	Methods	정의
		applyValueToTarget (target:Object , property:String , value:* , props:Object ):void effect 인프라스트럭쳐에 의해 내부적으로 사용됩니다.	Effect
		effectEndHandler (event:EffectEvent ):void effect 인스턴스의 재생 종료시에 불려 갑니다.	Effect
		effectStartHandler (event:EffectEvent ):void 이 Methods는, effect 인스턴스의 재생 개시시에 불려 갑니다.	Effect
		filterInstance (propChanges:Array , targ:Object ):Boolean effect 인스턴스의 필터링에 필요한 논리를 결정합니다.	Effect
		getValueFromTarget (target:Object , property:String ):* 타겟으로부터 property의 값을 취득하기 위해서 `captureStartValues()` 에 의해 불려 갑니다.	Effect
		initInstance (instance:EffectInstance ):void effect 인스턴스에 effect의 property를 복사합니다.	Effect
		tweenEventHandler (event:TweenEvent ):void TweenEffect 로부터 TweenEvent 가 dispatch되었을 때에 불려 갑니다.	MaskEffect

일람	정의
effectEnd	effect의 재생 정지시 (effect의 재생 완료시, 또는 effect가 `end()` Methods의 호출에 의해 중단되었을 때)에 dispatch됩니다.	Effect
effectStart	effect의 재생 개시시에 dispatch됩니다.	Effect
tweenEnd	effect의 종료시에 dispatch됩니다.	MaskEffect
tweenStart	effect의 개시시에 dispatch됩니다. 이것은 `onMoveTweenUpdate()` 및 `onScaleTweenUpdate()` Methods의 최초의 호출해에 대응합니다.	MaskEffect
tweenUpdate	effect로 타겟이 갱신될 때마다 dispatch됩니다.	MaskEffect

property의 상세

createMaskFunction

property

public var createMaskFunction:Function

effect에 의해 마스크가 작성될 때에 불려 가는 함수를 나타냅니다. 디폴트치는, 타겟과 같은 크기의 구형을 돌려주는 함수입니다.

커스텀 마스크 함수의 서명은 다음과 같습니다.

public function createLargeMask(targ:Object, bounds:Rectangle) :Shape
      {
var myMask:Shape = new FlexShape();
// 마스크를 작성한다.
return myMask;
      }

커스텀 마스크 함수는, effect의 타겟 컴퍼넌트에 대응하는 인수를 받습니다. 다음에, 타겟의 크기를 정의하는 인수를 받기 (위해)때문에, 정확하게 마스크의 크기를 설정할 수 있습니다. 이 인수를 사용해,width 나 height 등의 타겟 컴퍼넌트의 property에 액세스 할 수가 있습니다. 이 때문에, 올바른 크기의 마스크를 작성할 수 있습니다.

이 함수에 의해, 마스크를 정의하는 1 개의 Shape object가 돌려주어집니다.

moveEasingFunction

property

public var moveEasingFunction:Function

마스크를 이동시키는데 사용하는 이징 함수를 나타냅니다.

디폴트치null.

scaleEasingFunction

property

public var scaleEasingFunction:Function

마스크를 신축시키는데 사용하는 이징 함수를 나타냅니다.

디폴트치null.

scaleXFrom

property

public var scaleXFrom:Number

마스크의 초기 scaleX 를 나타냅니다.

이 property를 지정하려면 ,scaleXFrom,scaleYFrom,scaleXTo, 및 scaleX 의 4 개의 property를 모두 지정합니다.

scaleXTo

property

public var scaleXTo:Number

마스크의 종료 scaleX 를 나타냅니다.

이 property를 지정하려면 ,scaleXFrom,scaleYFrom,scaleXTo, 및 scaleX 의 4 개의 property를 모두 지정합니다.

scaleYFrom

property

public var scaleYFrom:Number

마스크의 초기 scaleY 를 나타냅니다.

이 property를 지정하려면 ,scaleXFrom,scaleYFrom,scaleXTo, 및 scaleX 의 4 개의 property를 모두 지정합니다.

scaleYTo

property

public var scaleYTo:Number

마스크의 종료 scaleY 를 나타냅니다.

이 property를 지정하려면 ,scaleXFrom,scaleYFrom,scaleXTo, 및 scaleX 의 4 개의 property를 모두 지정합니다.

showTarget

property

showTarget:Boolean [read-write]

타겟 컴퍼넌트를 보이도록(듯이) 하는 경우는 true 로 설정해, 안보이게 되도록(듯이) 하는 경우는 false 로 설정합니다. 이 effect를 showEffect 또는 hideEffect 방아쇠로 사용하도록(듯이) 지정했을 경우,showTarget property가 Flex 에 의해 유효하게 됩니다. 컴퍼넌트가 가시의 경우는 true 에, 불가시의 경우는 false 로 설정됩니다. 이 effect를 다른 effect 방아쇠로 사용하는 경우는,startEffect 이벤트의 event listener내에서 이 effect를 설정할 필요가 있는 경우가 있습니다.

디폴트치true.

Implements
public function get showTarget():Boolean
public function set showTarget(value:Boolean ):void

xFrom

property

public var xFrom:Number

마스크의 초기 위치의 x 좌표를 나타냅니다.

이 property를 지정하려면 ,xFrom,yFrom,xTo, 및 yTo 의 4 개의 property를 모두 지정합니다.

xTo

property

public var xTo:Number

마스크의 이동처의 위치의 x 좌표를 나타냅니다.

이 property를 지정하려면 ,xFrom,yFrom,xTo, 및 yTo 의 4 개의 property를 모두 지정합니다.

yFrom

property

public var yFrom:Number

마스크의 초기 위치의 y 좌표를 나타냅니다.

이 property를 지정하려면 ,xFrom,yFrom,xTo, 및 yTo 의 4 개의 property를 모두 지정합니다.

yTo

property

public var yTo:Number

마스크의 이동처의 위치의 y 좌표를 나타냅니다.

이 property를 지정하려면 ,xFrom,yFrom,xTo, 및 yTo 의 4 개의 property를 모두 지정합니다.

constructor　　 의 상세

MaskEffect

()

constructor　　

public 함수 MaskEffect(target:Object = null)

constructor　　.

Parameters

target:Object (default = null) — 이 effect로 애니메이션화하는 object를 나타냅니다.

Methods의 상세

getAffectedProperties

()

Methods

public override function getAffectedProperties():Array

이 effect에 의해 변경된 컴퍼넌트 property를 돌려줍니다. 이 Methods로 돌려주어지는 배열에는,[ "visible", "width", "height" ] WipeDown, WipeLeft, WipeRight, 및 WipeDown 의 모든 effect 서브 클래스가 동일한 property를 변경하기 위해(때문에), 이러한 클래스에서는 이 Methods를 Implements하지 않습니다.

MaskEffect 를 서브 클래스화해 custom effect를 작성해, 타겟의 다른 property 일식을 변경하는 경우는, 이 Methods를 재정의(override) 해, 서브 클래스에서 변경된 property 리스트를 포함한 배열을 돌려줄 필요가 있습니다.

반환값

Array — 이 effect로 변경된 property의 이름을 지정하는 string의 배열을 나타냅니다.

tweenEventHandler

()

Methods

protected function tweenEventHandler(event:TweenEvent ):void

TweenEffect 로부터 TweenEvent 가 dispatch되었을 때에 불려 갑니다. 이 Methods를 재정의(override) 하는 경우, 반드시 super Methods를 호출하도록 해 주세요.

Parameters

event:TweenEvent — TweenEvent 형의 event object를 나타냅니다.

이벤트의 상세

tweenEnd

event

Event object type: mx.events.TweenEvent
TweenEvent.type property = mx.events.TweenEvent.TWEEN_END

effect의 종료시에 dispatch됩니다.

effect가 1 번만 재생되었을 경우, 이 이벤트는 effectEnd 이벤트와 동시에 발생합니다. effect를 반복해 재생시키는 경우, 이 이벤트는 effect가 반복해질 때마다 발생해, 마지막 effect의 재생 후에 endEffect 이벤트가 발생합니다.

TweenEvent.TWEEN_END 정수에 의해,tweenEnd 이벤트의 event object의 type property치가 정의됩니다.

event object의 각 property에는 다음의 값이 설정됩니다.

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 `myButton.addEventListener()` 를 사용하면,`currentTarget` 의 값은 "myButton" 가 됩니다.
`target`	이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,`currentTarget` property를 사용해 주세요.
`value`	`onTweenEnd()` Methods에게 건네진 값입니다.

tweenStart

event

Event object type: mx.events.TweenEvent
TweenEvent.type property = mx.events.TweenEvent.TWEEN_START

effect의 개시시에 dispatch됩니다. 이것은 onMoveTweenUpdate() 및 onScaleTweenUpdate() Methods의 최초의 호출해에 대응합니다. 동시에 Flex 에 의해, effect의 최초의 tweenUpdate 이벤트도 dispatch됩니다.

Effect.effectStart 이벤트는 tweenStart 이벤트의 전에 dispatch됩니다.

TweenEvent.TWEEN_START 정수에 의해,tweenStart 이벤트의 event object의 type property치가 정의됩니다.

event object의 각 property에는 다음의 값이 설정됩니다.

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 `myButton.addEventListener()` 를 사용하면,`currentTarget` 의 값은 "myButton" 가 됩니다.
`target`	이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,`currentTarget` property를 사용해 주세요.
`value`	`onTweenUpdate()` Methods에게 건네지는 값입니다.

tweenUpdate

event

Event object type: mx.events.TweenEvent
TweenEvent.type property = mx.events.TweenEvent.TWEEN_UPDATE

effect로 타겟이 갱신될 때마다 dispatch됩니다. 이 이벤트의 dispatch은,onMoveTweenUpdate() 및 onScaleTweenUpdate() Methods의 호출해에 대응합니다.

TweenEvent.TWEEN_UPDATE 정수에 의해,tweenUpdate 이벤트의 event object의 type property치가 정의됩니다.

event object의 각 property에는 다음의 값이 설정됩니다.

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 `myButton.addEventListener()` 를 사용하면,`currentTarget` 의 값은 "myButton" 가 됩니다.
`target`	이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,`currentTarget` property를 사용해 주세요.
`value`	`onTweenUpdate()` Methods에게 건네지는 값입니다.

Adobe® Flex™ 2 Language Reference		모든 패키지 \| 모든 클래스 \| 언어 엘리먼트 \| 색인 \| 부록 \| 규칙 \| 프레임내에 표시 프레임 없음 버젼
Class MaskEffect	property \| Methods \| event