no versions found for ApplicationFrameworkReferences / Components/View/ProtoViewLogic/protoviewlogic_removeActiveEvents / en

ProtoViewLogic: removeActiveEvents()

メソッド relateElements() によって ProtoViewLogic に関連付けられた HTML 要素に対して、指定した種別のイベント通知を無効にします。

構文

protoViewLogic.removeActiveEvents(targetElementName, eventType) => Array<string>
protoViewLogic.removeActiveEvents(targetElementName, eventType1, eventType2, ...) => Array<string>
protoViewLogic.removeActiveEvents(targetElementName, "eventType1, eventType2, ...") => Array<string>

引数

  • targetElementName: string

    イベント通知を無効化する要素名です。

  • eventsToBeDeactivated: Array<string>

    無効化するイベント種別です。

返値: Array<string>

無効になったイベント種別です。

例外

  • ReferenceError
    • 対象の ProtoViewLogic が引数 targetElementName で指定された名前のプロパティを持っていなかった場合
  • TypeError
    • 対象の ProtoViewLogic が引数 targetElementName で指定されたプロパティが relateElements() によって関連付けられた Element でなかった場合
    • 引数 evevntsToBeActivated に文字列以外の値が含まれる場合

解説

addActiveEvents() で登録された同名の要素 targetElementName と同種のイベント eventsToBeDeactivated を対象としたイベントリスナーを削除します。

イベントリスナーの削除後、対象の要素のカスタムデータ属性 data-active-events から無効になったイベント種別を削除します。