TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.trace.ui.internal.launcher.application
Class FilterConfigurationPage

java.lang.Object
  extended by org.eclipse.tptp.trace.ui.internal.launcher.application.FilterConfigurationPage
All Implemented Interfaces:
AbstractConfiguration.IExtendedConfigurationPage, org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage
Direct Known Subclasses:
FilterExtendedConfigurationPage, TIConfiguration.TIFilterConfigurationPage

public class FilterConfigurationPage
extends java.lang.Object
implements AbstractConfiguration.IExtendedConfigurationPage

This is the filter configuration page that is commonly used by data collectors requiring a filtering mechanism.


Constructor Summary
FilterConfigurationPage()
          Default constructor - equivalent to FilterConfigurationPage(IProfileLaunchConfigurationConstants.
FilterConfigurationPage(java.lang.String attributeName)
          The constructor
 
Method Summary
 void addErrorListener(org.eclipse.tptp.trace.ui.provisional.launcher.IStatusListener statusListener)
           
 void createControl(org.eclipse.swt.widgets.Composite parent)
           
protected  TraceProfileFiltersUI createFilterUI()
           
protected  FilterSetElement findFilterSet(java.lang.String activeFilterSetId)
           
 java.util.Vector getAttributes()
          Invoked to retrieve the profiling attributes that corresponds to user's settings for this page.
protected  java.lang.String getDefautltFilterSet()
           
 java.lang.String getDescription()
           
 TraceProfileFiltersUI getFilterUI()
           
 org.eclipse.debug.core.ILaunchConfiguration getLaunchConfiguration()
           
 java.lang.String getPageName()
           
 java.lang.String getTitle()
           
 org.eclipse.jface.resource.ImageDescriptor getWizardBanner()
           
 void reset(org.eclipse.debug.core.ILaunchConfiguration launchConfiguration)
           
 boolean storeAttributes(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy workingCopy)
          Invoked when the wizard finishes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterConfigurationPage

public FilterConfigurationPage()
Default constructor - equivalent to FilterConfigurationPage(IProfileLaunchConfigurationConstants. ATTR_FILTER_SET)


FilterConfigurationPage

public FilterConfigurationPage(java.lang.String attributeName)
The constructor

Parameters:
attributeName - The attribute name that should be used to store the filter set selection.
Method Detail

reset

public void reset(org.eclipse.debug.core.ILaunchConfiguration launchConfiguration)
Specified by:
reset in interface org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage

getAttributes

public java.util.Vector getAttributes()
Description copied from interface: AbstractConfiguration.IExtendedConfigurationPage
Invoked to retrieve the profiling attributes that corresponds to user's settings for this page. Each entry must be of type ProfilingAttribute

Specified by:
getAttributes in interface AbstractConfiguration.IExtendedConfigurationPage
Returns:
The profiling attributes of this page.

getDefautltFilterSet

protected java.lang.String getDefautltFilterSet()

storeAttributes

public boolean storeAttributes(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy workingCopy)
Description copied from interface: AbstractConfiguration.IExtendedConfigurationPage
Invoked when the wizard finishes. This is the chance that the page has in storing the user's settings into the working copy of the configuration.

Specified by:
storeAttributes in interface AbstractConfiguration.IExtendedConfigurationPage
Parameters:
workingCopy - The working copy of the configuration
Returns:
true if successful; false otherwise.

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)
Specified by:
createControl in interface org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage

findFilterSet

protected FilterSetElement findFilterSet(java.lang.String activeFilterSetId)

getPageName

public java.lang.String getPageName()
Specified by:
getPageName in interface org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage

getTitle

public java.lang.String getTitle()
Specified by:
getTitle in interface org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage

getWizardBanner

public org.eclipse.jface.resource.ImageDescriptor getWizardBanner()
Specified by:
getWizardBanner in interface org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage

addErrorListener

public void addErrorListener(org.eclipse.tptp.trace.ui.provisional.launcher.IStatusListener statusListener)
Specified by:
addErrorListener in interface org.eclipse.tptp.trace.ui.provisional.launcher.IConfigurationPage

getFilterUI

public TraceProfileFiltersUI getFilterUI()
Returns:
the filterUI

getLaunchConfiguration

public org.eclipse.debug.core.ILaunchConfiguration getLaunchConfiguration()
Returns:
the launchConfiguration

createFilterUI

protected TraceProfileFiltersUI createFilterUI()

TPTP 4.5.0 Platform Project
Internal API Specification