Interface EditPolicy

    • Field Detail

      • COMPONENT_ROLE

        static final java.lang.String COMPONENT_ROLE
        The key used to install a component EditPolicy. A component is defined as anything in the model. This EditPolicy should handle the fundamental operations that do not fit under any other EditPolicy role. For example, delete is a fundamental operation. Generally the component EditPolicy knows only about the model, and can be used in any type of EditPartViewer.
        See Also:
        Constant Field Values
      • CONNECTION_ENDPOINTS_ROLE

        static final java.lang.String CONNECTION_ENDPOINTS_ROLE
        The key used to install a connection endpoint EditPolicy. A connection endpoint EditPolicy is usually a SelectionHandlesEditPolicy subclass. Besides rendering selection by displaying Handles at then ends of the connection, the EditPolicy also understands how to move the endpoints of the connection. If the endpoints are moveable, the EditPolicy will show feedback and provide Commands to perform the move.
        See Also:
        Constant Field Values
      • CONNECTION_BENDPOINTS_ROLE

        static final java.lang.String CONNECTION_BENDPOINTS_ROLE
        The key used to install a bendpoint EditPolicy. A bendpoint EditPolicy is an optional EditPolicy for connections that are visibile. As with endpoints, bendpoint EditPolicies are porbably SelectionHandlesEditPolicy.
        See Also:
        Constant Field Values
      • CONNECTION_ROLE

        static final java.lang.String CONNECTION_ROLE
        The key used to install a connection EditPolicy. The behavior of a ConnectionEditPart may be implemented in its component EditPolicy,
        See Also:
        Constant Field Values
      • CONTAINER_ROLE

        static final java.lang.String CONTAINER_ROLE
        The key used to install a container EditPolicy.
        See Also:
        Constant Field Values
      • DIRECT_EDIT_ROLE

        static final java.lang.String DIRECT_EDIT_ROLE
        The key used to install a direct edit EditPolicy.
        See Also:
        Constant Field Values
      • GRAPHICAL_NODE_ROLE

        static final java.lang.String GRAPHICAL_NODE_ROLE
        The key used to install a graphical node EditPolicy.
        See Also:
        Constant Field Values
      • LAYOUT_ROLE

        static final java.lang.String LAYOUT_ROLE
        The key used to install a layout EditPolicy.
        See Also:
        Constant Field Values
      • NODE_ROLE

        static final java.lang.String NODE_ROLE
        The key used to install a node EditPolicy.
        See Also:
        Constant Field Values
      • PRIMARY_DRAG_ROLE

        static final java.lang.String PRIMARY_DRAG_ROLE
        The key used to install a primary drag EditPolicy.
        See Also:
        Constant Field Values
      • SELECTION_FEEDBACK_ROLE

        static final java.lang.String SELECTION_FEEDBACK_ROLE
        The key used to install a selection feedback EditPolicy.
        See Also:
        Constant Field Values
      • TREE_CONTAINER_ROLE

        static final java.lang.String TREE_CONTAINER_ROLE
        The key used to install a tree container EditPolicy.
        See Also:
        Constant Field Values
    • Method Detail

      • activate

        void activate()
        Activates this EditPolicy. The EditPolicy might need to hook listeners. These listeners should be unhooked in deactivate(). The EditPolicy might also contribute feedback/visuals immediately, such as selection handles if the EditPart was selected at the time of activation.

        Activate is called after the host has been set, and that host has been activated.

        See Also:
        EditPart.activate(), deactivate(), EditPart.installEditPolicy(Object, EditPolicy)
      • eraseSourceFeedback

        void eraseSourceFeedback​(Request request)
        Erases source feedback based on the given Request. Does nothing if the EditPolicy does not apply to the given Request.

        This method is declared on EditPart, and is redeclared here so that EditPart can delegate its implementation to each of its EditPolicies.

        Parameters:
        request - the Request
      • eraseTargetFeedback

        void eraseTargetFeedback​(Request request)
        Erases target feedback based on the given Request. Does nothing if the EditPolicy does not apply to the given Request.

        This method is declared on EditPart, and is redeclared here so that EditPart can delegate its implementation to each of its EditPolicies.

        Parameters:
        request - the Request
      • getCommand

        Command getCommand​(Request request)
        Returns the Command contribution for the given Request, or null. null is treated as a no-op by the caller, or an empty contribution. The EditPolicy must return an UnexecutableCommand if it wishes to disallow the Request.

        This method is declared on EditPart, and is redeclared here so that EditPart can delegate its implementation to each of its EditPolicies. The EditPart will combine each EditPolicy's contribution into a CompoundCommand.

        Parameters:
        request - the Request
        Returns:
        null or a Command contribution
      • getHost

        EditPart getHost()
        Returns:
        the host EditPart on which this policy is installed.
      • getTargetEditPart

        EditPart getTargetEditPart​(Request request)
        Returns null or the appropriate EditPart for the specified Request. In general, this EditPolicy will return its host EditPart if it understands the Request. Otherwise, it will return null.

        This method is declared on EditPart, and is redeclared here so that EditPart can delegate its implementation to each of its EditPolicies. The first non- null result returned by an EditPolicy is returned by the EditPart.

        Parameters:
        request - the Request
        Returns:
        null or the appropriate target EditPart
      • setHost

        void setHost​(EditPart editpart)
        Sets the host in which this EditPolicy is installed.
        Parameters:
        editpart - the host EditPart
      • showSourceFeedback

        void showSourceFeedback​(Request request)
        Shows or updates source feedback for the specified Request. This method may be called repeatedly for the purpose of updating feedback based on changes to the Request.

        Does nothing if the EditPolicy does not recognize the given Request.

        This method is declared on EditPart, and is redeclared here so that EditPart can delegate its implementation to each of its EditPolicies.

        Parameters:
        request - the Request
      • showTargetFeedback

        void showTargetFeedback​(Request request)
        Shows or updates target feedback for the specified Request. This method may be called repeatedly for the purpose of updating feedback based on changes to the Request.

        Does nothing if the EditPolicy does not recognize the given request.

        This method is declared on EditPart, and is redeclared here so that EditPart can delegate its implementation to each of its EditPolicies.

        Parameters:
        request - the Request
      • understandsRequest

        boolean understandsRequest​(Request request)
        Returns true if this EditPolicy understand the specified request.

        This method is declared on EditPart, and is redeclared here so that EditPart can delegate its implementation to each of its EditPolicies. EditPart returns true if any of its EditPolicies returns true. In other words, it performs a logical OR.

        Parameters:
        request - the Request
        Returns:
        boolean true if the EditPolicy understands the specified request
        See Also:
        EditPart.understandsRequest(Request)