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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidapply(MarkerFieldFilter filter)Apply the current settings to the filter.abstract voidcreateContents(Composite parent)Create the contents of the configuration area in the parent.MarkerFieldgetField()Return the field for the receiver.protected FontMetricsgetFontMetrics()Return theFontMetricsfor the receiver.StringgetTitle()Get the title for the receiver.booleangrabExcessVerticalSpace()Returns whether the configuration area should grab remaining vertical space.abstract voidinitialize(MarkerFieldFilter filter)Initialise the receiver using the filter.protected voidinitializeFontMetrics(Control control)InitialiseFontMetricsfor the receiver.protected voidsetButtonLayoutData(Button button)Set the standard button data for the button.voidsetField(MarkerField markerField)Set the markerField for the receiver.
-
-
-
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 theFontMetricsfor the receiver.- Returns:
FontMetricsornullifinitializeFontMetrics(Control)has not been called.
-
getTitle
public String getTitle()
Get the title for the receiver.- Returns:
- String
-
initializeFontMetrics
protected void initializeFontMetrics(Control control)
InitialiseFontMetricsfor 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 returnsfalse. Subclasses can override.- Returns:
trueiff the configuration area should grab remaining vertical space- Since:
- 3.5
-
-