Package org.eclipse.gef.requests

Class CreateRequest

java.lang.Object

org.eclipse.gef.Request

org.eclipse.gef.requests.LocationRequest

org.eclipse.gef.requests.CreateRequest

All Implemented Interfaces:

DropRequest

Direct Known Subclasses:

CreateConnectionRequest

public class CreateRequest
extends LocationRequest
implements DropRequest

A Request to create a new object.

Constructor Summary

Constructors

Constructor	Description
CreateRequest()	Creates a CreateRequest with the default type.
CreateRequest(Object type)	Creates a CreateRequest with the given type.

Method Summary

Modifier and Type	Method	Description
protected CreationFactory	getFactory()	Returns the CreationFactory for this request.
Object	getNewObject()	Gets the new object from the factory and returns that object.
Object	getNewObjectType()	Returns the type of the new object.
Dimension	getSize()	Returns the size of the object to be created.
boolean	isSnapToEnabled()	Returns true if snap-to is enabled
void	setFactory(CreationFactory factory)	Sets the factory to be used when creating the new object.
void	setSize(Dimension size)	Sets the size of the new object.
void	setSnapToEnabled(boolean value)	Used to set whether snap-to is being performed.

Methods inherited from class org.eclipse.gef.requests.LocationRequest

getLocation, setLocation

Methods inherited from class org.eclipse.gef.Request

getExtendedData, getType, setExtendedData, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.gef.requests.DropRequest

getLocation

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

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 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

setSize

public void setSize(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