org.modelio.api.ui.text

Class TextWrapperForIElement

java.lang.Object

org.modelio.api.ui.text.TextWrapperForIElement

All Implemented Interfaces:

IPickingClient, IEditorDropClient

public class TextWrapperForIElement
extends java.lang.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.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.widgets.Text	textField

Constructor Summary

Constructors

Constructor and Description
TextWrapperForIElement(org.eclipse.swt.widgets.Composite parent, MObject initialElement, boolean acceptNullValue, java.util.Collection<java.lang.Class<? extends MObject>> allowedMetaclasses) C'tor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptDroppedElements(MObject[] target) Returns whether the field accepts the element as a value.
boolean	acceptElement(MObject target) Returns whether the field accepts the element as a value.
void	addAllowedMetaclass(java.lang.Class<? extends MObject> allowedMetaclass)
void	addAllowedMetaclasses(java.util.Collection<java.lang.Class<? extends MObject>> metaclasses)
void	addListener(IElementChangeListener listener)
protected void	createContent(org.eclipse.swt.widgets.Composite parent)
protected void	endPickingSession()
java.util.List<java.lang.Class<? extends MObject>>	getAllowedMetaclasses()
MObject	getSelectedElement()
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(java.lang.Class<? extends MObject> allowedMetaclass)
boolean	removeAllowedMetaclasses(java.util.Collection<java.lang.Class<? extends MObject>> metaclasses)
void	removeListener(IElementChangeListener listener)
void	setAcceptNullValue(boolean acceptNullValue)
void	setDroppedElements(MObject[] dropedElement) Set the field value to the given element and end the picking session if the given element is valid.
boolean	setElement(MObject target) Deprecated. Do not use this method to initialize the field value programmatically, it will fire the field listeners that may modify the underlying model. Use setSelectedElement(MObject) instead.
void	setElementFilter(IElementFilter elementFilter)
boolean	setSelectedElement(MObject target) Set the field value to the given element, if the given element is valid.
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

Constructor Detail

TextWrapperForIElement

public TextWrapperForIElement(org.eclipse.swt.widgets.Composite parent,
                              MObject initialElement,
                              boolean acceptNullValue,
                              java.util.Collection<java.lang.Class<? extends MObject>> allowedMetaclasses)

C'tor.

Parameters:

parent - parent control.

initialElement - initial value.

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

allowedMetaclasses - a collection of allowed metaclasses

Method Detail

acceptDroppedElements

public boolean acceptDroppedElements(MObject[] 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.

acceptElement

public boolean acceptElement(MObject 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.

addAllowedMetaclass

public void addAllowedMetaclass(java.lang.Class<? extends MObject> allowedMetaclass)

Parameters:

allowedMetaclass - a metaclass java class

addAllowedMetaclasses

public void addAllowedMetaclasses(java.util.Collection<java.lang.Class<? extends MObject>> metaclasses)

Parameters:

metaclasses - a collection of metaclasses to accept

addListener

public void addListener(IElementChangeListener listener)

Parameters:

listener - a field change listener

getAllowedMetaclasses

public java.util.List<java.lang.Class<? extends MObject>> getAllowedMetaclasses()

Returns:

the allowed metaclasses.

getSelectedElement

public MObject getSelectedElement()

Returns:

the selected element or null.

getTextField

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

Returns:

the underlying SWT Text.

isAcceptNullValue

public boolean isAcceptNullValue()

Returns:

whether null is accepted.

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

removeAllowedMetaclass

public boolean removeAllowedMetaclass(java.lang.Class<? extends MObject> allowedMetaclass)

Parameters:

allowedMetaclass - a metaclass java class

Returns:

true if the allowed metaclasses list changed

removeAllowedMetaclasses

public boolean removeAllowedMetaclasses(java.util.Collection<java.lang.Class<? extends MObject>> metaclasses)

Parameters:

metaclasses - a collection of metaclasses

Returns:

true if the allowed metaclasses list changed

removeListener

public void removeListener(IElementChangeListener listener)

Parameters:

listener - a field change listener

setAcceptNullValue

public void setAcceptNullValue(boolean acceptNullValue)

Parameters:

acceptNullValue - whether this field accepts null.

setDroppedElements

public void setDroppedElements(MObject[] 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

setElement

@Deprecated
public boolean setElement(MObject target)

Deprecated. Do not use this method to initialize the field value programmatically, it will fire the field listeners that may modify the underlying model. Use setSelectedElement(MObject) instead.

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

Warning

Do not use this method to initialize the field value programmatically, it will fire the field listeners that may modify the underlying model.

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.

See Also:

setSelectedElement(MObject)

setElementFilter

public void setElementFilter(IElementFilter elementFilter)

Parameters:

elementFilter - an element filter

setSelectedElement

public boolean setSelectedElement(MObject target)
                           throws java.lang.IllegalArgumentException

Set the field value to the given element, if the given element is valid.

Warning

Use this method to initialize the field value programmatically, it won't fire the field listeners.

Parameters:

target - The new represented element in the field

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the parameter value is not accepted by the field.

Since:

4.1

See Also:

setElement(MObject)

createContent

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

endPickingSession

protected void endPickingSession()

onKeyPressed

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

startPickingSession

protected void startPickingSession()