public interface MUIElement extends MApplicationElement, MLocalizable
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.
The following features are supported:
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 |
getContributorURI, getElementId, getPersistedState, getTags, getTransientData, setContributorURI, setElementId
updateLocalization
Object getWidget()
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.
setWidget(Object)
void setWidget(Object value)
Widget
' attribute.
value
- the new value of the 'Widget' attribute.getWidget()
Object getRenderer()
This field tracks the specific renderer used to create the 'widget'.
setRenderer(Object)
void setRenderer(Object value)
Renderer
' attribute.
value
- the new value of the 'Renderer' attribute.getRenderer()
boolean isToBeRendered()
"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.
setToBeRendered(boolean)
void setToBeRendered(boolean value)
To Be Rendered
' attribute.
value
- the new value of the 'To Be Rendered' attribute.isToBeRendered()
boolean isOnTop()
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.
setOnTop(boolean)
void setOnTop(boolean value)
On Top
' attribute.
value
- the new value of the 'On Top' attribute.isOnTop()
boolean isVisible()
"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.
setVisible(boolean)
void setVisible(boolean value)
Visible
' attribute.
value
- the new value of the 'Visible' attribute.isVisible()
MElementContainer<MUIElement> getParent()
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'
setParent(MElementContainer)
,
MElementContainer.getChildren()
void setParent(MElementContainer<MUIElement> value)
Parent
' container reference.
value
- the new value of the 'Parent' container reference.getParent()
String getContainerData()
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.
setContainerData(String)
void setContainerData(String value)
Container Data
' attribute.
value
- the new value of the 'Container Data' attribute.getContainerData()
MPlaceholder getCurSharedRef()
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.
setCurSharedRef(MPlaceholder)
void setCurSharedRef(MPlaceholder value)
Cur Shared Ref
' reference.
value
- the new value of the 'Cur Shared Ref' reference.getCurSharedRef()
MExpression getVisibleWhen()
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.
setVisibleWhen(MExpression)
void setVisibleWhen(MExpression value)
Visible When
' containment reference.
value
- the new value of the 'Visible When' containment reference.getVisibleWhen()
String getAccessibilityPhrase()
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.
setAccessibilityPhrase(String)
void setAccessibilityPhrase(String value)
Accessibility Phrase
' attribute.
value
- the new value of the 'Accessibility Phrase' attribute.getAccessibilityPhrase()
String getLocalizedAccessibilityPhrase()
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.