org.eclipse.gef
Class Request

java.lang.Object
  extended byorg.eclipse.gef.Request
Direct Known Subclasses:
CreateRequest, ForwardedRequest, GroupRequest, LocationRequest

public class Request
extends java.lang.Object

An Object used to communicate with EditParts. Request encapsulates the information EditParts need to perform various functions. Requests are used for obtaining commands, showing feedback, and performing generic operations. TODO: This should probably go into the org.eclipse.gef.requests package.


Constructor Summary
Request()
          Constructs an empty Request
Request(java.lang.Object type)
          Constructs a Request with the specified type
 
Method Summary
 java.util.Map getExtendedData()
          Returns a Map that can be used to save useful information in this request.
 java.lang.Object getType()
          Returns the type of the request.
 void setExtendedData(java.util.Map map)
          Sets the given map to be the new extended data (by reference) for this request.
 void setType(java.lang.Object type)
          Sets the type of the Request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Request

public Request()
Constructs an empty Request


Request

public Request(java.lang.Object type)
Constructs a Request with the specified type

Parameters:
type - the Request type
See Also:
getType()
Method Detail

getExtendedData

public java.util.Map getExtendedData()
Returns a Map that can be used to save useful information in this request.

Returns:
a map to store useful information

getType

public java.lang.Object getType()
Returns the type of the request. The type is often used as a quick way to filter recognized Requests. Once the type is identified, the Request is usually cast to a more specific subclass containing additional data.

Returns:
the Request type

setExtendedData

public void setExtendedData(java.util.Map map)
Sets the given map to be the new extended data (by reference) for this request.

Parameters:
map - The new map

setType

public void setType(java.lang.Object type)
Sets the type of the Request.

Parameters:
type - the Request type