org.modelio.api.modelio.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 IPickingService#hoverElement(Element) on the IPickingService, that forwards it to the client
• the IPickingClient answer to calls to IPickingClient#acceptElement(Element).

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

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

See Also:

IPickingProvider, IPickingClient

Method Summary

Modifier and Type	Method and Description
void	endPickingSession(IPickingSession session) Abort the picking.
void	registerPickingProvider(IPickingProvider pickingProvider) Registers an element picking provider .
IPickingSession	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.

startPickingSession

IPickingSession startPickingSession(IPickingClient client)

Begin a picking session.

Parameters:

client - The client that begins the picking session.

endPickingSession

void endPickingSession(IPickingSession session)

Abort the picking.

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

Parameters:

client - The client to end picking on.