com.iplanet.jato.view
Class ViewInvocation

java.lang.Object
  |
  +--com.iplanet.jato.view.ViewInvocation
Direct Known Subclasses:
TiledViewInvocation, TreeHandleViewInvocation

public class ViewInvocation
extends java.lang.Object

Contains relevant values for a request invocation on a view object. This class is used internally by the foundation classes and should not generally be useful to developers.

Version:
JATO/1.2.2 $Id: ViewInvocation.java,v 1.12 2002/03/16 03:26:42 todd Exp $

Constructor Summary
ViewInvocation(RequestHandler targetRequestHandler, java.lang.String childName, java.lang.String qualifiedChildName, CommandDescriptor commandDescriptor)
          Creates a ViewInvocation object
ViewInvocation(RequestHandler targetRequestHandler, java.lang.String childName, java.lang.String qualifiedChildName, int imageX, int imageY, CommandDescriptor commandDescriptor)
          Creates a ViewInvocation object
 
Method Summary
 java.lang.String getChildName()
          Returns the unqualified name of the child View associated with the request invocation.
 CommandDescriptor getCommandDescriptor()
          Returns the CommandDescriptor.
 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.
 RequestHandler getTargetRequestHandler()
          Returns the RequestHandler to which the request should be directed.
 boolean hasImageCoordinates()
          Tests whether the request inovcation provided X and Y image coordinates.
 java.lang.String toString()
          Returns a String representation of this ViewInvocation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ViewInvocation

public ViewInvocation(RequestHandler targetRequestHandler,
                      java.lang.String childName,
                      java.lang.String qualifiedChildName,
                      CommandDescriptor commandDescriptor)
Creates a ViewInvocation object
Parameters:
targetRequestHandler - The RequestHandler to which this invocation should be directed.
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.
commandDescriptor - The CommandDescriptor

ViewInvocation

public ViewInvocation(RequestHandler targetRequestHandler,
                      java.lang.String childName,
                      java.lang.String qualifiedChildName,
                      int imageX,
                      int imageY,
                      CommandDescriptor commandDescriptor)
Creates a ViewInvocation object
Parameters:
targetRequestHandler - The RequestHandler to which the request should be directed.
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.
commandDescriptor - The CommandDescriptor
Method Detail

toString

public java.lang.String toString()
Returns a String representation of this ViewInvocation.
Overrides:
toString in class java.lang.Object
Returns:
a String representation of this ViewInvocation.

getTargetRequestHandler

public RequestHandler getTargetRequestHandler()
Returns the RequestHandler to which the request should be directed.
Returns:
The RequestHandler to which the request should be directed.

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.

getCommandDescriptor

public CommandDescriptor getCommandDescriptor()
Returns the CommandDescriptor.
Returns:
The CommandDescriptor.

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.