Eclipse GEF
2.1

org.eclipse.gef.editpolicies
Class ContainerEditPolicy

java.lang.Object
  |
  +--org.eclipse.gef.editpolicies.AbstractEditPolicy
        |
        +--org.eclipse.gef.editpolicies.ContainerEditPolicy
All Implemented Interfaces:
EditPolicy, RequestConstants

public abstract class ContainerEditPolicy
extends AbstractEditPolicy

An EditPolicy for use with container editparts. This policy can be used to contribute commands to add, create, and orphan requests.


Field Summary
 
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_CHILDREN, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILDREN, REQ_OPEN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_SOURCE, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER
 
Constructor Summary
ContainerEditPolicy()
           
 
Method Summary
protected  void createCreateCommand(Object parent, CreationFactory factory)
          Deprecated. this is an archaic method left behind to force compile errors on old code.
protected  Command getAddCommand(GroupRequest request)
          Override to contribute to add requests.
 Command getCommand(Request request)
          Overridden to check for add, create, and orphan.
protected abstract  Command getCreateCommand(CreateRequest request)
          Clients must implement to contribute to create requests.
protected  Command getOrphanChildrenCommand(GroupRequest request)
          Override to contribute to orphan requests.
 
Methods inherited from class org.eclipse.gef.editpolicies.AbstractEditPolicy
activate, deactivate, debugFeedback, eraseSourceFeedback, eraseTargetFeedback, getHost, getTargetEditPart, setHost, showSourceFeedback, showTargetFeedback, toString, understandsRequest
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ContainerEditPolicy

public ContainerEditPolicy()
Method Detail

createCreateCommand

protected final void createCreateCommand(Object parent,
                                         CreationFactory factory)
Deprecated. this is an archaic method left behind to force compile errors on old code.

Parameters:
parent - the parent object
factory - the factory

getAddCommand

protected Command getAddCommand(GroupRequest request)
Override to contribute to add requests.

Parameters:
request - the add request
Returns:
the command contribution to the add

getCommand

public Command getCommand(Request request)
Overridden to check for add, create, and orphan.

Specified by:
getCommand in interface EditPolicy
Overrides:
getCommand in class AbstractEditPolicy
See Also:
EditPolicy.getCommand(org.eclipse.gef.Request)

getCreateCommand

protected abstract Command getCreateCommand(CreateRequest request)
Clients must implement to contribute to create requests.

Parameters:
request - the create request
Returns:
null or a command contribution

getOrphanChildrenCommand

protected Command getOrphanChildrenCommand(GroupRequest request)
Override to contribute to orphan requests.

Parameters:
request - the orphan request
Returns:
a command contribution for the orphan

Eclipse GEF
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.