com.modeliosoft.modelio.api.app.picking

Interface IPickingService

public interface IPickingService

Element picking services for picking providers.

This service allows edition of GUI fields representing the type of an attribute, parameter... by clicking on the new type in:

• the browser,
• a diagram
• or any GUI part implementing the IPickingProvider interface.

The GUI field typically implements the IPickingClient interface.
The browser and the diagrams implement the IPickingProvider interface.

When the user clicks on an picking enabled field :

• the IPickingClient calls startPickingSession(IPickingClient).
• the IPickingService calls IPickingProvider.enterPickingMode() on all IPickingProvider.

Then, when the user moves the mouse on an element in the the browser or any IPickingProvider:

• the IPickingProvider calls hoverElement(IElement) on the IPickingService, that forwards it to the client
• the IPickingClient answer to calls to IPickingClient.acceptElement(IElement).

When the user clicks on an element in the the browser or any IPickingProvider:

• the IPickingProvider calls selectElement(IElement) on the IPickingService, that forwards it to the client
  
• the IPickingClient receive a call to IPickingClient.setElement(IElement)
  
• the IPickingClient calls endPickingSession(IPickingClient) on the IPickingService
  
• the IPickingClientService forwards IPickingProvider.leavePickingMode() on all IPickingProvider
  
• the IPickingClient returns true from IPickingClient.setElement(IElement) call

See Also:

IPickingProvider, IPickingClient

Structure Diagram

Method Summary

Methods

Modifier and Type	Method and Description
void	endPickingSession(IPickingClient client) Abort the picking.
boolean	hoverElement(IElement target) Ask the picking client whether it accepts the given element.
void	registerPickingProvider(IPickingProvider pickingProvider) Registers an element picking provider .
void	selectElement(IElement target) Tell the picking client to pick the given element.
void	startPickingSession(IPickingClient client) Begin a picking session.
void	unregisterPickingProvider(IPickingProvider pickingProvider) Remove an element picking provider.

Method Detail

registerPickingProvider

void registerPickingProvider(IPickingProvider pickingProvider)

Registers an element picking provider .

The provider will be called each time a picking session is opened or closed by a IPickingClient.

Parameters:

pickingProvider - The provider to add.

unregisterPickingProvider

void unregisterPickingProvider(IPickingProvider pickingProvider)

Remove an element picking provider.

Parameters:

pickingProvider - The provider to remove.

hoverElement

boolean hoverElement(IElement target)

Ask the picking client whether it accepts the given element.
This method is called by a picking provider when the mouse is moved on a model element.

Parameters:

target - The model element

Returns:

true if the element is accepted, false in the other case

selectElement

void selectElement(IElement target)

Tell the picking client to pick the given element.
This method is called by a picking provider when the user click on a model element.
The picking client may either accept the element and close the picking session, or refuse it.

Parameters:

target - The model element

startPickingSession

void startPickingSession(IPickingClient client)

Begin a picking session.

Parameters:

client - The client that begins the picking session.

endPickingSession

void endPickingSession(IPickingClient client)

Abort the picking.

Calling this method cause the call of the pickingAborted on all picking clients.

Parameters:

client - The client to end picking on.