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

Class BaseWindowRenderer<N>

java.lang.Object

org.eclipse.fx.ui.workbench.renderers.base.BaseRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

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

Type Parameters:

N - the native widget type

All Implemented Interfaces:

ElementRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

Direct Known Subclasses:

DefWindowRenderer

public abstract class BaseWindowRenderer<N>
extends BaseRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

Base renderer for MWindow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_FULL_SCREEN persisted map key to put window to full screen
static java.lang.String	TAG_SHELLMAXIMIZED Maximize the shell - provided for SWT-Compat

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
BaseWindowRenderer()

Method Summary

Modifier and Type	Method and Description
void	childRendered(org.eclipse.e4.ui.model.application.ui.basic.MWindow parentElement, org.eclipse.e4.ui.model.application.ui.MUIElement element) Inform the that a direct child of the parentElement has been rendered
void	destroyWidget(org.eclipse.e4.ui.model.application.ui.basic.MWindow element) Destroy the widget associated with the element
void	doProcessContent(org.eclipse.e4.ui.model.application.ui.basic.MWindow element) Process the content of an element
void	hideChild(org.eclipse.e4.ui.model.application.ui.basic.MWindow container, org.eclipse.e4.ui.model.application.ui.MUIElement changedObj) Hide the child of the element
protected void	initWidget(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MWindow element, @NonNull WWindow<N> widget) Initialize the widget
void	postProcess(org.eclipse.e4.ui.model.application.ui.basic.MWindow element) Post process the element
protected abstract @NonNull java.util.List<org.eclipse.e4.ui.workbench.modeling.ISaveHandler.Save>	promptToSave(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MWindow element, @NonNull java.util.Collection<org.eclipse.e4.ui.model.application.ui.basic.MPart> dirtyParts, @NonNull WWindow<N> widget) Show a prompt to inform the user about dirty parts
protected abstract org.eclipse.e4.ui.workbench.modeling.ISaveHandler.Save	promptToSave(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MWindow element, @NonNull org.eclipse.e4.ui.model.application.ui.basic.MPart dirtyPart, @NonNull WWindow<N> widget) Show a prompt to inform the user that one part is dirty

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

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

Methods inherited from class java.lang.Object

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

Field Detail

KEY_FULL_SCREEN

public static final java.lang.String KEY_FULL_SCREEN

persisted map key to put window to full screen

See Also:

Constant Field Values

TAG_SHELLMAXIMIZED

public static final java.lang.String TAG_SHELLMAXIMIZED

Maximize the shell - provided for SWT-Compat

See Also:

Constant Field Values

Constructor Detail

BaseWindowRenderer

public BaseWindowRenderer()

Method Detail

initWidget

protected void initWidget(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MWindow element,
                          @NonNull WWindow<N> widget)

Description copied from class: BaseRenderer

Initialize the widget

Overrides:

initWidget in class BaseRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

Parameters:

element - the model element

widget - the widget

promptToSave

protected abstract @NonNull java.util.List<org.eclipse.e4.ui.workbench.modeling.ISaveHandler.Save> promptToSave(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MWindow element,
                                                                                                                @NonNull java.util.Collection<org.eclipse.e4.ui.model.application.ui.basic.MPart> dirtyParts,
                                                                                                                @NonNull WWindow<N> widget)

Show a prompt to inform the user about dirty parts

Parameters:

element - the parent

dirtyParts - the dirty parts

widget - the window widget to use for parenting

Returns:

the result

promptToSave

protected abstract org.eclipse.e4.ui.workbench.modeling.ISaveHandler.Save promptToSave(@NonNull org.eclipse.e4.ui.model.application.ui.basic.MWindow element,
                                                                                       @NonNull org.eclipse.e4.ui.model.application.ui.basic.MPart dirtyPart,
                                                                                       @NonNull WWindow<N> widget)

Show a prompt to inform the user that one part is dirty

Parameters:

element - the parent

dirtyPart - the dirty part

widget - the window widget to use for parenting

Returns:

the result

doProcessContent

public void doProcessContent(org.eclipse.e4.ui.model.application.ui.basic.MWindow 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.basic.MWindow,WWindow<N>>

Parameters:

element - the element

postProcess

public void postProcess(org.eclipse.e4.ui.model.application.ui.basic.MWindow element)

Description copied from interface: ElementRenderer

Post process the element

Specified by:

postProcess in interface ElementRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

Overrides:

postProcess in class BaseRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

Parameters:

element - the element

childRendered

public void childRendered(org.eclipse.e4.ui.model.application.ui.basic.MWindow parentElement,
                          org.eclipse.e4.ui.model.application.ui.MUIElement element)

Description copied from interface: ElementRenderer

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

Parameters:

parentElement - the parent

element - the child rendered

hideChild

public void hideChild(org.eclipse.e4.ui.model.application.ui.basic.MWindow container,
                      org.eclipse.e4.ui.model.application.ui.MUIElement changedObj)

Description copied from interface: ElementRenderer

Hide the child of the element

Parameters:

container - the element container

changedObj - the element to hide

destroyWidget

public void destroyWidget(org.eclipse.e4.ui.model.application.ui.basic.MWindow element)

Description copied from interface: ElementRenderer

Destroy the widget associated with the element

Specified by:

destroyWidget in interface ElementRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

Overrides:

destroyWidget in class BaseRenderer<org.eclipse.e4.ui.model.application.ui.basic.MWindow,WWindow<N>>

Parameters:

element - the element