org.eclipse.gef.editpolicies
Class AbstractEditPolicy

java.lang.Object
  |
  +--org.eclipse.gef.editpolicies.AbstractEditPolicy

All Implemented Interfaces:

EditPolicy, RequestConstants

Direct Known Subclasses:

AbstractTreeContainerEditPolicy, ComponentEditPolicy, ConnectionEditPolicy, ContainerEditPolicy, GraphicalEditPolicy, NodeEditPolicy

public abstract class AbstractEditPolicy

extends Object

implements EditPolicy, RequestConstants

The base implementation for the EditPolicy interface.

Since this is the default implementation of an interface, this document deals with proper sub-classing of this implementation. This class is not the API. For documentation on proper usage of the public API, see the documentation for the interface itself: EditPolicy.

	Indicates methods that are commonly overridden or even abstract
	These methods might be overridden. Especially if you were extending this class directly.
	Should rarely be overridden.
	Essentially "internal" and should never be overridden.

Fields inherited from interface org.eclipse.gef.EditPolicy

COMPONENT_ROLE, CONNECTION_BENDPOINTS_ROLE, CONNECTION_ENDPOINTS_ROLE, CONNECTION_ROLE, CONTAINER_ROLE, DIRECT_EDIT_ROLE, GRAPHICAL_NODE_ROLE, LAYOUT_ROLE, NODE_ROLE, PRIMARY_DRAG_ROLE, SELECTION_FEEDBACK_ROLE, TREE_CONTAINER_ROLE

Fields inherited from interface org.eclipse.gef.RequestConstants

REQ_ADD, REQ_ALIGN, REQ_ALIGN_CHILD, REQ_ALIGN_CHILDREN, REQ_ANCESTOR_DELETED, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_BENDPOINT, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILD, REQ_MOVE_CHILDREN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_END, REQ_RECONNECT_SOURCE, REQ_RECONNECT_START, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILD, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER, REQ_SOURCE_DELETED, REQ_TARGET_DELETED

Constructor Summary

AbstractEditPolicy()

Method Summary

void	activate() Called to activate this EditPolicy.
void	deactivate() This policy should shutdown and remove all listeners established in activate().
protected void	debugFeedback(String message)
void	eraseSourceFeedback(Request request) Erases source feedback based on the given request.
void	eraseTargetFeedback(Request request) Erases target feedback based on the given request.
Command	getCommand(Request request) Returns the command for a given request, or null if the EditPolicy does not work with that request type.
EditPart	getHost()
EditPart	getTargetEditPart(Request request) Returns the host EditPart if the EditPolicy works with the given request type, otherwise return null.
protected void	initialize() Initialize is called by activate().
void	setHost(EditPart host) Sets the host in which this EditPolicy is installed.
void	showSourceFeedback(Request request) Shows or updates source feedback if the receiver works with the request type.
void	showTargetFeedback(Request request) Shows or updates target feedback if the receiver works with the request type.
String	toString()
boolean	understandsRequest(Request req)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEditPolicy

public AbstractEditPolicy()

Method Detail

activate

public void activate()

Called to activate this EditPolicy. When activated, this edit policy may wish to add listeners to its host, its host's model, or some other Object. These listeners should be freed in deactivate(). initialize() is called to do any setup work that does not need to be undone. There is a current bug that initialize() is called every time activate is called. It will only be called once in the future

Specified by:

activate in interface EditPolicy

Following copied from interface: org.eclipse.gef.EditPolicy

See Also:

EditPart.activate(), EditPolicy.deactivate(), EditPart.installEditPolicy(Object, EditPolicy)

deactivate

public void deactivate()

Description copied from interface: EditPolicy

This policy should shutdown and remove all listeners established in activate(). deactivate() will be called either when the host is deactivated, or when this policy is uninstalled from its host.

Specified by:

deactivate in interface EditPolicy

Following copied from interface: org.eclipse.gef.EditPolicy

See Also:

EditPart.deactivate(), EditPolicy.activate(), EditPart.removeEditPolicy(Object)

debugFeedback

protected void debugFeedback(String message)

eraseSourceFeedback

public void eraseSourceFeedback(Request request)

Description copied from interface: EditPolicy

Erases source feedback based on the given request. Does nothing if the EditPolicy does not apply to the given request.

Specified by:

eraseSourceFeedback in interface EditPolicy

eraseTargetFeedback

public void eraseTargetFeedback(Request request)

Description copied from interface: EditPolicy

Erases target feedback based on the given request. Does nothing if the EditPolicy does not apply to the given request.

Specified by:

eraseTargetFeedback in interface EditPolicy

getCommand

public Command getCommand(Request request)

Description copied from interface: EditPolicy

Returns the command for a given request, or null if the EditPolicy does not work with that request type. null is treated as a no-op by the caller, or a zero contribution. The EditPolicy must return an UnexectuableCommand if it wishes to prevent the operation from being performed.

Specified by:

getCommand in interface EditPolicy

getHost

public EditPart getHost()

getTargetEditPart

public EditPart getTargetEditPart(Request request)

Description copied from interface: EditPolicy

Returns the host EditPart if the EditPolicy works with the given request type, otherwise return null. For all practical uses, this method has "boolean" behavior. It is possible, although rarely useful, to return an EditPart other than the host.

Specified by:

getTargetEditPart in interface EditPolicy

initialize

protected void initialize()

Initialize is called by activate(). There is no implied inverse to initialize(). Subclasses should override to perform one-time setup.

setHost

public void setHost(EditPart host)

Description copied from interface: EditPolicy

Sets the host in which this EditPolicy is installed.

Specified by:

setHost in interface EditPolicy

showSourceFeedback

public void showSourceFeedback(Request request)

Description copied from interface: EditPolicy

Shows or updates source feedback if the receiver works with the request type. This method may be called repeatedly for the purpose of updating feedback based on changes to the request object. Does nothing if the EditPolicy does not recognize the given request.

Specified by:

showSourceFeedback in interface EditPolicy

showTargetFeedback

public void showTargetFeedback(Request request)

Description copied from interface: EditPolicy

Shows or updates target feedback if the receiver works with the request type. This method may be called repeatedly for the purpose of updating feedback based on changes to the request object. Does nothing if the EditPolicy does not recognize the given request.

Specified by:

showTargetFeedback in interface EditPolicy

toString

public String toString()

Overrides:

toString in class Object

understandsRequest

public boolean understandsRequest(Request req)

Specified by:

understandsRequest in interface EditPolicy