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

Class BaseMenuRenderer<N>

java.lang.Object

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

org.eclipse.fx.ui.workbench.renderers.base.BaseItemContainerRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement,WMenu<N>>

org.eclipse.fx.ui.workbench.renderers.base.BaseMenuRenderer<N>

Type Parameters:

N - the native widget type

All Implemented Interfaces:

ElementRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,WMenu<N>>, EventProcessor.ChildrenHandler<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement>

Direct Known Subclasses:

DefMenuRenderer, DefToolItemMenuRenderer

public abstract class BaseMenuRenderer<N>
extends BaseItemContainerRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement,WMenu<N>>

Base renderer for MMenu representing a menu

Field Summary

Fields inherited from class org.eclipse.fx.ui.workbench.renderers.base.BaseRenderer

ATTRIBUTE_localizedLabel, ATTRIBUTE_localizedTooltip, CALCULATED_VISIBILITY, CONTEXT_DOM_ELEMENT, CURRENT_VISIBLE_WHEN

Constructor Summary

Constructors

Constructor and Description
BaseMenuRenderer()

Method Summary

Modifier and Type	Method and Description
void	do_childRendered(@NonNull org.eclipse.e4.ui.model.application.ui.menu.MMenu parentElement, @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element) Called to render the child
void	do_hideChild(org.eclipse.e4.ui.model.application.ui.menu.MMenu container, org.eclipse.e4.ui.model.application.ui.MUIElement changedObj) Called to hide a child
protected void	do_init(@NonNull org.eclipse.e4.core.services.events.IEventBroker broker) Called to init
void	doProcessContent(org.eclipse.e4.ui.model.application.ui.menu.MMenu element) Process the content of an element
void	handleChildrenAddition(org.eclipse.e4.ui.model.application.ui.menu.MMenu parent, java.util.Collection<org.eclipse.e4.ui.model.application.ui.menu.MMenuElement> elements) Called when children are added
void	handleChildrenRemove(@NonNull org.eclipse.e4.ui.model.application.ui.menu.MMenu parent, @NonNull java.util.Collection<org.eclipse.e4.ui.model.application.ui.menu.MMenuElement> elements) Called when children are removed
protected void	initWidget(org.eclipse.e4.ui.model.application.ui.menu.MMenu element, WMenu<N> widget) Initialize the widget
protected boolean	isChildAndRenderedVisible(org.eclipse.e4.ui.model.application.ui.MUIElement u) Check if the item is visible and to be rendered
protected boolean	isShowing(org.eclipse.e4.ui.model.application.ui.menu.MMenuElement item) Check if the given item is currently show
protected boolean	skipEnablementCheck()

Methods inherited from class org.eclipse.fx.ui.workbench.renderers.base.BaseItemContainerRenderer

childRendered, hideChild

Methods inherited from class org.eclipse.fx.ui.workbench.renderers.base.BaseRenderer

activate, bindWidget, checkVisibleWhen, createWidget, destroyWidget, engineCreateWidget, engineCreateWidget, focus, getContextForParent, getLogger, getModelContext, getPresentationEngine, getRenderedIndex, getRenderingContext, getVisibleWhen, getWidget, getWidgetClass, inContentProcessing, inContextModification, initContext, initRenderingContext, inUIModification, postProcess, preDestroy, processContent, registerEventListener, setupRenderingContext, syncUIModifications

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseMenuRenderer

public BaseMenuRenderer()

Method Detail

do_init

protected void do_init(@NonNull org.eclipse.e4.core.services.events.IEventBroker broker)

Description copied from class: BaseItemContainerRenderer

Called to init

Specified by:

do_init in class BaseItemContainerRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement,WMenu<N>>

Parameters:

broker - the event broker

initWidget

protected void initWidget(org.eclipse.e4.ui.model.application.ui.menu.MMenu element,
                          WMenu<N> widget)

Description copied from class: BaseRenderer

Initialize the widget

Overrides:

initWidget in class BaseRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,WMenu<N>>

Parameters:

element - the model element

widget - the widget

skipEnablementCheck

protected boolean skipEnablementCheck()

Overrides:

skipEnablementCheck in class BaseItemContainerRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement,WMenu<N>>

Returns:

true if the enablement check is disabled currently

isShowing

protected boolean isShowing(org.eclipse.e4.ui.model.application.ui.menu.MMenuElement item)

Description copied from class: BaseItemContainerRenderer

Check if the given item is currently show

Overrides:

isShowing in class BaseItemContainerRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement,WMenu<N>>

Parameters:

item - the item

Returns:

true if the item is currently visible on screen

doProcessContent

public void doProcessContent(org.eclipse.e4.ui.model.application.ui.menu.MMenu element)

Description copied from class: BaseRenderer

Process the content of an element

Specified by:

doProcessContent in class BaseRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,WMenu<N>>

Parameters:

element - the element

handleChildrenRemove

public void handleChildrenRemove(@NonNull org.eclipse.e4.ui.model.application.ui.menu.MMenu parent,
                                 @NonNull java.util.Collection<org.eclipse.e4.ui.model.application.ui.menu.MMenuElement> elements)

Description copied from interface: EventProcessor.ChildrenHandler

Called when children are removed

Parameters:

parent - the parent

elements - the child elements

handleChildrenAddition

public void handleChildrenAddition(org.eclipse.e4.ui.model.application.ui.menu.MMenu parent,
                                   java.util.Collection<org.eclipse.e4.ui.model.application.ui.menu.MMenuElement> elements)

Description copied from interface: EventProcessor.ChildrenHandler

Called when children are added

Parameters:

parent - the parent

elements - the child elements

do_childRendered

public void do_childRendered(@NonNull org.eclipse.e4.ui.model.application.ui.menu.MMenu parentElement,
                             @NonNull org.eclipse.e4.ui.model.application.ui.MUIElement element)

Description copied from class: BaseItemContainerRenderer

Called to render the child

Specified by:

do_childRendered in class BaseItemContainerRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement,WMenu<N>>

Parameters:

parentElement - the parent

element - the element

isChildAndRenderedVisible

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

Description copied from class: BaseRenderer

Check if the item is visible and to be rendered

Overrides:

isChildAndRenderedVisible in class BaseRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,WMenu<N>>

Parameters:

u - the element

Returns:

true if item is to be shown

do_hideChild

public void do_hideChild(org.eclipse.e4.ui.model.application.ui.menu.MMenu container,
                         org.eclipse.e4.ui.model.application.ui.MUIElement changedObj)

Description copied from class: BaseItemContainerRenderer

Called to hide a child

Specified by:

do_hideChild in class BaseItemContainerRenderer<org.eclipse.e4.ui.model.application.ui.menu.MMenu,org.eclipse.e4.ui.model.application.ui.menu.MMenuElement,WMenu<N>>

Parameters:

container - the container

changedObj - the child hidden