Eclipse Platform
Release 3.3

org.eclipse.ui.actions
Class WorkingSetFilterActionGroup

java.lang.Object
  extended byorg.eclipse.ui.actions.ActionGroup
      extended byorg.eclipse.ui.actions.WorkingSetFilterActionGroup

public class WorkingSetFilterActionGroup
extends ActionGroup

Adds working set filter actions (set / clear / edit)

Since:
2.1

Field Summary
static String CHANGE_WORKING_SET
          Indicates if working set was changed
 
Constructor Summary
WorkingSetFilterActionGroup(Shell shell, IPropertyChangeListener workingSetUpdater)
          Creates a new instance of the receiver.
 
Method Summary
 void dispose()
          This method is called by the user of an action group to signal that the group is no longer needed.
 void fillActionBars(IActionBars actionBars)
          Adds the applicable actions to a part's action bars, including setting any global action handlers.
 void fillContextMenu(IMenuManager menuManager)
          Adds the applicable actions to a context menu, based on the state of the ActionContext.
 IWorkingSet getWorkingSet()
          Returns the working set which is currently selected.
 void restoreState(IMemento memento)
          Restores the state of the filter actions from a memento.
 void saveState(IMemento memento)
          Saves the state of the filter actions in a memento.
 void setWorkingSet(IWorkingSet newWorkingSet)
          Sets the current working set.
 
Methods inherited from class org.eclipse.ui.actions.ActionGroup
getContext, setContext, updateActionBars
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHANGE_WORKING_SET

public static final String CHANGE_WORKING_SET
Indicates if working set was changed

See Also:
Constant Field Values
Constructor Detail

WorkingSetFilterActionGroup

public WorkingSetFilterActionGroup(Shell shell,
                                   IPropertyChangeListener workingSetUpdater)
Creates a new instance of the receiver.

Parameters:
shell - shell to open dialogs and wizards on
workingSetUpdater - property change listener notified when a working set is set
Since:
3.2 Please note that it is expected that clients treat any selected working sets whose IWorkingSet.isAggregateWorkingSet() method returns true somewhat differently from traditional working sets. Please see the documentation for IWorkbenchPage.getAggregateWorkingSet() for details.
Method Detail

dispose

public void dispose()
Description copied from class: ActionGroup
This method is called by the user of an action group to signal that the group is no longer needed. Subclasses typically implement this method to deregister any listeners or to free other resources.

The default implementation calls setContext(null). Subclasses may extend this method.

Overrides:
dispose in class ActionGroup

fillActionBars

public void fillActionBars(IActionBars actionBars)
Description copied from class: ActionGroup
Adds the applicable actions to a part's action bars, including setting any global action handlers.

The default implementation does nothing. Subclasses may override or extend this method.

Overrides:
fillActionBars in class ActionGroup
Parameters:
actionBars - the part's action bars

fillContextMenu

public void fillContextMenu(IMenuManager menuManager)
Description copied from class: ActionGroup
Adds the applicable actions to a context menu, based on the state of the ActionContext.

The default implementation does nothing. Subclasses may override or extend this method.

Overrides:
fillContextMenu in class ActionGroup
Parameters:
menuManager - the context menu manager

getWorkingSet

public IWorkingSet getWorkingSet()
Returns the working set which is currently selected.

Returns:
the working set which is currently selected.

setWorkingSet

public void setWorkingSet(IWorkingSet newWorkingSet)
Sets the current working set.

Parameters:
newWorkingSet - the new working set

saveState

public void saveState(IMemento memento)
Saves the state of the filter actions in a memento.

Parameters:
memento - the memento
Since:
3.3

restoreState

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

Note: This method does not refresh the viewer.

Parameters:
memento -
Since:
3.3

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.