org.sourcejammer.client.event
Class SJClientEventImpl

java.lang.Object
  |
  +--org.sourcejammer.client.event.SJClientEventImpl
All Implemented Interfaces:
SJClientEvent
Direct Known Subclasses:
SJClientFileEventImpl, SJClientProjecEventImpl

public class SJClientEventImpl
extends java.lang.Object
implements SJClientEvent

Title: $FileName: SJClientEventImpl.java$

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

$Description: Implementations of client plugin objects.$
$KeyWordsOff: $

Default implementation of SJClientEvent.

Field Summary
private  GUIContext gUIContext
           
private  org.sourcejammer.project.view.SJRequest request
           
private  java.lang.Object source
           
private  EventTimingType timing
           
 
Constructor Summary
SJClientEventImpl()
           
 
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.
 org.sourcejammer.project.view.SJRequest getRequest()
          Returns the request.
 java.lang.Object getSource()
          Returns the source.
 EventTimingType getTiming()
          Returns the timing.
 void setGUIContext(GUIContext gUIContext)
          Sets the gUIContext.
 void setRequest(org.sourcejammer.project.view.SJRequest request)
          Sets the request.
 void setSource(java.lang.Object source)
          Sets the source.
 void setTiming(EventTimingType timing)
          Sets the timing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

gUIContext

private GUIContext gUIContext

source

private java.lang.Object source

timing

private EventTimingType timing

request

private org.sourcejammer.project.view.SJRequest request
Constructor Detail

SJClientEventImpl

public SJClientEventImpl()
Method Detail

addObjectToRequest

public void addObjectToRequest(java.lang.Object o,
                               java.lang.String name)
Description copied from interface: SJClientEvent
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.

Specified by:
addObjectToRequest in interface SJClientEvent
See Also:
SJClientEvent.addObjectToRequest(Object, String)

getGUIContext

public GUIContext getGUIContext()
Returns the gUIContext.

Specified by:
getGUIContext in interface SJClientEvent
Returns:
GUIContext

getRequest

public org.sourcejammer.project.view.SJRequest getRequest()
Returns the request.

Returns:
SJRequest

getSource

public java.lang.Object getSource()
Returns the source.

Specified by:
getSource in interface SJClientEvent
Returns:
Object

getTiming

public EventTimingType getTiming()
Returns the timing.

Specified by:
getTiming in interface SJClientEvent
Returns:
EventTimingType

setGUIContext

public void setGUIContext(GUIContext gUIContext)
Sets the gUIContext.

Parameters:
gUIContext - The gUIContext to set

setRequest

public void setRequest(org.sourcejammer.project.view.SJRequest request)
Sets the request.

Parameters:
request - The request to set

setSource

public void setSource(java.lang.Object source)
Sets the source.

Parameters:
source - The source to set

setTiming

public void setTiming(EventTimingType timing)
Sets the timing.

Parameters:
timing - The timing to set


Copyright 2003 Soucejammer project.