Package org.eclipse.e4.ui.model.application.ui.advanced

Interface MPlaceholder

All Superinterfaces:

MApplicationElement, MLocalizable, MPartSashContainerElement, MStackElement, MUIElement

All Known Implementing Classes:

PlaceholderImpl

public interface MPlaceholder
extends MPartSashContainerElement, MStackElement

A representation of the model object 'Placeholder'.

A Placeholder is a concrete class used to share elements between perspectives. The elements referenced by a Placeholder generally exist in the Window's 'sharedElements' list. By convention a placeholder usually shares the same elementId as the element that it's referencing.

Since:

1.0

Restriction:

This interface is not intended to be implemented by clients.

The following features are supported:

• Ref
• Closeable

Method Summary

Modifier and Type	Method	Description
MUIElement	getRef()	Returns the value of the 'Ref' reference.
boolean	isCloseable()	Returns the value of the 'Closeable' attribute.
void	setCloseable(boolean value)	Sets the value of the 'Closeable' attribute.
void	setRef(MUIElement value)	Sets the value of the 'Ref' reference.

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

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

getAccessibilityPhrase, getContainerData, getCurSharedRef, getLocalizedAccessibilityPhrase, getParent, getRenderer, getVisibleWhen, getWidget, isOnTop, isToBeRendered, isVisible, setAccessibilityPhrase, setContainerData, setCurSharedRef, setOnTop, setParent, setRenderer, setToBeRendered, setVisible, setVisibleWhen, setWidget

Method Details

getRef

MUIElement getRef()

Returns the value of the 'Ref' reference.

The reference to the actual UI element that this Placeholder is acting as a proxy for.

Returns:

the value of the 'Ref' reference.

See Also:

• setRef(MUIElement)

setRef

void setRef(MUIElement value)

Sets the value of the 'Ref' reference.

Parameters:

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

See Also:

• getRef()

isCloseable

boolean isCloseable()

Returns the value of the 'Closeable' attribute. The default value is "false".

Determines whether the element (usually a Part) referenced by this Placeholder can be closed by the User. This allows a Part to be closeable in one perspective but not closeable in a different one.

Returns:

the value of the 'Closeable' attribute.

See Also:

• setCloseable(boolean)

setCloseable

void setCloseable(boolean value)

Sets the value of the 'Closeable' attribute.

Parameters:

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

See Also:

• isCloseable()