org.modelio.api.modelio.picking

Interface IPickingClient

All Known Implementing Classes:

TextWrapperForIElement

public interface IPickingClient

Interface that represent a picking client.

A picking client is a GUI field that allows the user to edit a model element type or a link destination.

When the user clicks on the field, the IPickingClient:
- calls beginPicking(...) on the IPickingService
- answer to calls to acceptElement()
- receive a call to setElement()
- calls endPicking() on the IPickingService
- returns true from setElement() call

The picking client may end the picking session if its underlying field looses the edit focus.

Method Summary

Modifier and Type	Method and Description
boolean	acceptElement(MObject target) Returns whether the field accepts the element as a value.
void	pickingAborted() Called when another picking client calls beginPicking() on the picking service.
boolean	setElement(MObject target) Set the field value to the given element and end the picking session if the given element is valid.

Method Detail

pickingAborted

void pickingAborted()

Called when another picking client calls beginPicking() on the picking service. The receiver then has to return to its initial state.

acceptElement

boolean acceptElement(MObject target)

Returns whether the field accepts the element as a value.

Parameters:

target - the new value candidate.

Returns:

true if the new value is valid, false in the other case.

setElement

boolean setElement(MObject target)

Set the field value to the given element and end the picking session if the given element is valid.

Parameters:

target - The new represented element in the field

Returns:

true if the new value is valid, false in the other case.