TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.hyades.trace.ui
Class FilterTraceViewer

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.ui.part.WorkbenchPart
          extended by org.eclipse.ui.part.ViewPart
              extended by org.eclipse.hyades.trace.ui.TraceViewer
                  extended by org.eclipse.hyades.trace.ui.FilterTraceViewer
All Implemented Interfaces:
java.util.EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, IDeleteListener, IProfileEventListener, IExportViewer, IFilterViewer, org.eclipse.jface.action.IMenuListener, org.eclipse.ui.IPersistable, org.eclipse.ui.ISelectionListener, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public abstract class FilterTraceViewer
extends TraceViewer
implements IFilterViewer

This class defines an abstract base class for viewers shown in the trace model that have some filter type(s) associated with them. This is for the profile monitor navigator, log view naviator. This class extends TraceViewer inheriting its properties, and creates the filter menu actions for the implementors filter scope definition.


Field Summary
 
Fields inherited from class org.eclipse.hyades.trace.ui.TraceViewer
GROUP_ADD_VIEWS, GROUP_ADDITIONS, GROUP_GENERIC, VIEW_ID
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
FilterTraceViewer()
           
 
Method Summary
 SimpleSearchQuery advancedQuery()
           
 void createFiltersAction()
           
 void dispose()
           
 SimpleSearchQuery getCurrentFilter()
           
 java.lang.String getCurrentFilterName()
           
 org.eclipse.hyades.ui.filters.internal.util.FilterInformationManager getFilterInformationManager()
           
 org.eclipse.jface.action.Action getFiltersAction()
           
 boolean isFilterActionEnabled()
           
 void makeActions()
          This method is called to create the actions for the viewer
 void setDefaultFilterName(java.lang.String name)
           
 void setFilterActionEnabled(boolean enabled)
           
 void setFilterQueryProvider(IFilterQueryProvider filterQueryProvider)
          When the action is created, this method is called providing the IFilterQueryProvider to the viewer.
 SimpleSearchQuery standardQuery()
           
 void updateAdvancedQuery(SimpleSearchQuery query, int advancedTabSelectionIndex)
           
 void updateFilterAppliedDescription()
          Updates the description for this view for the filter applied to this view
 
Methods inherited from class org.eclipse.hyades.trace.ui.TraceViewer
addViewPage, addViewPage, contextHandlerSelectionChanged, createPage, createPartControl, createReportAction, deregister, getCurrentPage, getDefaultPage, getDefaultPageMessage, getExportViewer, getModelObject, getObjectToView_, getObjectToView, getPage, getViewerControls, getViewerTitle, getViewID, getViewTitle, handleProfileEvent, initializeActionBar, initializedMenu, isFPartVisible, isFRefreshView, isInitializedMenu, isProcessRefreshEvents, isSaveNeeded, loadingTrace, loadingTraceDone, menuAboutToShow, removePage, selectionChanged, setFocus, setFPartVisible, setFRefreshView, setRecordSelection, showPage
 
Methods inherited from class org.eclipse.ui.part.ViewPart
getViewSite, init, init, saveState, setInitializationData
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, getAdapter, getContentDescription, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, showBusy
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.hyades.ui.filters.IFilterViewer
filterUpdated, getFilterScope
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

FilterTraceViewer

public FilterTraceViewer()
Method Detail

makeActions

public void makeActions()
Description copied from class: TraceViewer
This method is called to create the actions for the viewer

Overrides:
makeActions in class TraceViewer
See Also:
TraceViewer.makeActions()

createFiltersAction

public void createFiltersAction()

dispose

public void dispose()
Specified by:
dispose in interface org.eclipse.ui.IWorkbenchPart
Overrides:
dispose in class TraceViewer
See Also:
TraceViewer.dispose()

setFilterQueryProvider

public void setFilterQueryProvider(IFilterQueryProvider filterQueryProvider)
Description copied from interface: IFilterViewer
When the action is created, this method is called providing the IFilterQueryProvider to the viewer. The viewer could then use this method to get the filter, or update filter queries in some programmatic way. The IFilterQueryProvider must also be used to call #IFilterQueryProvider.viewerDisposed() when this viewer is disposed.

Specified by:
setFilterQueryProvider in interface IFilterViewer
See Also:
IFilterViewer.setFilterQueryProvider(IFilterQueryProvider)

getCurrentFilter

public SimpleSearchQuery getCurrentFilter()
See Also:
IFilterQueryProvider.getCurrentFilter()

standardQuery

public SimpleSearchQuery standardQuery()
See Also:
IFilterQueryProvider.standardQuery()

advancedQuery

public SimpleSearchQuery advancedQuery()
See Also:
IFilterQueryProvider.advancedQuery()

updateAdvancedQuery

public void updateAdvancedQuery(SimpleSearchQuery query,
                                int advancedTabSelectionIndex)
See Also:
IFilterQueryProvider.updateAdvancedQuery(SimpleSearchQuery, int)

updateFilterAppliedDescription

public void updateFilterAppliedDescription()
Updates the description for this view for the filter applied to this view


getFilterInformationManager

public org.eclipse.hyades.ui.filters.internal.util.FilterInformationManager getFilterInformationManager()

setFilterActionEnabled

public void setFilterActionEnabled(boolean enabled)

isFilterActionEnabled

public boolean isFilterActionEnabled()

setDefaultFilterName

public void setDefaultFilterName(java.lang.String name)

getFiltersAction

public org.eclipse.jface.action.Action getFiltersAction()

getCurrentFilterName

public java.lang.String getCurrentFilterName()

TPTP 4.5.0 Platform Project
Public API Specification