コンポーネントイベントの例

コンポーネントイベント

ceEvent.evt

次のコンポーネントイベントには属性が 1 つ設定されています。この場合は、起動時にこの属性を使用してイベントに一定のデータを渡します。

1swfobject.registerObject("clippy.codeblock-0", "9");<aura:event type="COMPONENT">
2    <aura:attribute name="message" type="String"/>
3</aura:event>

ノーティファイアコンポーネント

ceNotifier.cmp

このコンポーネントは aura:registerEvent を使用して、コンポーネントイベントを起動する可能性があることを宣言します。

コンポーネントのボタンには、press ブラウザイベントがあり、クライアント側コントローラの fireComponentEvent アクションに結び付けられています。ボタンをクリックすると、アクションが呼び出されます。

1swfobject.registerObject("clippy.codeblock-1", "9");<aura:component>
2    <aura:registerEvent name="cmpEvent" type="docsample:ceEvent"/>
3
4    <h1>Simple Component Event Sample</h1>
5    <p><ui:button
6        label="Click here to fire a component event"
7        press="{!c.fireComponentEvent}" />
8    </p>
9</aura:component>

ceNotifierController.js

クライアント側コントローラが、cmp.getEvent("cmpEvent") をコールして、イベントのインスタンスを取得します。この cmpEvent は、コンポーネントのマークアップにある <aura:registerEvent> タグの名前属性の値と一致します。このコントローラがイベントの message 属性を設定して、イベントを起動します。

1swfobject.registerObject("clippy.codeblock-2", "9");{
2    fireComponentEvent : function(cmp, event) {
3        // Get the component event by using the
4        // name value from aura:registerEvent
5        var cmpEvent = cmp.getEvent("cmpEvent");
6        cmpEvent.setParams({
7            "message" : "A component event fired me. " +
8            "It all happened so fast. Now, I'm here!" });
9        cmpEvent.fire();
10    }
11}

ハンドラコンポーネント

ceHandler.cmp

ハンドラコンポーネントには、<docsample:ceNotifier> コンポーネントが含まれ、<docsample:ceNotifier> にある <aura:registerEvent> タグから、name 属性の値 cmpEvent を使用してハンドラを登録します。

イベントが起動されると、ハンドラコンポーネントのクライアント側コントローラで handleComponentEvent アクションが呼び出されます。

1swfobject.registerObject("clippy.codeblock-3", "9");<aura:component>
2    <aura:attribute name="messageFromEvent" type="String"/>
3    <aura:attribute name="numEvents" type="Integer" default="0"/>
4
5    <!-- handler contains the notifier component 
6     Note that cmpEvent is the value of the name attribute in aura:registerEvent
7     in ceNotifier.cmp -->
8    <docsample:ceNotifier cmpEvent="{!c.handleComponentEvent}"/>
9    
10    <p>{!v.messageFromEvent}</p>
11    <p>Number of events: {!v.numEvents}</p>
12
13</aura:component>

ceHandlerController.js

コントローラがイベントで送信されたデータを取得し、そのデータを使用してハンドラコンポーネントの messageFromEvent 属性を更新します。

1swfobject.registerObject("clippy.codeblock-4", "9");{
2    handleComponentEvent : function(cmp, event) {
3        var message = event.getParam("message");
4
5        // set the handler attributes based on event data
6        cmp.set("v.messageFromEvent", message);
7        var numEventsHandled = parseInt(cmp.get("v.numEvents")) + 1;
8        cmp.set("v.numEvents", numEventsHandled);
9    }
10}

すべてをまとめる

このコードをテストする場合は、リソースをサンプルアプリケーションに追加して、ハンドラコンポーネントに移動します。たとえば、docsample アプリケーションがある場合は、次のアドレスに移動します。

http://<mySalesforceInstance>/<namespace>/docsample/ceHandler.cmp (mySalesforceInstance は、na1.salesforce.com など、組織をホストするインスタンスの名前です)。

サーバ上のデータにアクセスする場合は、この例を拡張して、ハンドラのクライアント側コントローラからサーバ側コントローラをコールします。