org.eclipse.e4.ui.internal.workbench

Class PartServiceImpl

java.lang.Object

org.eclipse.e4.ui.internal.workbench.PartServiceImpl

All Implemented Interfaces:

EPartService

public class PartServiceImpl
extends java.lang.Object
implements EPartService

A window-based EPartService.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.e4.ui.workbench.modeling.EPartService

EPartService.PartState

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PART_ACTIVATION_TIME The part activation time of a part is stored in it's transient data.

Fields inherited from interface org.eclipse.e4.ui.workbench.modeling.EPartService

ACTIVE_ON_CLOSE_TAG, REMOVE_ON_HIDE_TAG

Constructor Summary

Constructors

Constructor and Description
PartServiceImpl(MApplication application, MWindow window)

Method Summary

Modifier and Type	Method and Description
void	activate(MPart part) Activates the given part.
void	activate(MPart part, boolean requiresFocus) Activates the given part.
MPart	addPart(MPart part)
void	addPartListener(IPartListener listener) Adds the given listener for part lifecycle events.
void	bringToTop(MPart part) Brings this part to the top so that it will become visible to the end user.
MPart	createPart(java.lang.String id) Creates a new part of the given id.
MPlaceholder	createSharedPart(java.lang.String id) Creates a new placeholder for a part of the given id.
MPlaceholder	createSharedPart(java.lang.String id, boolean force) Creates a new placeholder for a part of the given id.
MPart	findPart(java.lang.String id) Finds and returns a part with the given id.
MPart	getActivePart() Returns the active part.
java.util.Collection<MPart>	getDirtyParts() Returns a collection of all the dirty parts that are being managed by this service.
java.util.Collection<MInputPart>	getInputParts(java.lang.String inputUri) Deprecated.
java.util.Collection<MPart>	getParts() Returns a collection of all the parts that are being managed by this part service.
void	hidePart(MPart part) Hides the given part.
void	hidePart(MPart part, boolean force) Hides the given part.
boolean	isPartOrPlaceholderInPerspective(java.lang.String elementId, MPerspective perspective) Indicates whether a part with a certain elementId is currently rendered in a certain perspective or not.
boolean	isPartVisible(MPart part) Returns whether the specified part is currently visible to the end user.
void	removePartListener(IPartListener listener) Removes the given listener so that it will no longer be notified of part lifecycle events.
void	requestActivation() Ask the service to assign activation to a valid part in the currently active presentation.
boolean	saveAll(boolean confirm) Saves the contents of all dirty parts and returns whether the operation completed.
boolean	savePart(MPart part, boolean confirm) Saves the contents of the part if it is dirty and returns whether the operation completed.
MPart	showPart(MPart part, EPartService.PartState partState) Shows a part with the identified by the given id.
MPart	showPart(java.lang.String id, EPartService.PartState partState) Shows a part with the identified by the given id.
void	switchPerspective(MPerspective perspective) Switch to the specified perspective.
java.util.Optional<MPerspective>	switchPerspective(java.lang.String perspectiveId) Switch to the specified perspective.

Methods inherited from class java.lang.Object

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

Field Detail

PART_ACTIVATION_TIME

public static final java.lang.String PART_ACTIVATION_TIME

The part activation time of a part is stored in it's transient data.

See Also:

Constant Field Values

Constructor Detail

PartServiceImpl

public PartServiceImpl(MApplication application,
                       MWindow window)

Method Detail

addPartListener

public void addPartListener(IPartListener listener)

Description copied from interface: EPartService

Adds the given listener for part lifecycle events. Has no effect if an identical listener has already been registered.

Note: Listeners should be removed when no longer necessary.

Specified by:

addPartListener in interface EPartService

Parameters:

listener - the listener to attach

removePartListener

public void removePartListener(IPartListener listener)

Description copied from interface: EPartService

Removes the given listener so that it will no longer be notified of part lifecycle events. Has no effect if an identical listener has not been registered.

Specified by:

removePartListener in interface EPartService

Parameters:

listener - the listener to remove

bringToTop

public void bringToTop(MPart part)

Description copied from interface: EPartService

Brings this part to the top so that it will become visible to the end user. This does not imply that the part will be granted focus.

Specified by:

bringToTop in interface EPartService

Parameters:

part - the part to bring to top

findPart

public MPart findPart(java.lang.String id)

Description copied from interface: EPartService

Finds and returns a part with the given id.

Specified by:

findPart in interface EPartService

Parameters:

id - the id of the part to search for, must not be null

Returns:

the part with the specified id, or null if no such part could be found

getParts

public java.util.Collection<MPart> getParts()

Description copied from interface: EPartService

Returns a collection of all the parts that are being managed by this part service.

Specified by:

getParts in interface EPartService

Returns:

a collection of parts that are being managed by this service, never null

isPartVisible

public boolean isPartVisible(MPart part)

Description copied from interface: EPartService

Returns whether the specified part is currently visible to the end user.

Specified by:

isPartVisible in interface EPartService

Parameters:

part - the part to check

Returns:

true if the part is currently visible, false otherwise

isPartOrPlaceholderInPerspective

public boolean isPartOrPlaceholderInPerspective(java.lang.String elementId,
                                                MPerspective perspective)

Description copied from interface: EPartService

Indicates whether a part with a certain elementId is currently rendered in a certain perspective or not.

Specified by:

isPartOrPlaceholderInPerspective in interface EPartService

Parameters:

elementId - the id of the part, which should be checked

perspective - the perspective, which may contain the part with the given elementId

Returns:

true if the part with the given elementId is rendered in the given perspective and false otherwise

switchPerspective

public void switchPerspective(MPerspective perspective)

Description copied from interface: EPartService

Switch to the specified perspective. It will be selected and brought to top (if necessary). It may not necessarily be granted focus if there is another active window present.

Specified by:

switchPerspective in interface EPartService

Parameters:

perspective - the perspective to switch to, must not be null and it must be a perspective that's being managed by this service

switchPerspective

public java.util.Optional<MPerspective> switchPerspective(java.lang.String perspectiveId)

Description copied from interface: EPartService

Switch to the specified perspective. It will be selected and brought to top (if necessary). It may not necessarily be granted focus if there is another active window present.

Specified by:

switchPerspective in interface EPartService

Parameters:

perspectiveId - the perspective to switch to, must not be null and it must be a perspective that's being managed by this service

activate

public void activate(MPart part)

Description copied from interface: EPartService

Activates the given part. The part will be brought to top (if necessary) and granted focus.

Specified by:

activate in interface EPartService

Parameters:

part - the part to activate, must not be null

activate

public void activate(MPart part,
                     boolean requiresFocus)

Description copied from interface: EPartService

Activates the given part. The part will be brought to top (if necessary) and, if requiresFocus is true, then granted focus.

Specified by:

activate in interface EPartService

Parameters:

part - the part to activate, must not be null

requiresFocus - if true, then also cause the part to acquire focus

getActivePart

public MPart getActivePart()

Description copied from interface: EPartService

Returns the active part.

Specified by:

getActivePart in interface EPartService

Returns:

an active part within the scope of this service, or null if no part is currently active

createPart

public MPart createPart(java.lang.String id)

Description copied from interface: EPartService

Creates a new part of the given id.

Specified by:

createPart in interface EPartService

Parameters:

id - the identifier of the part, must not be null

Returns:

a new part of the given id, or null if no part descriptors can be found that match the specified id

createSharedPart

public MPlaceholder createSharedPart(java.lang.String id)

Description copied from interface: EPartService

Creates a new placeholder for a part of the given id.

Specified by:

createSharedPart in interface EPartService

Parameters:

id - the identifier of the part, must not be null

Returns:

a new part of the given id, or null if no part descriptors can be found that match the specified id

createSharedPart

public MPlaceholder createSharedPart(java.lang.String id,
                                     boolean force)

Description copied from interface: EPartService

Creates a new placeholder for a part of the given id.

Specified by:

createSharedPart in interface EPartService

Parameters:

id - the identifier of the part, must not be null

force - true if a new part should be created, false if the window should be queried for a shared part first

Returns:

a new part of the given id, or null if no part descriptors can be found that match the specified id

addPart

public MPart addPart(MPart part)

showPart

public MPart showPart(java.lang.String id,
                      EPartService.PartState partState)

Description copied from interface: EPartService

Shows a part with the identified by the given id. In the event that there are multiple parts with the specified id, the client is recommended to use EPartService.getParts() and iterate over the collection to find the interested part and invoke EPartService.showPart(MPart, PartState) on it. The behavior of this method is dictated by the supplied state.

• If ACTIVATE is supplied, then the part is made visible and granted focus.
• If VISIBLE is supplied, then the part will be made visible and possibly be granted focus depending on where it is relative to the active part. If it is in the same stack as the currently active part, then it will be granted focus.
• If CREATE is supplied, then the part will be instantiated though its contents may not necessarily be visible to the end user. visible to the end user.

Specified by:

showPart in interface EPartService

Parameters:

id - the identifier of the part, must not be null

partState - the desired state of the shown part to be in

Returns:

the shown part, or null if no parts or part descriptors can be found that match the specified id

showPart

public MPart showPart(MPart part,
                      EPartService.PartState partState)

Description copied from interface: EPartService

Shows a part with the identified by the given id. In the event that there are multiple parts with the specified id, the client is recommended to use EPartService.getParts() and iterate over the collection to find the interested part and invoke EPartService.showPart(MPart, PartState) on it. The behavior of this method is dictated by the supplied state.

• If ACTIVATE is supplied, then the part is made visible and granted focus.
• If VISIBLE is supplied, then the part will be made visible and possibly be granted focus depending on where it is relative to the active part. If it is in the same stack as the currently active part, then it will be granted focus.
• If CREATE is supplied, then the part will be instantiated though its contents may not necessarily be visible to the end user. visible to the end user.

Specified by:

showPart in interface EPartService

Parameters:

part - the identifier of the part, must not be null

partState - the desired state of the shown part to be in

Returns:

the shown part, or null if no parts or part descriptors can be found that match the specified id

requestActivation

public void requestActivation()

Description copied from interface: EPartService

Ask the service to assign activation to a valid part in the currently active presentation.

Specified by:

requestActivation in interface EPartService

hidePart

public void hidePart(MPart part)

Description copied from interface: EPartService

Hides the given part. The part must be a part managed by this service.

If the part has been tagged with the EPartService.REMOVE_ON_HIDE_TAG tag, it will be removed from the model when the service hides it.

To save the part before hiding, use EPartService.savePart(MPart, boolean):

 if (partService.savePart(part, true)) {
        partService.hidePart(part);
 }
 

Specified by:

hidePart in interface EPartService

Parameters:

part - the part to hide

See Also:

EPartService.savePart(MPart, boolean)

hidePart

public void hidePart(MPart part,
                     boolean force)

Description copied from interface: EPartService

Hides the given part. The part must be a part managed by this service.

If force is true or the part has been tagged with the EPartService.REMOVE_ON_HIDE_TAG tag, it will be removed from the model when the service hides it.

To save the part before hiding, use EPartService.savePart(MPart, boolean):

 if (partService.savePart(part, true)) {
        partService.hidePart(part);
 }
 

Specified by:

hidePart in interface EPartService

Parameters:

part - the part to hide

force - if the part should be removed from the model regardless of its EPartService.REMOVE_ON_HIDE_TAG tag

See Also:

EPartService.savePart(MPart, boolean)

getDirtyParts

public java.util.Collection<MPart> getDirtyParts()

Description copied from interface: EPartService

Returns a collection of all the dirty parts that are being managed by this service.

Specified by:

getDirtyParts in interface EPartService

Returns:

a collection of dirty parts that are being managed by this service, never null

savePart

public boolean savePart(MPart part,
                        boolean confirm)

Description copied from interface: EPartService

Saves the contents of the part if it is dirty and returns whether the operation completed.

Specified by:

savePart in interface EPartService

Parameters:

part - the part to save

confirm - true if the user should be prompted prior to saving the changes, and false to save changes without asking

Returns:

true if the operation completed successfully, false if the user canceled the operation or if an error occurred while saving the changes

See Also:

EPartService.hidePart(MPart, boolean)

saveAll

public boolean saveAll(boolean confirm)

Description copied from interface: EPartService

Saves the contents of all dirty parts and returns whether the operation completed.

Specified by:

saveAll in interface EPartService

Parameters:

confirm - true if the user should be prompted prior to saving the changes, and false to save changes without asking

Returns:

true if the operation completed successfully, false if the user canceled the operation or if an error occurred while saving the changes

getInputParts

@Deprecated
public java.util.Collection<MInputPart> getInputParts(java.lang.String inputUri)

Deprecated.

Description copied from interface: EPartService

Returns a collection of all MInputPart with the inputURI-Attribute set to the given value

Specified by:

getInputParts in interface EPartService

Parameters:

inputUri - the input uri to search for, must not be null

Returns:

list of parts or an empty collection

See Also:

Bug 509868