org.eclipse.e4.ui.model.application.ui

Interface MUIElement

All Superinterfaces:

MApplicationElement, MLocalizable

All Known Subinterfaces:

MApplication, MArea, MCompositePart, MDialog, MDirectMenuItem, MDirectToolItem, MDynamicMenuContribution, MElementContainer<T>, MGenericStack<T>, MGenericTile<T>, MGenericTrimContainer<T>, MHandledItem, MHandledMenuItem, MHandledToolItem, MInputPart, MItem, MMenu, MMenuContribution, MMenuElement, MMenuItem, MMenuSeparator, MPart, MPartSashContainer, MPartSashContainerElement, MPartStack, MPerspective, MPerspectiveStack, MPlaceholder, MPopupMenu, MStackElement, MToolBar, MToolBarContribution, MToolBarElement, MToolBarSeparator, MToolControl, MToolItem, MTrimBar, MTrimContribution, MTrimElement, MTrimmedWindow, MWindow, MWindowElement, MWizardDialog

public interface MUIElement
extends MApplicationElement, MLocalizable

A representation of the model object 'UI Element'.

This is the base mix-in shared by all model elements that can be rendered into the UI presentation of the application. Its main job is to manage the bindings between the concrete element and the UI 'widget' representing it in the UI.

Since:

1.0

Restriction:

This interface is not intended to be implemented by clients.

The following features are supported:

• Widget
• Renderer
• To Be Rendered
• On Top
• Visible
• Parent
• Container Data
• Cur Shared Ref
• Visible When
• Accessibility Phrase
• Localized Accessibility Phrase

Method Summary

Modifier and Type	Method and Description
String	getAccessibilityPhrase() Returns the value of the 'Accessibility Phrase' attribute
String	getContainerData() Returns the value of the 'Container Data' attribute
MPlaceholder	getCurSharedRef() Returns the value of the 'Cur Shared Ref' reference
String	getLocalizedAccessibilityPhrase() Returns the value of the 'Localized Accessibility Phrase' attribute
MElementContainer<MUIElement>	getParent() Returns the value of the 'Parent' container reference.
Object	getRenderer() Returns the value of the 'Renderer' attribute
MExpression	getVisibleWhen() Returns the value of the 'Visible When' containment reference
Object	getWidget() Returns the value of the 'Widget' attribute
boolean	isOnTop() Returns the value of the 'On Top' attribute
boolean	isToBeRendered() Returns the value of the 'To Be Rendered' attribute.
boolean	isVisible() Returns the value of the 'Visible' attribute.
void	setAccessibilityPhrase(String value) Sets the value of the 'Accessibility Phrase' attribute
void	setContainerData(String value) Sets the value of the 'Container Data' attribute
void	setCurSharedRef(MPlaceholder value) Sets the value of the 'Cur Shared Ref' reference
void	setOnTop(boolean value) Sets the value of the 'On Top' attribute
void	setParent(MElementContainer<MUIElement> value) Sets the value of the 'Parent' container reference
void	setRenderer(Object value) Sets the value of the 'Renderer' attribute
void	setToBeRendered(boolean value) Sets the value of the 'To Be Rendered' attribute
void	setVisible(boolean value) Sets the value of the 'Visible' attribute
void	setVisibleWhen(MExpression value) Sets the value of the 'Visible When' containment reference
void	setWidget(Object value) Sets the value of the 'Widget' attribute

Methods inherited from interface org.eclipse.e4.ui.model.application.MApplicationElement

getContributorURI, getElementId, getPersistedState, getTags, getTransientData, setContributorURI, setElementId

Methods inherited from interface org.eclipse.e4.ui.model.application.ui.MLocalizable

updateLocalization

Method Detail

getWidget

Object getWidget()

Returns the value of the 'Widget' attribute.

This field represents the platform specific UI 'widget' that is representing this UIElement on the screen. It will only be non-null when the element has been rendered.

Returns:

the value of the 'Widget' attribute.

See Also:

setWidget(Object)

setWidget

void setWidget(Object value)

Sets the value of the 'Widget' attribute.

Parameters:

value - the new value of the 'Widget' attribute.

See Also:

getWidget()

getRenderer

Object getRenderer()

Returns the value of the 'Renderer' attribute.

This field tracks the specific renderer used to create the 'widget'.

Returns:

the value of the 'Renderer' attribute.

See Also:

setRenderer(Object)

setRenderer

void setRenderer(Object value)

Sets the value of the 'Renderer' attribute.

Parameters:

value - the new value of the 'Renderer' attribute.

See Also:

getRenderer()

isToBeRendered

boolean isToBeRendered()

Returns the value of the 'To Be Rendered' attribute. The default value is "true".

This field controls whether the given UIElement should be displayed within the application. Note that due to lazy loading it is possible to have this field set to true but to not have actually rendered the element itself (it does show up as a tab on the appropiate stack but will only be rendered when that tab is selected.

Returns:

the value of the 'To Be Rendered' attribute.

See Also:

setToBeRendered(boolean)

setToBeRendered

void setToBeRendered(boolean value)

Sets the value of the 'To Be Rendered' attribute.

Parameters:

value - the new value of the 'To Be Rendered' attribute.

See Also:

isToBeRendered()

isOnTop

boolean isOnTop()

Returns the value of the 'On Top' attribute.

Developers: Add more detailed documentation by editing this comment in org.eclipse.ui.model.workbench/model/UIElements.ecore. There is a GenModel/documentation node under each type and attribute.

Returns:

the value of the 'On Top' attribute.

See Also:

setOnTop(boolean)

setOnTop

void setOnTop(boolean value)

Sets the value of the 'On Top' attribute.

Parameters:

value - the new value of the 'On Top' attribute.

See Also:

isOnTop()

isVisible

boolean isVisible()

Returns the value of the 'Visible' attribute. The default value is "true".

This field determines whether or not the given UIElement appears in the presentation or whether it should be 'cached' for specialized use. Under normal circumstances this flag should always be 'true'.

The MinMaxAddon uses this flag for example when a stack becomes minimized. By setting the flag to false the stack's widget is cleanly removed from the UI but is still 'rendered'. Once the widget has been cached the minimized stack can then display the widget using its own technques.

Returns:

the value of the 'Visible' attribute.

See Also:

setVisible(boolean)

setVisible

void setVisible(boolean value)

Sets the value of the 'Visible' attribute.

Parameters:

value - the new value of the 'Visible' attribute.

See Also:

isVisible()

getParent

MElementContainer<MUIElement> getParent()

Returns the value of the 'Parent' container reference. It is bidirectional and its opposite is 'Children'.

This field is a reference to this element's container. Note that while this field is valid for most UIElements there are a few (such as TrimBars and the Windows associated with top level windows and perspectives) where this will return 'null'

Returns:

the value of the 'Parent' container reference.

See Also:

setParent(MElementContainer), MElementContainer.getChildren()

setParent

void setParent(MElementContainer<MUIElement> value)

Sets the value of the 'Parent' container reference.

Parameters:

value - the new value of the 'Parent' container reference.

See Also:

getParent()

getContainerData

String getContainerData()

Returns the value of the 'Container Data' attribute.

This is a persistend field that may be used by the parent element's renderer to maintain any data that it needs to control the container. For example this is where the SashRenderer stores the 'weight' of a particular element.

NOTE: This field is effectively deprecated in favor of the parent renderer simply adding a new keyed value to the UIElement's 'persistentData' map.

Returns:

the value of the 'Container Data' attribute.

See Also:

setContainerData(String)

setContainerData

void setContainerData(String value)

Sets the value of the 'Container Data' attribute.

Parameters:

value - the new value of the 'Container Data' attribute.

See Also:

getContainerData()

getCurSharedRef

MPlaceholder getCurSharedRef()

Returns the value of the 'Cur Shared Ref' reference.

This is a transient (i.e. non-persisted) field which is used in conjunction with MPlaceholders which are used to share elements actoss multiple perspectives. This field will point back to the MPlaceholder (if any) currently hosting this one.

Returns:

the value of the 'Cur Shared Ref' reference.

See Also:

setCurSharedRef(MPlaceholder)

setCurSharedRef

void setCurSharedRef(MPlaceholder value)

Sets the value of the 'Cur Shared Ref' reference.

Parameters:

value - the new value of the 'Cur Shared Ref' reference.

See Also:

getCurSharedRef()

getVisibleWhen

MExpression getVisibleWhen()

Returns the value of the 'Visible When' containment reference.

Developers: Add more detailed documentation by editing this comment in org.eclipse.ui.model.workbench/model/UIElements.ecore. There is a GenModel/documentation node under each type and attribute.

Returns:

the value of the 'Visible When' containment reference.

See Also:

setVisibleWhen(MExpression)

setVisibleWhen

void setVisibleWhen(MExpression value)

Sets the value of the 'Visible When' containment reference.

Parameters:

value - the new value of the 'Visible When' containment reference.

See Also:

getVisibleWhen()

getAccessibilityPhrase

String getAccessibilityPhrase()

Returns the value of the 'Accessibility Phrase' attribute.

This field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy.

Returns:

the value of the 'Accessibility Phrase' attribute.

See Also:

setAccessibilityPhrase(String)

setAccessibilityPhrase

void setAccessibilityPhrase(String value)

Sets the value of the 'Accessibility Phrase' attribute.

Parameters:

value - the new value of the 'Accessibility Phrase' attribute.

See Also:

getAccessibilityPhrase()

getLocalizedAccessibilityPhrase

String getLocalizedAccessibilityPhrase()

Returns the value of the 'Localized Accessibility Phrase' attribute.

Returns:

the value of the 'Localized Accessibility Phrase' attribute.