Package org.eclipse.jdt.ui.actions

Class CustomFiltersActionGroup

java.lang.Object
org.eclipse.ui.actions.ActionGroup
org.eclipse.jdt.ui.actions.CustomFiltersActionGroup
public class CustomFiltersActionGroup extends org.eclipse.ui.actions.ActionGroup
Action group to add the filter action to a view part's tool bar menu.

This class may be instantiated; it is not intended to be subclassed.

Since:
2.0
Restriction:
This class is not intended to be subclassed by clients.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomFiltersActionGroup(String ownerId, org.eclipse.jface.viewers.StructuredViewer viewer)
    Creates a new CustomFiltersActionGroup.
    CustomFiltersActionGroup(org.eclipse.ui.IViewPart part, org.eclipse.jface.viewers.StructuredViewer viewer)
    Creates a new CustomFiltersActionGroup.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
     
    void
    fillActionBars(org.eclipse.ui.IActionBars actionBars)
     
    void
    fillViewMenu(org.eclipse.jface.action.IMenuManager viewMenu)
    Fills the given view menu with the entries managed by the group.
    String[]
    internalGetEnabledFilterIds()
    Returns a list of currently enabled filters.
    String[]
    removeFiltersFor(Object parent, Object element, org.eclipse.jface.viewers.IContentProvider contentProvider)
    Removes filters for the given parent and element
    void
    restoreState(org.eclipse.ui.IMemento memento)
    Restores the state of the filter actions from a memento.
    void
    saveState(org.eclipse.ui.IMemento memento)
    Saves the state of the custom filters in a memento.
    void
    setFilters(String[] newFilters)
    Sets the filters to the given array of new filters

    Methods inherited from class org.eclipse.ui.actions.ActionGroup

    fillContextMenu, getContext, setContext, updateActionBars

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CustomFiltersActionGroup

      public CustomFiltersActionGroup(org.eclipse.ui.IViewPart part, org.eclipse.jface.viewers.StructuredViewer viewer)
      Creates a new CustomFiltersActionGroup.
      Parameters:
      part - the view part that owns this action group
      viewer - the viewer to be filtered

    • CustomFiltersActionGroup

      public CustomFiltersActionGroup(String ownerId, org.eclipse.jface.viewers.StructuredViewer viewer)
      Creates a new CustomFiltersActionGroup.
      Parameters:
      ownerId - the id of this action group's owner
      viewer - the viewer to be filtered

  • Method Details

    • fillActionBars

      public void fillActionBars(org.eclipse.ui.IActionBars actionBars)
      Overrides:
      fillActionBars in class org.eclipse.ui.actions.ActionGroup

    • internalGetEnabledFilterIds

      public String[] internalGetEnabledFilterIds()
      Returns a list of currently enabled filters. The filter is identified by its id.

      This method is for internal use only and should not be called by clients outside of JDT/UI.

      Returns:
      a list of currently enabled filters
      Since:
      3.1
      Restriction:
      This method is not intended to be referenced by clients.

    • removeFiltersFor

      public String[] removeFiltersFor(Object parent, Object element, org.eclipse.jface.viewers.IContentProvider contentProvider)
      Removes filters for the given parent and element
      Parameters:
      parent - the parent of the element
      element - the element
      contentProvider - the content provider of the viewer from which the filters will be removed
      Returns:
      the array of new filter ids

    • setFilters

      public void setFilters(String[] newFilters)
      Sets the filters to the given array of new filters
      Parameters:
      newFilters - the new filters

    • fillViewMenu

      public void fillViewMenu(org.eclipse.jface.action.IMenuManager viewMenu)
      Fills the given view menu with the entries managed by the group.
      Parameters:
      viewMenu - the menu to fill

    • dispose

      public void dispose()
      Overrides:
      dispose in class org.eclipse.ui.actions.ActionGroup

    • saveState

      public void saveState(org.eclipse.ui.IMemento memento)
      Saves the state of the custom filters in a memento.
      Parameters:
      memento - the memento into which the state is saved

    • restoreState

      public void restoreState(org.eclipse.ui.IMemento memento)
      Restores the state of the filter actions from a memento.

      Note: This method does not refresh the viewer.

      Parameters:
      memento - the memento from which the state is restored