org.eclipse.fx.ui.workbench.renderers.base

Class BaseRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

java.lang.Object

org.eclipse.fx.ui.workbench.renderers.base.BaseRenderer<M,W>

Type Parameters:

M - the model type

W - the abstracted widget type

All Implemented Interfaces:

ElementRenderer<M,W>

Direct Known Subclasses:

BaseAreaRenderer, BaseCompositePartRenderer, BaseItemContainerRenderer, BaseItemRenderer, BaseMenuBarRenderer, BaseMenuSeparatorRenderer, BasePartMenuRenderer, BasePartRenderer, BasePerspectiveRenderer, BasePerspectiveStackRenderer, BasePlaceholderRenderer, BaseSashRenderer, BaseStackRenderer, BaseToolBarSeparatorRenderer, BaseToolControlRenderer, BaseTrimBarRenderer, BaseWindowRenderer

public abstract class BaseRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>
extends java.lang.Object
implements ElementRenderer<M,W>

Base class foe all renderers

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_localizedLabel Key used to store the localized label in the context
static java.lang.String	ATTRIBUTE_localizedTooltip Key used to store the localized tooltip in the context
static java.lang.String	CALCULATED_VISIBILITY Transient data key used to remember the calculated visibility which is built from MUIElement.getVisibleWhen() MUIElement.isVisible()
static java.lang.String	CONTEXT_DOM_ELEMENT Key used to store the dom element in the context
static java.lang.String	CURRENT_VISIBLE_WHEN Constant used to remember the current state of the visible when expression

Constructor Summary

Constructors

Constructor and Description
BaseRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	activate(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MPart element, boolean requiresFocus) Activate the given part using EPartService.activate(MPart, boolean)
void	bindWidget(M me, W widget) Bind the widget and the element together
static boolean	checkVisibleWhen(org.eclipse.e4.ui.model.application.ui.MUIElement item, org.eclipse.e4.core.contexts.IEclipseContext context) Check the visible when expression
W	createWidget(M element) Create the widget for the given model element
void	destroyWidget(M element) Destroy the widget associated with the element
protected abstract void	doProcessContent(M element) Process the content of an element
protected <LW extends WWidget<PM>,PM extends org.eclipse.e4.ui.model.application.ui.MUIElement> LW	engineCreateWidget(PM pm) Create a widget for the model element through the IPresentationEngine.createGui(MUIElement)
protected <LW extends WWidget<PM>,PM extends org.eclipse.e4.ui.model.application.ui.MUIElement> LW	engineCreateWidget(PM pm, @NonNull org.eclipse.e4.core.contexts.IEclipseContext context) Create a widget for the model element through IPresentationEngine.createGui(MUIElement, Object, IEclipseContext)
void	focus(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Focus the given element
protected @Nullable org.eclipse.e4.core.contexts.IEclipseContext	getContextForParent(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Get the context for the parent using EModelService.getContainingContext(MUIElement)
protected Logger	getLogger()
@Nullable org.eclipse.e4.core.contexts.IEclipseContext	getModelContext(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Retrieve the model context for the given element
protected @NonNull org.eclipse.e4.ui.workbench.IPresentationEngine	getPresentationEngine()
protected int	getRenderedIndex(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement parent, @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Get the rendering index of the element
protected @Nullable org.eclipse.e4.core.contexts.IEclipseContext	getRenderingContext(M element) Get the rendering context of the element
static boolean	getVisibleWhen(org.eclipse.e4.ui.model.application.ui.MUIElement item, org.eclipse.e4.core.contexts.IEclipseContext context) Get the last calculated visible when state or calculates one
W	getWidget(M element) Get the widget for the given elemenet
protected abstract @NonNull java.lang.Class<? extends W>	getWidgetClass(M element) Get the widgets class
protected boolean	inContentProcessing(org.eclipse.e4.ui.model.application.ui.MUIElement element) Check if we are currently processing this element
protected boolean	inContextModification(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Check if we are currently modifying the context of this element
protected void	initContext(@NonNull org.eclipse.emf.ecore.EObject eo, @NonNull org.eclipse.e4.core.contexts.IEclipseContext context) Initialize the context
protected void	initRenderingContext(M element, @NonNull org.eclipse.e4.core.contexts.IEclipseContext context) Initialize the rendering context
protected void	initWidget(M element, W widget) Initialize the widget
protected boolean	inUIModification(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Check if we are currently modifying the UI of the given element
protected boolean	isChildAndRenderedVisible(org.eclipse.e4.ui.model.application.ui.MUIElement u) Check if the item is visible and to be rendered
void	postProcess(M element) Post process the element
void	preDestroy(M element) Inform about destruction of the element
void	processContent(M element) Process the elements content
protected void	registerEventListener(@NonNull org.eclipse.e4.core.services.events.IEventBroker broker, @NonNull java.lang.String topic) Register an event listener for the give topic and translate it into context informations
org.eclipse.e4.core.contexts.IEclipseContext	setupRenderingContext(M element) Setup the context for rendering the element
void	syncUIModifications(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element, @NonNull java.lang.Runnable codeBlock) Run code without informing the UI about updates

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.fx.ui.workbench.base.rendering.ElementRenderer

childRendered, hideChild

Field Detail

CONTEXT_DOM_ELEMENT

public static final java.lang.String CONTEXT_DOM_ELEMENT

Key used to store the dom element in the context

See Also:

Constant Field Values

ATTRIBUTE_localizedLabel

public static final java.lang.String ATTRIBUTE_localizedLabel

Key used to store the localized label in the context

See Also:

Constant Field Values

ATTRIBUTE_localizedTooltip

public static final java.lang.String ATTRIBUTE_localizedTooltip

Key used to store the localized tooltip in the context

See Also:

Constant Field Values

CALCULATED_VISIBILITY

public static final java.lang.String CALCULATED_VISIBILITY

Transient data key used to remember the calculated visibility which is built from

• MUIElement.getVisibleWhen()
• MUIElement.isVisible()

See Also:

Constant Field Values

CURRENT_VISIBLE_WHEN

public static final java.lang.String CURRENT_VISIBLE_WHEN

Constant used to remember the current state of the visible when expression

See Also:

Constant Field Values

Constructor Detail

BaseRenderer

public BaseRenderer()

Method Detail

getLogger

protected Logger getLogger()

Returns:

the logger

inContentProcessing

protected boolean inContentProcessing(org.eclipse.e4.ui.model.application.ui.MUIElement element)

Check if we are currently processing this element

Parameters:

element - the element to check

Returns:

true if element is currently processed

inContextModification

protected boolean inContextModification(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Check if we are currently modifying the context of this element

Parameters:

element - the element to check

Returns:

true if the elements context is currently modified

inUIModification

protected boolean inUIModification(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Check if we are currently modifying the UI of the given element

Parameters:

element - the element to check

Returns:

true if the elements ui is currently modified

createWidget

public final W createWidget(M element)

Description copied from interface: ElementRenderer

Create the widget for the given model element

Specified by:

createWidget in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the model element

Returns:

the widget created

syncUIModifications

public void syncUIModifications(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element,
                                @NonNull java.lang.Runnable codeBlock)

Run code without informing the UI about updates

Parameters:

element - the element the code is executed on

codeBlock - the code to run

setupRenderingContext

public final org.eclipse.e4.core.contexts.IEclipseContext setupRenderingContext(M element)

Description copied from interface: ElementRenderer

Setup the context for rendering the element

Specified by:

setupRenderingContext in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element

Returns:

the context

initContext

protected void initContext(@NonNull org.eclipse.emf.ecore.EObject eo,
                           @NonNull org.eclipse.e4.core.contexts.IEclipseContext context)

Initialize the context

Parameters:

eo - the object the context should be populated with

context - the context

registerEventListener

protected void registerEventListener(@NonNull org.eclipse.e4.core.services.events.IEventBroker broker,
                                     @NonNull java.lang.String topic)

Register an event listener for the give topic and translate it into context informations

Parameters:

broker - the event broker

topic - the topic

initRenderingContext

protected void initRenderingContext(M element,
                                    @NonNull org.eclipse.e4.core.contexts.IEclipseContext context)

Initialize the rendering context

Parameters:

element - the element

context - the context

initWidget

protected void initWidget(M element,
                          W widget)

Initialize the widget

Parameters:

element - the model element

widget - the widget

destroyWidget

public void destroyWidget(M element)

Description copied from interface: ElementRenderer

Destroy the widget associated with the element

Specified by:

destroyWidget in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element

bindWidget

public void bindWidget(M me,
                       W widget)

Description copied from interface: ElementRenderer

Bind the widget and the element together

Specified by:

bindWidget in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

me - the element

widget - the widget

postProcess

public void postProcess(M element)

Description copied from interface: ElementRenderer

Post process the element

Specified by:

postProcess in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element

preDestroy

public void preDestroy(M element)

Description copied from interface: ElementRenderer

Inform about destruction of the element

Specified by:

preDestroy in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element

getPresentationEngine

protected @NonNull org.eclipse.e4.ui.workbench.IPresentationEngine getPresentationEngine()

Returns:

get the presentation engine

getWidgetClass

protected abstract @NonNull java.lang.Class<? extends W> getWidgetClass(M element)

Get the widgets class

Parameters:

element - the widget class

Returns:

the widget class

engineCreateWidget

protected <LW extends WWidget<PM>,PM extends org.eclipse.e4.ui.model.application.ui.MUIElement> LW engineCreateWidget(PM pm)

Create a widget for the model element through the IPresentationEngine.createGui(MUIElement)

Parameters:

pm - the model element

Returns:

the widget

engineCreateWidget

protected <LW extends WWidget<PM>,PM extends org.eclipse.e4.ui.model.application.ui.MUIElement> LW engineCreateWidget(PM pm,
                                                                                                                      @NonNull org.eclipse.e4.core.contexts.IEclipseContext context)

Create a widget for the model element through IPresentationEngine.createGui(MUIElement, Object, IEclipseContext)

Parameters:

pm - the model element

context - the context

Returns:

the widget

getRenderingContext

protected @Nullable org.eclipse.e4.core.contexts.IEclipseContext getRenderingContext(M element)

Get the rendering context of the element

Parameters:

element - the element

Returns:

the context

getContextForParent

protected @Nullable org.eclipse.e4.core.contexts.IEclipseContext getContextForParent(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Get the context for the parent using EModelService.getContainingContext(MUIElement)

Parameters:

element - the element

Returns:

the context

getModelContext

public @Nullable org.eclipse.e4.core.contexts.IEclipseContext getModelContext(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Description copied from interface: ElementRenderer

Retrieve the model context for the given element

Specified by:

getModelContext in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element

Returns:

the context

activate

protected void activate(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MPart element,
                        boolean requiresFocus)

Activate the given part using EPartService.activate(MPart, boolean)

Parameters:

element - the element

requiresFocus - true of focus is required

processContent

public final void processContent(M element)

Description copied from interface: ElementRenderer

Process the elements content

Specified by:

processContent in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element

checkVisibleWhen

public static boolean checkVisibleWhen(org.eclipse.e4.ui.model.application.ui.MUIElement item,
                                       org.eclipse.e4.core.contexts.IEclipseContext context)

Check the visible when expression

Parameters:

item - the item

context - the context

Returns:

true if visible

getVisibleWhen

public static boolean getVisibleWhen(org.eclipse.e4.ui.model.application.ui.MUIElement item,
                                     org.eclipse.e4.core.contexts.IEclipseContext context)

Get the last calculated visible when state or calculates one

Parameters:

item - the item

context - the context

Returns:

the current visible when status

getRenderedIndex

protected final int getRenderedIndex(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement parent,
                                     @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Get the rendering index of the element

Parameters:

parent - the parent

element - the element

Returns:

the index or -1

isChildAndRenderedVisible

protected boolean isChildAndRenderedVisible(org.eclipse.e4.ui.model.application.ui.MUIElement u)

Check if the item is visible and to be rendered

Parameters:

u - the element

Returns:

true if item is to be shown

doProcessContent

protected abstract void doProcessContent(M element)

Process the content of an element

Parameters:

element - the element

focus

public void focus(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Description copied from interface: ElementRenderer

Focus the given element

Specified by:

focus in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element to focus

getWidget

public W getWidget(M element)

Description copied from interface: ElementRenderer

Get the widget for the given elemenet

Specified by:

getWidget in interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,W extends WWidget<M>>

Parameters:

element - the element

Returns:

the widget