net.rim.blackberry.api.mail.event
Class MailEvent

java.lang.Object
  extended by net.rim.blackberry.api.mail.event.MailEvent
Direct Known Subclasses:
FolderEvent, MessageEvent, StoreEvent

public abstract class MailEvent
extends Object

Base class for mail events.

This class defines an abstract MailEvent.dispatch(java.lang.Object) method to invoke the appropriate listener method for each event.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

Constructor Summary
Category: Signed MailEvent(Object source)
          Constructs a new MailEvent instance with provided source.
 
Method Summary
Category: Signed abstract  void dispatch(Object listener)
          Invokes the appropriate method on a listener for this event.
Category: Signed  Object getSource()
          Retrieves the source for this mail event.
Category: Signed  String toString()
          Retrieves string form of this mail event.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 



Constructor Detail

MailEvent

public MailEvent(Object source)
Constructs a new MailEvent instance with provided source.

Parameters:
source - Source for new mail event.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0


Method Detail

getSource

public Object getSource()
Retrieves the source for this mail event.

Returns:
Object representing the source of the event.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

toString

public String toString()
Retrieves string form of this mail event.

Overrides:
toString in class Object
Returns:
Null; sub-classes should override this method to provide specific functionality.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

dispatch

public abstract void dispatch(Object listener)
Invokes the appropriate method on a listener for this event.

Subclasses should override this method to provide specific functionality (that is, to dispatch to the appropriate method on the appropriate listener type).

Parameters:
listener - Listener to handle this event.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.