public class UAContentFilter extends Object
This class provides the ability to filter out user assistance model elements
that support filtering (e.g. IToc
, ITopic
, ...).
Implementations that display such elements should consult this class before
attempting to display them.
Constructor and Description |
---|
UAContentFilter() |
Modifier and Type | Method and Description |
---|---|
static boolean |
isFiltered(Object element)
Returns whether or not the given object should be filtered out.
|
static boolean |
isFiltered(Object element,
IEvaluationContext context)
Returns whether or not the given object should be filtered out.
|
public static boolean isFiltered(Object element)
Returns whether or not the given object should be filtered out. This
applies to any user assistance component's elements where filters apply
(e.g. help tocs, topics, intro elements, context help topics). If the
element is null
or is not filterable, this method returns
false
.
This method is for use in non-UI environments, when serving help outside
the workbench. If filtering from the UI, use the isFiltered
method that accepts the evaluation context as well.
element
- the element to checkpublic static boolean isFiltered(Object element, IEvaluationContext context)
Returns whether or not the given object should be filtered out. This
applies to any user assistance component's elements where filters apply
(e.g. help tocs, topics, intro elements, context help topics). If the
element is null
or is not filterable, this method returns
false
. The evaluation context provides the default object
to test on and a set of variables that can be accessed.
element
- the element to checkcontext
- the evaluation context for evaluating expressions
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.