com.modeliosoft.modelio.api.ui.text

Class TextWrapperForIElement

java.lang.Object

com.modeliosoft.modelio.api.ui.text.TextWrapperForIElement

All Implemented Interfaces:

IPickingClient, IEditorDropClient

public class TextWrapperForIElement
extends Object
implements IPickingClient, IEditorDropClient

Reusable component wrapping an SWT Text widget (because inheriting from Text is not possible) to add the Ctrl+Space auto-completion, the picking mode and the droppable features associated with the edition of a model element.

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.eclipse.swt.graphics.Image	indicatorImage
protected org.eclipse.swt.widgets.Text	textField

Constructor Summary

Constructors

Constructor and Description
TextWrapperForIElement(org.eclipse.swt.widgets.Composite parent, IElement initialElement, boolean acceptNullValue, List<Class<? extends IElement>> allowedMetaclasses) C'tor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptDroppedElements(IElement[] target) Returns whether the field accepts the element as a value.
boolean	acceptElement(IElement target) Returns whether the field accepts the element as a value.
void	addAllowedMetaclass(Class<? extends IElement> allowedMetaclass)
void	addAllowedMetaclasses(List<Class<? extends IElement>> metaclasses)
void	addListener(IElementChangeListener listener)
void	createContent(org.eclipse.swt.widgets.Composite parent)
protected void	endPickingSession()
List<IElement>	findByName(List<Class<? extends IElement>> metaclasses, String nameValue, IElementFilter filter) Search model elements by their name.
List<Class<? extends IElement>>	getAllowedMetaclasses()
org.eclipse.swt.widgets.Text	getTextField()
boolean	isAcceptNullValue()
protected void	onKeyPressed(org.eclipse.swt.events.KeyEvent e)
void	pickingAborted() Called when another picking client calls beginPicking() on the picking service.
boolean	removeAllowedMetaclass(Class<? extends IElement> allowedMetaclass)
boolean	removeAllowedMetaclasses(List<Class<? extends IElement>> metaclasses)
void	removeListener(IElementChangeListener listener)
void	setAcceptNullValue(boolean acceptNullValue)
void	setDroppedElements(IElement[] dropedElement) Set the field value to the given element and end the picking session if the given element is valid.
boolean	setElement(IElement target) Set the field value to the given element and end the picking session if the given element is valid.
void	setElementFilter(IElementFilter elementFilter)
protected void	startPickingSession()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

textField

protected org.eclipse.swt.widgets.Text textField

indicatorImage

protected static final org.eclipse.swt.graphics.Image indicatorImage

Constructor Detail

TextWrapperForIElement

public TextWrapperForIElement(org.eclipse.swt.widgets.Composite parent,
                      IElement initialElement,
                      boolean acceptNullValue,
                      List<Class<? extends IElement>> allowedMetaclasses)

C'tor.

Parameters:

parent - parent control.

initialElement - initial value.

acceptNullValue - whether the null value should be accepted or not.

Method Detail

isAcceptNullValue

public boolean isAcceptNullValue()

setAcceptNullValue

public void setAcceptNullValue(boolean acceptNullValue)

addAllowedMetaclass

public void addAllowedMetaclass(Class<? extends IElement> allowedMetaclass)

removeAllowedMetaclass

public boolean removeAllowedMetaclass(Class<? extends IElement> allowedMetaclass)

addAllowedMetaclasses

public void addAllowedMetaclasses(List<Class<? extends IElement>> metaclasses)

removeAllowedMetaclasses

public boolean removeAllowedMetaclasses(List<Class<? extends IElement>> metaclasses)

getAllowedMetaclasses

public List<Class<? extends IElement>> getAllowedMetaclasses()

findByName

public List<IElement> findByName(List<Class<? extends IElement>> metaclasses,
                        String nameValue,
                        IElementFilter filter)

Search model elements by their name.

Parameters:

metaclasses - metaclasses of the searched elements

nameValue - name of the searched elements

filter - a filter that allow to restrict the result scope. can be null.

Returns:

the found elements.

onKeyPressed

protected void onKeyPressed(org.eclipse.swt.events.KeyEvent e)

startPickingSession

protected void startPickingSession()

createContent

public void createContent(org.eclipse.swt.widgets.Composite parent)

acceptElement

public boolean acceptElement(IElement target)

Description copied from interface: IPickingClient

Returns whether the field accepts the element as a value.

Specified by:

acceptElement in interface IPickingClient

Parameters:

target - the new value candidate.

Returns:

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

setElement

public boolean setElement(IElement target)

Description copied from interface: IPickingClient

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

Specified by:

setElement in interface IPickingClient

Parameters:

target - The new represented element in the field

Returns:

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

acceptDroppedElements

public boolean acceptDroppedElements(IElement[] target)

Description copied from interface: IEditorDropClient

Returns whether the field accepts the element as a value.

Specified by:

acceptDroppedElements in interface IEditorDropClient

Parameters:

target - the new value candidate.

Returns:

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

setDroppedElements

public void setDroppedElements(IElement[] dropedElement)

Description copied from interface: IEditorDropClient

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

Specified by:

setDroppedElements in interface IEditorDropClient

Parameters:

dropedElement - The new represented elements in the field

pickingAborted

public void pickingAborted()

Description copied from interface: IPickingClient

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

Specified by:

pickingAborted in interface IPickingClient

setElementFilter

public void setElementFilter(IElementFilter elementFilter)

Parameters:

elementFilter -

addListener

public void addListener(IElementChangeListener listener)

removeListener

public void removeListener(IElementChangeListener listener)

getTextField

public org.eclipse.swt.widgets.Text getTextField()

endPickingSession

protected void endPickingSession()