org.eclipse.eef.core.internal.controllers

Class EEFHyperlinkController

java.lang.Object

org.eclipse.eef.core.api.controllers.AbstractEEFController

org.eclipse.eef.core.api.controllers.AbstractEEFWidgetController

org.eclipse.eef.core.internal.controllers.EEFHyperlinkController

All Implemented Interfaces:

IEEFController, IEEFHyperlinkController, IEEFWidgetController

public class EEFHyperlinkController
extends AbstractEEFWidgetController
implements IEEFHyperlinkController

This class will be used in order to manage the behavior of the hyperlink.

Field Summary

Fields inherited from class org.eclipse.eef.core.api.controllers.AbstractEEFWidgetController

newHelpConsumer, newLabelConsumer

Fields inherited from class org.eclipse.eef.core.api.controllers.AbstractEEFController

interpreter, variableManager

Constructor Summary

Constructors

Constructor and Description
EEFHyperlinkController(EEFHyperlinkDescription description, org.eclipse.sirius.common.interpreter.api.IVariableManager variableManager, org.eclipse.sirius.common.interpreter.api.IInterpreter interpreter, EditingContextAdapter contextAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
org.eclipse.core.runtime.IStatus	action(EEFWidgetAction action) Invoked when the user clicks on an action button.
java.lang.String	computeDisplayValue(java.lang.Object value) Compute the display value.
protected EEFWidgetDescription	getDescription() Returns the widget description.
org.eclipse.core.runtime.IStatus	onClick(java.lang.Object element) Invoked when the user clicks on an hyperlink.
void	onNewValue(IConsumer<java.lang.Object> consumer) Register a consumer which will be called with the new value of the hyperlink when it will change.
void	refresh() Refresh the controller.
void	removeNewValueConsumer() Remove the consumer of the new value of the hyperlink.

Methods inherited from class org.eclipse.eef.core.api.controllers.AbstractEEFWidgetController

computeHelp, getValidationRulesContainer, getValidationRulesReference, onNewHelp, onNewLabel, removeNewHelpConsumer, removeNewLabelConsumer

Methods inherited from class org.eclipse.eef.core.api.controllers.AbstractEEFController

newEval, onValidation, removeValidationConsumer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.eef.core.api.controllers.IEEFWidgetController

computeHelp, onNewHelp, onNewLabel, removeNewHelpConsumer, removeNewLabelConsumer

Methods inherited from interface org.eclipse.eef.core.api.controllers.IEEFController

onValidation, removeValidationConsumer

Constructor Detail

EEFHyperlinkController

public EEFHyperlinkController(EEFHyperlinkDescription description,
                              org.eclipse.sirius.common.interpreter.api.IVariableManager variableManager,
                              org.eclipse.sirius.common.interpreter.api.IInterpreter interpreter,
                              EditingContextAdapter contextAdapter)

The constructor.

Parameters:

description - The description

variableManager - The variable manager

interpreter - The interpreter

contextAdapter - The editing context adapter

Method Detail

refresh

public void refresh()

Refresh the controller.

Specified by:

refresh in interface IEEFController

Overrides:

refresh in class AbstractEEFWidgetController

See Also:

AbstractEEFWidgetController.refresh()

computeDisplayValue

public java.lang.String computeDisplayValue(java.lang.Object value)

Compute the display value.

Specified by:

computeDisplayValue in interface IEEFHyperlinkController

Parameters:

value - Element associated to the hyperlink

Returns:

The display value

See Also:

IEEFHyperlinkController.computeDisplayValue(java.lang.Object)

onClick

public org.eclipse.core.runtime.IStatus onClick(java.lang.Object element)

Invoked when the user clicks on an hyperlink.

Specified by:

onClick in interface IEEFHyperlinkController

Parameters:

element - Semantic element

Returns:

the status of the onclick execution.

See Also:

IEEFHyperlinkController.onClick(java.lang.Object)

onNewValue

public void onNewValue(IConsumer<java.lang.Object> consumer)

Register a consumer which will be called with the new value of the hyperlink when it will change.

Specified by:

onNewValue in interface IEEFHyperlinkController

Parameters:

consumer - The consumer of the new value of the hyperlink

See Also:

IEEFTextController.onNewValue(org.eclipse.eef.core.api.controllers.IConsumer)

removeNewValueConsumer

public void removeNewValueConsumer()

Remove the consumer of the new value of the hyperlink.

Specified by:

removeNewValueConsumer in interface IEEFHyperlinkController

See Also:

IEEFTextController.removeNewValueConsumer()

getDescription

protected EEFWidgetDescription getDescription()

Returns the widget description.

Specified by:

getDescription in class AbstractEEFWidgetController

Returns:

The widget description

See Also:

AbstractEEFWidgetController.getDescription()

action

public org.eclipse.core.runtime.IStatus action(EEFWidgetAction action)

Invoked when the user clicks on an action button.

Specified by:

action in interface IEEFHyperlinkController

Parameters:

action - Widget action

Returns:

the status of the action execution

See Also:

IEEFHyperlinkController.action(EEFWidgetAction)