Package org.eclipse.tracecompass.tmf.ui.project.model

Class TmfOnDemandAnalysisElement

java.lang.Object

org.eclipse.tracecompass.tmf.ui.project.model.TmfProjectModelElement

org.eclipse.tracecompass.tmf.ui.project.model.TmfOnDemandAnalysisElement

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, ITmfProjectModelElement, ITmfStyledProjectModelElement

Direct Known Subclasses:

TmfBuiltInOnDemandAnalysisElement, TmfUserDefinedOnDemandAnalysisElement

@NonNullByDefault
public abstract class TmfOnDemandAnalysisElement
extends TmfProjectModelElement
implements ITmfStyledProjectModelElement

Project model element for individual on-demand analyses that apply to the related trace.

Since:

2.0

Author:

Alexandre Montplaisir

Method Summary

Modifier and Type	Method	Description
boolean	canRun()	Return if the analysis can be run or not.
IOnDemandAnalysis	getAnalysis()	Get the analysis represented by this model element
String	getHelpMessage()	Gets the help message for this analysis
abstract org.eclipse.swt.graphics.Image	getIcon()	Returns the icon of this element.
TmfOnDemandAnalysesElement	getParent()	Returns the parent of this model element.
@Nullable org.eclipse.jface.viewers.StyledString.Styler	getStyler()	Return the styler who will apply its style to the text string.

Methods inherited from class org.eclipse.tracecompass.tmf.ui.project.model.TmfProjectModelElement

equals, getAdapter, getChildren, getLocation, getName, getPath, getProject, getResource, getTraceSupplementaryFolder, hashCode, prepareTraceSupplementaryFolder, prepareTraceSupplementaryFolder, refresh, refreshViewer, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.tracecompass.tmf.ui.project.model.ITmfProjectModelElement

dispose, getChild, getLabelText, hasChildren

Method Details

getParent

public TmfOnDemandAnalysesElement getParent()

Description copied from interface: ITmfProjectModelElement

Returns the parent of this model element.

Specified by:

getParent in interface ITmfProjectModelElement

Overrides:

getParent in class TmfProjectModelElement

Returns:

the parent of this model element.

getIcon

public abstract org.eclipse.swt.graphics.Image getIcon()

Description copied from interface: ITmfProjectModelElement

Returns the icon of this element.

Specified by:

getIcon in interface ITmfProjectModelElement

Returns:

The icon

getStyler

public @Nullable org.eclipse.jface.viewers.StyledString.Styler getStyler()

Description copied from interface: ITmfStyledProjectModelElement

Return the styler who will apply its style to the text string.

Specified by:

getStyler in interface ITmfStyledProjectModelElement

Returns:

The style object, or 'null' for no special style

getAnalysis

public IOnDemandAnalysis getAnalysis()

Get the analysis represented by this model element

Returns:

The real analysis

canRun

public boolean canRun()

Return if the analysis can be run or not. Determines if we should enable the run actions.

Returns:

If this analysis can run

getHelpMessage

public String getHelpMessage()

Gets the help message for this analysis

Returns:

The help message

Since:

8.0