Class CreateRequest

java.lang.Object
org.eclipse.gef.Request
org.eclipse.gef.requests.CreateRequest
All Implemented Interfaces:
DropRequest
Direct Known Subclasses:
CreateConnectionRequest

public class CreateRequest extends Request implements DropRequest
A Request to create a new object.
  • Constructor Details

    • CreateRequest

      public CreateRequest()
      Creates a CreateRequest with the default type.
    • CreateRequest

      public CreateRequest(Object type)
      Creates a CreateRequest with the given type.
      Parameters:
      type - The type of request.
  • Method Details

    • getFactory

      protected CreationFactory getFactory()
      Returns the CreationFactory for this request.
      Returns:
      the CreationFactory
    • getLocation

      public org.eclipse.draw2d.geometry.Point getLocation()
      Returns the location of the object to be created.
      Specified by:
      getLocation in interface DropRequest
      Returns:
      the location
    • getNewObject

      public Object getNewObject()
      Gets the new object from the factory and returns that object.
      Returns:
      the new object
    • getNewObjectType

      public Object getNewObjectType()
      Returns the type of the new object.
      Returns:
      the type of the new object
    • getSize

      public org.eclipse.draw2d.geometry.Dimension getSize()
      Returns the size of the object to be created.
      Returns:
      the size
    • isSnapToEnabled

      public boolean isSnapToEnabled()
      Returns true if snap-to is enabled
      Returns:
      true if the request is for a creation with snap-to enabled
      Since:
      3.7
    • setFactory

      public void setFactory(CreationFactory factory)
      Sets the factory to be used when creating the new object.
      Parameters:
      factory - the factory
    • setLocation

      public void setLocation(org.eclipse.draw2d.geometry.Point location)
      Sets the location where the new object will be placed.
      Parameters:
      location - the location
    • setSize

      public void setSize(org.eclipse.draw2d.geometry.Dimension size)
      Sets the size of the new object.
      Parameters:
      size - the size
    • setSnapToEnabled

      public void setSnapToEnabled(boolean value)
      Used to set whether snap-to is being performed.
      Parameters:
      value - true if the request is for a creation with snap-to enabled
      Since:
      3.7