Package org.eclipse.ui.views.markers

Class FilterConfigurationArea

java.lang.Object

org.eclipse.ui.views.markers.FilterConfigurationArea

public abstract class FilterConfigurationArea
extends Object

FilterConfigurationArea is the area that the user can configure a filter in.

Since:

3.4

Constructor Summary

Constructors

Constructor	Description
FilterConfigurationArea()

Method Summary

Modifier and Type	Method	Description
abstract void	apply(MarkerFieldFilter filter)	Apply the current settings to the filter.
abstract void	createContents(Composite parent)	Create the contents of the configuration area in the parent.
MarkerField	getField()	Return the field for the receiver.
protected FontMetrics	getFontMetrics()	Return the FontMetrics for the receiver.
String	getTitle()	Get the title for the receiver.
boolean	grabExcessVerticalSpace()	Returns whether the configuration area should grab remaining vertical space.
abstract void	initialize(MarkerFieldFilter filter)	Initialise the receiver using the filter.
protected void	initializeFontMetrics(Control control)	Initialise FontMetrics for the receiver.
protected void	setButtonLayoutData(Button button)	Set the standard button data for the button.
void	setField(MarkerField markerField)	Set the markerField for the receiver.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterConfigurationArea

public FilterConfigurationArea()

Method Detail

apply

public abstract void apply(MarkerFieldFilter filter)

Apply the current settings to the filter.

Parameters:

filter - filter to update

createContents

public abstract void createContents(Composite parent)

Create the contents of the configuration area in the parent.

Parameters:

parent - the parent composite

getFontMetrics

protected FontMetrics getFontMetrics()

Return the FontMetrics for the receiver.

Returns:

FontMetrics or null if initializeFontMetrics(Control) has not been called.

getTitle

public String getTitle()

Get the title for the receiver.

Returns:

String

initializeFontMetrics

protected void initializeFontMetrics(Control control)

Initialise FontMetrics for the receiver.

Parameters:

control - control to get font from

initialize

public abstract void initialize(MarkerFieldFilter filter)

Initialise the receiver using the filter.

Parameters:

filter - filter to use

setField

public final void setField(MarkerField markerField)

Set the markerField for the receiver. This method intended to be called by the marker support framework directly after instantiation of the receiver.

Parameters:

markerField - field to set

setButtonLayoutData

protected void setButtonLayoutData(Button button)

Set the standard button data for the button.

Parameters:

button - button to change

getField

public MarkerField getField()

Return the field for the receiver.

Returns:

MarkerField

grabExcessVerticalSpace

public boolean grabExcessVerticalSpace()

Returns whether the configuration area should grab remaining vertical space. The default implementation returns false. Subclasses can override.

Returns:

true iff the configuration area should grab remaining vertical space

Since:

3.5