1 /*

     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 */

    17 

    18 package com.nokia.mid.ui;

    19 

    20 /**

    21  * <code>SoftNotificationListener</code> interface is used by applications which

    22  * need callbacks from soft notifications. Listener will get a notification when the

    23  * soft notification is either selected or dismissed by the user. Listener

    24  * interface can be registered with

    25  * {@link SoftNotification#setListener(SoftNotificationListener)} method.

    26  *

    27  * @see SoftNotification

    28  */

    29 public interface SoftNotificationListener

    30 {

    31 

    32     /**

    33      * Indicates that a soft notification was selected by the user. The

    34      * platform calls {@link SoftNotification#remove()} before

    35      * notificationSelected() is called. Application that posted the soft

    36      * notification is activated before the listener will get the notification.

    37      *

    38      * @param notification A notification object identifying the soft

    39      *          notification being responded to by the user. The MIDlet must

    40      *          implement the functionality to be performed when the

    41      *          notification is selected.

    42      */

    43     public abstract void notificationSelected(SoftNotification notification);

    44 

    45     /**

    46      * Indicates that a soft notification was dismissed by the user. The

    47      * platform calls {@link SoftNotification#remove()} before

    48      * notificationDismissed() is called.

    49      *

    50      * @param notification A notification object identifying the soft

    51      *          notification being responded to by the user. The application must

    52      *          implement the functionality to be performed when the soft

    53      *          notification is dismissed, it is not required to do anything.

    54      */

    55     public abstract void notificationDismissed(SoftNotification notification);

    56 

    57 }