Eclipse Platform
Release 3.2

org.eclipse.help
Class UAContentFilter

java.lang.Object
  extended byorg.eclipse.help.UAContentFilter

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 filterable elements should consult this class before attempting to display them.

Since:
3.2

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

UAContentFilter

public UAContentFilter()
Method Detail

isFiltered

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.

Parameters:
element - the element to check
Returns:
whether or not the element should be filtered out

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.