org.sourcejammer.client.plugin
Interface SJClientEvent

All Known Subinterfaces:
SJClientFileEvent, SJClientProjectEvent
All Known Implementing Classes:
SJClientEventImpl, SJClientFileEventImpl, SJClientProjecEventImpl

public interface SJClientEvent

Title: $FileName: SJClientEvent.java$

Version:
$VerNum: 2$
Author:
$AuthorName: Rob MacGrogan$

$Description: $
$KeyWordsOff: $

Method Summary
 void addObjectToRequest(java.lang.Object o, java.lang.String name)
          The specified object will be added to the SJRequest using the specified name before it is sent to the server.
 GUIContext getGUIContext()
          Returns the GUIContext.
 java.lang.Object getSource()
          Returns the source of the event.
 EventTimingType getTiming()
          Returns the timing of the event.
 

Method Detail

getGUIContext

public GUIContext getGUIContext()
Returns the GUIContext.


getSource

public java.lang.Object getSource()
Returns the source of the event. This will most likely be a dialog, but could be some other object. Not completely spec-ed out yet.


getTiming

public EventTimingType getTiming()
Returns the timing of the event.


addObjectToRequest

public void addObjectToRequest(java.lang.Object o,
                               java.lang.String name)
The specified object will be added to the SJRequest using the specified name before it is sent to the server. Obviously this method is only valid for BEFORE_EVENT and BEFORE_REQUEST_SENT timing types.

Server-side plugin can access the object by calling objectValue(name) on the SJRequest.



Copyright 2003 Soucejammer project.