com.iplanet.jato.view.event
Class ViewRequestInvocationEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.iplanet.jato.view.event.ViewRequestInvocationEvent
All Implemented Interfaces:
RequestInvocationEvent, java.io.Serializable
Direct Known Subclasses:
TiledViewRequestInvocationEvent

public class ViewRequestInvocationEvent
extends java.util.EventObject
implements RequestInvocationEvent

Provides notification of a client request invocation. This provides detailed information about the request source and access to the RequestContext. The request source may often be (but is not limited to) a CommandField.

Since:
JATO/1.2
Version:
JATO/1.2.2 $Id: ViewRequestInvocationEvent.java,v 1.6 2002/03/16 03:26:43 todd Exp $
See Also:
Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ViewRequestInvocationEvent(java.lang.Object source, RequestContext requestContext, java.lang.String childName, java.lang.String qualifiedChildName)
          Creates a ViewRequestInvocationEvent object
ViewRequestInvocationEvent(java.lang.Object source, RequestContext requestContext, java.lang.String childName, java.lang.String qualifiedChildName, int imageX, int imageY)
          Creates a ViewRequestInvocationEvent object
ViewRequestInvocationEvent(java.lang.Object source, RequestContext requestContext, ViewInvocation invocation)
          Creates a ViewRequestInvocationEvent object
 
Method Summary
 java.lang.String getChildName()
          Returns the unqualified name of the child View associated with the request invocation.
 int getImageXCoordinate()
          Returns the X coordinate of the invoking image.
 int getImageYCoordinate()
          Returns the Y coordinate of the invoking image.
 java.lang.String getQualifiedChildName()
          Returns the qualified name of the child View associated with the request invocation.
 RequestContext getRequestContext()
          Returns the RequestContext.
 boolean hasImageCoordinates()
          Tests whether the request inovcation provided X and Y image coordinates.
 java.lang.String toString()
          Returns a String representation of this ViewRequestInvocationEvent.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ViewRequestInvocationEvent

public ViewRequestInvocationEvent(java.lang.Object source,
                                  RequestContext requestContext,
                                  ViewInvocation invocation)
Creates a ViewRequestInvocationEvent object
Parameters:
source - The request source.
requestContext - The RequestContext.
invocation - The ViewInvocation.

ViewRequestInvocationEvent

public ViewRequestInvocationEvent(java.lang.Object source,
                                  RequestContext requestContext,
                                  java.lang.String childName,
                                  java.lang.String qualifiedChildName)
Creates a ViewRequestInvocationEvent object
Parameters:
source - The request source.
requestContext - The RequestContext.
childName - The unqualified name of the child View associated with the request invocation.
qualifiedChildName - The fully qualified name of the child View associated with the request invocation.

ViewRequestInvocationEvent

public ViewRequestInvocationEvent(java.lang.Object source,
                                  RequestContext requestContext,
                                  java.lang.String childName,
                                  java.lang.String qualifiedChildName,
                                  int imageX,
                                  int imageY)
Creates a ViewRequestInvocationEvent object
Parameters:
source - The request source.
requestContext - The RequestContext.
childName - The unqualified name of the child View associated with the request invocation.
qualifiedChildName - The fully qualified name of the child View associated with the request invocation.
imageX - The X coordinate value of the image which triggerd the request.
imageY - The Y coordinate value of the image which triggerd the request.
Method Detail

toString

public java.lang.String toString()
Returns a String representation of this ViewRequestInvocationEvent.
Overrides:
toString in class java.util.EventObject
Returns:
a String representation of this ViewRequestInvocationEvent.

getRequestContext

public RequestContext getRequestContext()
Returns the RequestContext.
Specified by:
getRequestContext in interface RequestInvocationEvent
Returns:
the RequestContext.

getChildName

public java.lang.String getChildName()
Returns the unqualified name of the child View associated with the request invocation. This is equivalent to the unqualified name of the request source object.
Returns:
The name of the child View associated with the request invocation.

getQualifiedChildName

public java.lang.String getQualifiedChildName()
Returns the qualified name of the child View associated with the request invocation. This is equivalent to the fully qualified name of the request source object.
Returns:
The name of the child View associated with the request invocation.

hasImageCoordinates

public boolean hasImageCoordinates()
Tests whether the request inovcation provided X and Y image coordinates.
Returns:
true if the request inovcation provided X and Y image coordinates.

getImageXCoordinate

public int getImageXCoordinate()
Returns the X coordinate of the invoking image.
Returns:
the X coordinate of the invoking image, or -1 if the request did not originate from an image.

getImageYCoordinate

public int getImageYCoordinate()
Returns the Y coordinate of the invoking image.
Returns:
the Y coordinate of the invoking image, or -1 if the request did not originate from an image.