Eclipse Platform
Release 3.4

org.eclipse.ui.views.markers
Class MarkerFieldFilter

java.lang.Object
  extended byorg.eclipse.ui.views.markers.MarkerFieldFilter

public abstract class MarkerFieldFilter
extends Object

A MarkerFieldFilter is a filter on a particular marker field.

Since:
3.4

Constructor Summary
MarkerFieldFilter()
           
 
Method Summary
 MarkerField getField()
          Get the field for the receiver.
 void initialize(Map values)
          Initialise the receiver with the values in the values Map.
abstract  void loadSettings(IMemento memento)
          Load any settings for the receiver from the memento.
 void populateWorkingCopy(MarkerFieldFilter copy)
          Populate the working copy with the copy of whatever fields are required.
abstract  void saveSettings(IMemento memento)
          Save any of the relevant state for the receiver in the memento so that it can be used to restore the user settings.
abstract  boolean select(MarkerItem item)
          Return whether or not marker should be filtered by the receiver.
 void setField(MarkerField markerField)
          Set the field for the receiver.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MarkerFieldFilter

public MarkerFieldFilter()
Method Detail

select

public abstract boolean select(MarkerItem item)
Return whether or not marker should be filtered by the receiver.

Parameters:
item -
Returns:
boolean true if the marker should be shown.

initialize

public void initialize(Map values)
Initialise the receiver with the values in the values Map.

Parameters:
values -
See Also:
FiltersContributionParameters

populateWorkingCopy

public void populateWorkingCopy(MarkerFieldFilter copy)
Populate the working copy with the copy of whatever fields are required.

Parameters:
copy -

setField

public final void setField(MarkerField markerField)
Set the field for the receiver.

Parameters:
markerField -

getField

public final MarkerField getField()
Get the field for the receiver.

Returns:
MarkerField

saveSettings

public abstract void saveSettings(IMemento memento)
Save any of the relevant state for the receiver in the memento so that it can be used to restore the user settings.

Parameters:
memento -
See Also:
loadSettings(IMemento)

loadSettings

public abstract void loadSettings(IMemento memento)
Load any settings for the receiver from the memento.

Parameters:
memento -
See Also:
saveSettings(IMemento)

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.