Clearspace API (1.10.16) Core Javadocs

com.jivesoftware.community.event
Class ImageEvent

java.lang.Object
  extended by com.jivesoftware.community.event.ImageEvent
All Implemented Interfaces:
JiveEvent, java.io.Serializable

public class ImageEvent
extends java.lang.Object
implements JiveEvent, java.io.Serializable

A class for Image events. This class will be passed to ImageListeners whenever an image event is fired and contains all the pertinent information to the event.

See Also:
Serialized Form

Field Summary
static int IMAGE_ADDED
          Event type for whenever an image is added to a document.
static int IMAGE_DELETING
          Event type for whenever an image is about to be deleted.
 
Constructor Summary
ImageEvent(int eventType, JiveObject jiveObject, Image image, java.util.Map<java.lang.String,? extends java.lang.Object> params)
           
 
Method Summary
 java.util.Date getDate()
          Returns the date (as a Date object) that the event was created.
 int getEventType()
          Returns the event type corresponding to the event.
 Image getImage()
           
 JiveObject getJiveObject()
           
 java.util.Map<java.lang.String,? extends java.lang.Object> getParams()
          Returns a map of parameters which can be used to pass data to a listener.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IMAGE_ADDED

public static final int IMAGE_ADDED
Event type for whenever an image is added to a document.

See Also:
Constant Field Values

IMAGE_DELETING

public static final int IMAGE_DELETING
Event type for whenever an image is about to be deleted.

See Also:
Constant Field Values
Constructor Detail

ImageEvent

public ImageEvent(int eventType,
                  JiveObject jiveObject,
                  Image image,
                  java.util.Map<java.lang.String,? extends java.lang.Object> params)
Method Detail

getEventType

public int getEventType()
Description copied from interface: JiveEvent
Returns the event type corresponding to the event.

Specified by:
getEventType in interface JiveEvent
Returns:
the event type corresponding to the event.

getJiveObject

public JiveObject getJiveObject()

getImage

public Image getImage()

getParams

public java.util.Map<java.lang.String,? extends java.lang.Object> getParams()
Description copied from interface: JiveEvent
Returns a map of parameters which can be used to pass data to a listener.

Specified by:
getParams in interface JiveEvent
Returns:
map of parameters which can be used to pass data to a listener.

getDate

public java.util.Date getDate()
Description copied from interface: JiveEvent
Returns the date (as a Date object) that the event was created.

Specified by:
getDate in interface JiveEvent
Returns:
the date (as a Date object) that the event was created.

Clearspace Project Page

Copyright © 1999-2007 Jive Software.