TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.instrumentation.ui.internal.configuration
Class AbstractCustomInstrumentFiltersUI

java.lang.Object
  extended by org.eclipse.tptp.platform.instrumentation.ui.internal.configuration.AbstractCustomInstrumentFiltersUI
All Implemented Interfaces:
java.util.EventListener, org.eclipse.swt.events.SelectionListener, org.eclipse.swt.internal.SWTEventListener

public abstract class AbstractCustomInstrumentFiltersUI
extends java.lang.Object
implements org.eclipse.swt.events.SelectionListener

Custom instrument filterSet that user choose to use analysis type filtersSet rather use default instrument collector filtersSet. This class is abstract class to provide the common function. Subclass must implments abstract method to provide customized information for specified analysis type(JMX/ARM/CBE/...)

See Also:
description of feature 146267(https://bugs.eclipse.org/bugs/show_bug.cgi?id=146267)

Constructor Summary
AbstractCustomInstrumentFiltersUI(org.eclipse.swt.widgets.Composite parent)
          Default constructor.
AbstractCustomInstrumentFiltersUI(org.eclipse.swt.widgets.Composite parent, boolean alwaysEnableFilters)
          the constructor of custom instrument filters set for analysis type.
 
Method Summary
protected abstract  java.lang.String getActiveFilterKey()
          return active filter key represents selected filter choosed by user. subclass must implment this method to provide special information
 java.lang.String getActiveFilterSet()
          Returns the active filter set id.
protected  java.util.ArrayList getDefaultFilterSet()
          use filter list from Instrument collector
 java.util.ArrayList getFilterSet()
           
protected  java.lang.String getFiltersKey()
          return filters key represents all filters inputed by user. subclass must implment this method to provide special information.
protected abstract  java.lang.String getUseFiltersKey()
          return key represents whether use custom instrument filters. subclass must implment this method to provide special information
 void initializeData(org.eclipse.debug.core.ILaunchConfiguration launchConfiguration)
          Initialize UI data for custom instrument filters UI.
 void setActiveFilterSet(FilterSetElement set)
          Sets the active filter element
 void setFilterSet(java.util.ArrayList filters)
           
 void storeAttributes(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy workingCopy)
          Store the attributes of custom filter set to special store Note that: Here is my design thought: I feel that custom filters information is related with special profile launch configuration.
 void widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent e)
          Sent when default selection occurs in the control.
 void widgetSelected(org.eclipse.swt.events.SelectionEvent e)
          Sent when selection occurs in the control.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractCustomInstrumentFiltersUI

public AbstractCustomInstrumentFiltersUI(org.eclipse.swt.widgets.Composite parent)
Default constructor.

Parameters:
parent - the parent widget

AbstractCustomInstrumentFiltersUI

public AbstractCustomInstrumentFiltersUI(org.eclipse.swt.widgets.Composite parent,
                                         boolean alwaysEnableFilters)
the constructor of custom instrument filters set for analysis type.

Parameters:
parent - parent composite component
alwaysEnableFilters -
Method Detail

initializeData

public void initializeData(org.eclipse.debug.core.ILaunchConfiguration launchConfiguration)
Initialize UI data for custom instrument filters UI.

Parameters:
launchConfiguration - the associated launch configuratio

storeAttributes

public void storeAttributes(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy workingCopy)
Store the attributes of custom filter set to special store Note that: Here is my design thought: I feel that custom filters information is related with special profile launch configuration. And different launch configuration can't share these custom filters information. So I decide to rather save these information into launch configuration than PreferenceStore database.


getFilterSet

public java.util.ArrayList getFilterSet()

setFilterSet

public void setFilterSet(java.util.ArrayList filters)

getActiveFilterSet

public java.lang.String getActiveFilterSet()
Returns the active filter set id.

Returns:
the active filter set id

setActiveFilterSet

public void setActiveFilterSet(FilterSetElement set)
Sets the active filter element

Parameters:
set - the FilterSetElement

getUseFiltersKey

protected abstract java.lang.String getUseFiltersKey()
return key represents whether use custom instrument filters. subclass must implment this method to provide special information


getFiltersKey

protected java.lang.String getFiltersKey()
return filters key represents all filters inputed by user. subclass must implment this method to provide special information. Note that: it returns launch configuration name that is used to distinguish different profile launch configuration. Because all fiters inputed by user need to store to cache. And cache maybe contains all filters information provided by diferent profile launch configuration.


getActiveFilterKey

protected abstract java.lang.String getActiveFilterKey()
return active filter key represents selected filter choosed by user. subclass must implment this method to provide special information


getDefaultFilterSet

protected java.util.ArrayList getDefaultFilterSet()
use filter list from Instrument collector

Returns:
filter list from Instrument collector

widgetSelected

public void widgetSelected(org.eclipse.swt.events.SelectionEvent e)
Sent when selection occurs in the control.

For example, selection occurs in a List when the user selects an item or items with the keyboard or mouse. On some platforms, the event occurs when a mouse button or key is pressed. On others, it happens when the mouse or key is released. The exact key or mouse gesture that causes this event is platform specific.

Specified by:
widgetSelected in interface org.eclipse.swt.events.SelectionListener
Parameters:
e - an event containing information about the selection

widgetDefaultSelected

public void widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent e)
Sent when default selection occurs in the control.

For example, on some platforms default selection occurs in a List when the user double-clicks an item or types return in a Text. On some platforms, the event occurs when a mouse button or key is pressed. On others, it happens when the mouse or key is released. The exact key or mouse gesture that causes this event is platform specific.

Specified by:
widgetDefaultSelected in interface org.eclipse.swt.events.SelectionListener
Parameters:
e - an event containing information about the default selection

TPTP 4.5.0 Platform Project
Internal API Specification