org.eclipse.fx.ui.workbench.base.rendering

Interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,C>

Type Parameters:

M - the model element type

C - the control/widget type

All Known Implementing Classes:

BaseAreaRenderer, BaseCompositePartRenderer, BaseItemContainerRenderer, BaseItemRenderer, BaseMenuBarRenderer, BaseMenuItemRenderer, BaseMenuRenderer, BaseMenuSeparatorRenderer, BasePartMenuRenderer, BasePartRenderer, BasePerspectiveRenderer, BasePerspectiveStackRenderer, BasePlaceholderRenderer, BasePopupMenuRenderer, BaseRenderer, BaseSashRenderer, BaseStackRenderer, BaseToolBarRenderer, BaseToolBarSeparatorRenderer, BaseToolControlRenderer, BaseToolItemRenderer, BaseTrimBarRenderer, BaseWindowRenderer, DefAreaRenderer, DefCompositePartRenderer, DefMenuBarRenderer, DefMenuItemRenderer, DefMenuRenderer, DefMenuSeparatorRenderer, DefPartMenuRenderer, DefPartRenderer, DefPerspectiveRenderer, DefPerspectiveStackRenderer, DefPlaceholderRenderer, DefPopupMenuRenderer, DefSashRenderer, DefStackRenderer, DefToolBarRenderer, DefToolBarSeparatorRenderer, DefToolControlRenderer, DefToolItemMenuRenderer, DefToolItemRenderer, DefTrimBarRenderer, DefWindowRenderer

public interface ElementRenderer<M extends org.eclipse.e4.ui.model.application.ui.MUIElement,C>

Base interface implemented by all renderers

Method Summary

Modifier and Type	Method and Description
void	bindWidget(M element, C widget) Bind the widget and the element together
void	childRendered(M parentElement, @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Inform the that a direct child of the parentElement has been rendered
C	createWidget(M element) Create the widget for the given model element
void	destroyWidget(M element) Destroy the widget associated with the element
void	focus(@NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Focus the given element
@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
C	getWidget(M element) Get the widget for the given elemenet
void	hideChild(M parent, @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Hide the child of the element
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
org.eclipse.e4.core.contexts.IEclipseContext	setupRenderingContext(M element) Setup the context for rendering the element

Method Detail

createWidget

C createWidget(M element)

Create the widget for the given model element

Parameters:

element - the model element

Returns:

the widget created

setupRenderingContext

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

Setup the context for rendering the element

Parameters:

element - the element

Returns:

the context

bindWidget

void bindWidget(M element,
                C widget)

Bind the widget and the element together

Parameters:

element - the element

widget - the widget

processContent

void processContent(M element)

Process the elements content

Parameters:

element - the element

postProcess

void postProcess(M element)

Post process the element

Parameters:

element - the element

childRendered

void childRendered(M parentElement,
                   @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Inform the that a direct child of the parentElement has been rendered

Parameters:

parentElement - the parent

element - the child rendered

preDestroy

void preDestroy(M element)

Inform about destruction of the element

Parameters:

element - the element

hideChild

void hideChild(M parent,
               @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Hide the child of the element

Parameters:

parent - the element container

element - the element to hide

destroyWidget

void destroyWidget(M element)

Destroy the widget associated with the element

Parameters:

element - the element

getModelContext

@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

Parameters:

element - the element

Returns:

the context

focus

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

Focus the given element

Parameters:

element - the element to focus

getWidget

C getWidget(M element)

Get the widget for the given elemenet

Parameters:

element - the element

Returns:

the widget