|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.help.UAContentFilter
This class provides the ability to filter out user assistance model elements that
support filtering (e.g. IToc
, ITopic
, ...).
Implementations that display such filterable elements should consult this class
before attempting to display them.
Constructor Summary | |
---|---|
UAContentFilter()
|
Method Summary | |
---|---|
static boolean |
isFiltered(Object element)
Returns whether or not the given object should be filtered out. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public UAContentFilter()
Method Detail |
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
.
element
- the element to check
|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.