Package org.eclipse.tracecompass.tmf.ui.views

Class TmfViewFactory

java.lang.Object

org.eclipse.tracecompass.tmf.ui.views.TmfViewFactory

public final class TmfViewFactory
extends Object

Factory for TmfView.

Since:

3.2

Author:

Jonathan Rajotte Julien

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERNAL_SECONDARY_ID_SEPARATOR	The separator used for secondary id internal use.

Method Summary

Modifier and Type	Method	Description
static @Nullable String	getBaseSecId(String secId)	Parse a secondary id and return the base secondary id minus any generated suffix (UUID).
static @Nullable org.eclipse.ui.IViewPart	newView(String viewId, boolean generateSuffix)	Create a new view.

Methods inherited from class java.lang.Object

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

Field Details

INTERNAL_SECONDARY_ID_SEPARATOR

public static final String INTERNAL_SECONDARY_ID_SEPARATOR

The separator used for secondary id internal use. This allows to have multiple level of information inside the secondary id.

See Also:

• Constant Field Values

Method Details

newView

@NonNullByDefault
public static @Nullable org.eclipse.ui.IViewPart newView(String viewId,
 boolean generateSuffix)

Create a new view.
If a view with the corresponding id already exists and no suffix were added the existing view will be given focus.

Parameters:

viewId - The id of the view to be created.
Format: primary_id[:secondary_id[invalid input: '&uuid']|:uuid]

generateSuffix - Add or replace a generated suffix id (UUID). This allows multiple views with the same id to be displayed.

Returns:

The view instance, or null if an error occurred.

getBaseSecId

public static @Nullable String getBaseSecId(String secId)

Parse a secondary id and return the base secondary id minus any generated suffix (UUID).

Parameters:

secId - A view secondary id

Returns:

The base secondary id excluding the UUID, or null when the passed string is a UUID.