Table of Contents

Namespace NMF.Glsp.Protocol.Types

Classes

Bounds

The bounds are the position (x, y) and dimension (width, height) of an object. As such the Bounds type extends both Point and Dimension.

CheckEdgeResultAction

Sent from the server to the client as a response for a {@link RequestCheckEdgeAction}. It provides a boolean indicating whether the edge context information provided by the corresponding request action is valid i.e. creation of an edge with the given edge type and source/target element is allowed.

EdgeLabelPlacement

Denotes the placement of a label relative to an edge

EdgeTypeHint

Type hints for edges

EditorContext

The EditorContext may be used to represent the current state of the editor for particular actions. It encompasses the last recorded mouse position, the list of selected elements, and may contain custom arguments to encode additional state information.

ElementAndAlignment

The ElementAndAlignment type is used to associate a new alignment with a model element, which is referenced via its id.

ElementAndBounds

The ElementAndBounds type is used to associate new bounds with a model element, which is referenced via its id.

ElementAndRoutingPoints

The ElementAndRoutingPoints type is used to associate an edge with specific routing points.

LabeledAction

Labeled actions are used to denote a group of actions in a user-interface context, e.g., to define an entry in the command palette or in the context menu.

RequestCheckEdgeAction

Sent from the client to the server to check wether the provided edge context information is valid i.e. creation of an edge with the given edge type and source/target element is allowed by the server. Typically this action is dispatched by edge creation tools in the creation phase of an edge that’s associated with a dynamic EdgeTypeHint.

RequestTypeHintsAction

Sent from the client to the server in order to request hints on whether certain modifications are allowed for a specific element type. The RequestTypeHintsAction is optional, but should usually be among the first messages sent from the client to the server after receiving the model via RequestModelAction. The response is a SetTypeHintsAction.

SetTypeHintsAction

Sent from the server to the client in order to provide hints certain modifications are allowed for a specific element type.

ShapeTypeHint

Type hints for shapes

TypeHint

Type hints are used to define what modifications are supported on the different element types. Conceptually type hints are similar to features of a model elements but define the functionality on a type level. The rationale is to avoid a client-server round-trip for user feedback of each synchronous user interaction.

Structs

Dimension

The Dimension of an object is composed of its width and height.

Point

A Point is composed of the (x,y) coordinates of an object.