TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.tptp.filtertype.extension.sample.views
Class FilterTypeSampleView

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.tptp.filtertype.extension.sample.views.FilterTypeSampleView
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, IFilterViewer, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class FilterTypeSampleView
extends org.eclipse.ui.part.ViewPart
implements IFilterViewer

This sample view, simply shows the package listing for the selected object.


Field Summary
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
FilterTypeSampleView()
           
 
Method Summary
 void createPartControl(org.eclipse.swt.widgets.Composite parent)
           
 void dispose()
           
 void filterUpdated()
          When a filter is selected or changed, this method is called to signal to the viewer that one of its filters have changed or updated.
 java.lang.String[] getFilterScope()
          Returns the filter scope associated with the IFilterViewer implementor.
 void makeActions()
          Creates the actions visible.
 void refresh()
          Refreshes the package listing in the view.
 void setFilterQueryProvider(IFilterQueryProvider fqp)
          When the action is created, this method is called providing the IFilterQueryProvider to the viewer.
 void setFocus()
           
 
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.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

FilterTypeSampleView

public FilterTypeSampleView()
Method Detail

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)
Specified by:
createPartControl in interface org.eclipse.ui.IWorkbenchPart
Specified by:
createPartControl in class org.eclipse.ui.part.WorkbenchPart
See Also:
WorkbenchPart.createPartControl(org.eclipse.swt.widgets.Composite)

refresh

public void refresh()
Refreshes the package listing in the view.


setFocus

public void setFocus()
Specified by:
setFocus in interface org.eclipse.ui.IWorkbenchPart
Specified by:
setFocus in class org.eclipse.ui.part.WorkbenchPart
See Also:
WorkbenchPart.setFocus()

makeActions

public void makeActions()
Creates the actions visible. This creates the filter selection action. This for the filters, is a drop down action and editing action.


filterUpdated

public void filterUpdated()
Description copied from interface: IFilterViewer
When a filter is selected or changed, this method is called to signal to the viewer that one of its filters have changed or updated. The implementor can handle this in its choosing (examples: lazy refreshing, immediate refreshing).

Specified by:
filterUpdated in interface IFilterViewer
See Also:
IFilterViewer.filterUpdated()

setFilterQueryProvider

public void setFilterQueryProvider(IFilterQueryProvider fqp)
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(org.eclipse.hyades.ui.filters.IFilterQueryProvider)

getFilterScope

public java.lang.String[] getFilterScope()
Description copied from interface: IFilterViewer
Returns the filter scope associated with the IFilterViewer implementor. The filter scope is used to determine what filter types associated with this viewer. If a filter type is associated with any scope returned here its filters are displayed and can be edited/created from the action of this IFilterViewer.

Specified by:
getFilterScope in interface IFilterViewer
See Also:
IFilterViewer.getFilterScope()

dispose

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

TPTP 4.5.0 Platform Project
Public API Specification