Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / xviewer / util / internal / dialog / XFilteredTree.html
blob: fee22c00374fd7f6315609d16e8c6a98870e73e8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Jul 23 15:58:53 CEST 2020 -->
<title>XFilteredTree</title>
<meta name="date" content="2020-07-23">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XFilteredTree";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XFilteredTree.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XCheckFilteredTreeDialog.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.NotifyingTreeViewer.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html" target="_top">Frames</a></li>
<li><a href="XFilteredTree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.nebula.widgets.xviewer.util.internal.dialog</div>
<h2 title="Class XFilteredTree" class="title">Class XFilteredTree</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Widget</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Control</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Scrollable</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Composite</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.xviewer.util.internal.dialog.XFilteredTree</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.eclipse.swt.graphics.Drawable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XCheckedFilteredTree.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog">XCheckedFilteredTree</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">XFilteredTree</span>
extends org.eclipse.swt.widgets.Composite</pre>
<div class="block">A simple control that provides a text widget and a tree viewer. The contents of the text widget are used to drive a
PatternFilter that is on the viewer.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>PatternFilter</code></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.NotifyingTreeViewer.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog">XFilteredTree.NotifyingTreeViewer</a></span></code>
<div class="block">Custom tree viewer subclass that clears the caches in patternFilter on any change to the tree.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Control</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#clearButtonControl">clearButtonControl</a></span></code>
<div class="block">The control representing the clear button for the filter text entry.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Composite</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#filterComposite">filterComposite</a></span></code>
<div class="block">The Composite on which the filter controls are created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Text</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#filterText">filterText</a></span></code>
<div class="block">The filter text widget to be used by this tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.eclipse.jface.action.ToolBarManager</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#filterToolBar">filterToolBar</a></span></code>
<div class="block">The control representing the clear button for the filter text entry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#initialText">initialText</a></span></code>
<div class="block">The text to initially show in the filter text control.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Composite</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#parent">parent</a></span></code>
<div class="block">The parent composite of the filtered tree.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#showFilterControls">showFilterControls</a></span></code>
<div class="block">Whether or not to show the filter controls (text and clear button).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Composite</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#treeComposite">treeComposite</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.jface.viewers.TreeViewer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#treeViewer">treeViewer</a></span></code>
<div class="block">The viewer for the filtered tree.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.swt.widgets.Control">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.swt.widgets.Control</h3>
<code>handle</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#XFilteredTree-org.eclipse.swt.widgets.Composite-">XFilteredTree</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">As of 3.5, replaced by <code>#FilteredTree(Composite, boolean)</code> where using the look is encouraged</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#XFilteredTree-org.eclipse.swt.widgets.Composite-boolean-">XFilteredTree</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
boolean&nbsp;useNewLook)</code>
<div class="block">Create a new instance of the receiver.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#XFilteredTree-org.eclipse.swt.widgets.Composite-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-">XFilteredTree</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;treeStyle,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">As of 3.5, replaced by <code>#FilteredTree(Composite, int, PatternFilter, boolean)</code> where using the
new look is encouraged</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#XFilteredTree-org.eclipse.swt.widgets.Composite-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-boolean-">XFilteredTree</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;treeStyle,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter,
boolean&nbsp;useNewLook)</code>
<div class="block">Create a new instance of the receiver.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#clearText--">clearText</a></span>()</code>
<div class="block">Clears the text in the filter text widget.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#createControl-org.eclipse.swt.widgets.Composite-int-">createControl</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;treeStyle)</code>
<div class="block">Create the filtered tree's controls.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Composite</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#createFilterControls-org.eclipse.swt.widgets.Composite-">createFilterControls</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent)</code>
<div class="block">Create the filter controls.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#createFilterText-org.eclipse.swt.widgets.Composite-">createFilterText</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent)</code>
<div class="block">Creates the filter text and adds listeners.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Control</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#createTreeControl-org.eclipse.swt.widgets.Composite-int-">createTreeControl</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</code>
<div class="block">Creates and set up the tree and tree viewer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected org.eclipse.swt.widgets.Text</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#doCreateFilterText-org.eclipse.swt.widgets.Composite-">doCreateFilterText</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent)</code>
<div class="block">Creates the text control for entering the filter text.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected org.eclipse.ui.progress.WorkbenchJob</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#doCreateRefreshJob--">doCreateRefreshJob</a></span>()</code>
<div class="block">Creates a workbench job that will refresh the tree based on the current filter text.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected org.eclipse.jface.viewers.TreeViewer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#doCreateTreeViewer-org.eclipse.swt.widgets.Composite-int-">doCreateTreeViewer</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</code>
<div class="block">Creates the tree viewer.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static org.eclipse.swt.graphics.Font</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#getBoldFont-java.lang.Object-org.eclipse.nebula.widgets.xviewer.util.internal.dialog.XFilteredTree-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-">getBoldFont</a></span>(java.lang.Object&nbsp;element,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog">XFilteredTree</a>&nbsp;tree,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter)</code>
<div class="block">Return a bold font if the given element matches the given pattern.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>org.eclipse.swt.widgets.Text</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#getFilterControl--">getFilterControl</a></span>()</code>
<div class="block">Get the filter text for the receiver, if it was created.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#getFilterString--">getFilterString</a></span>()</code>
<div class="block">Convenience method to return the text of the filter control.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#getInitialText--">getInitialText</a></span>()</code>
<div class="block">Get the initial text for the receiver.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#getPatternFilter--">getPatternFilter</a></span>()</code>
<div class="block">Returns the pattern filter used by this tree.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#getRefreshJobDelay--">getRefreshJobDelay</a></span>()</code>
<div class="block">Return the time delay that should be used when scheduling the filter refresh job.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>org.eclipse.jface.viewers.TreeViewer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#getViewer--">getViewer</a></span>()</code>
<div class="block">Get the tree viewer of the receiver.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#init-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-">init</a></span>(int&nbsp;treeStyle,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter)</code>
<div class="block">Create the filtered tree.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#selectAll--">selectAll</a></span>()</code>
<div class="block">Select all text in the filter text field.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#setBackground-org.eclipse.swt.graphics.Color-">setBackground</a></span>(org.eclipse.swt.graphics.Color&nbsp;background)</code>
<div class="block">Set the background for the widgets that support the filter text area.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#setFilterText-java.lang.String-">setFilterText</a></span>(java.lang.String&nbsp;string)</code>
<div class="block">Set the text in the filter control.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#setInitialText-java.lang.String-">setInitialText</a></span>(java.lang.String&nbsp;text)</code>
<div class="block">Set the text that will be shown until the first focus.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#textChanged--">textChanged</a></span>()</code>
<div class="block">Update the receiver after the text has changed.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#updateToolbar-boolean-">updateToolbar</a></span>(boolean&nbsp;visible)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Composite">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Composite</h3>
<code>changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Scrollable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Scrollable</h3>
<code>computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Control">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Control</h3>
<code>addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Widget">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Widget</h3>
<code>addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.graphics.Drawable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.swt.graphics.Drawable</h3>
<code>isAutoScalable</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="filterText">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterText</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Text filterText</pre>
<div class="block">The filter text widget to be used by this tree. This value may be <code>null</code> if there is no filter widget,
or if the controls have not yet been created.</div>
</li>
</ul>
<a name="filterToolBar">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterToolBar</h4>
<pre>protected&nbsp;org.eclipse.jface.action.ToolBarManager filterToolBar</pre>
<div class="block">The control representing the clear button for the filter text entry. This value may be <code>null</code> if no
such button exists, or if the controls have not yet been created.
<p>
<strong>Note:</strong> As of 3.5, this is not used if the new look is chosen.
</p></div>
</li>
</ul>
<a name="clearButtonControl">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearButtonControl</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Control clearButtonControl</pre>
<div class="block">The control representing the clear button for the filter text entry. This value may be <code>null</code> if no
such button exists, or if the controls have not yet been created.
<p>
<strong>Note:</strong> This is only used if the new look is chosen.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</li>
</ul>
<a name="treeViewer">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>treeViewer</h4>
<pre>protected&nbsp;org.eclipse.jface.viewers.TreeViewer treeViewer</pre>
<div class="block">The viewer for the filtered tree. This value should never be <code>null</code> after the widget creation methods
are complete.</div>
</li>
</ul>
<a name="filterComposite">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterComposite</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Composite filterComposite</pre>
<div class="block">The Composite on which the filter controls are created. This is used to set the background color of the filter
controls to match the surrounding controls.</div>
</li>
</ul>
<a name="initialText">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialText</h4>
<pre>protected&nbsp;java.lang.String initialText</pre>
<div class="block">The text to initially show in the filter text control.</div>
</li>
</ul>
<a name="parent">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parent</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Composite parent</pre>
<div class="block">The parent composite of the filtered tree.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.3</dd>
</dl>
</li>
</ul>
<a name="showFilterControls">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showFilterControls</h4>
<pre>protected&nbsp;boolean showFilterControls</pre>
<div class="block">Whether or not to show the filter controls (text and clear button). The default is to show these controls. This
can be overridden by providing a setting in the product configuration file. The setting to add to not show these
controls is: org.eclipse.ui/SHOW_FILTERED_TEXTS=false</div>
</li>
</ul>
<a name="treeComposite">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>treeComposite</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Composite treeComposite</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.3</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XFilteredTree-org.eclipse.swt.widgets.Composite-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XFilteredTree</h4>
<pre>@Deprecated
public&nbsp;XFilteredTree(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;treeStyle,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 3.5, replaced by <code>#FilteredTree(Composite, int, PatternFilter, boolean)</code> where using the
new look is encouraged</span></div>
<div class="block">Create a new instance of the receiver.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent <code>Composite</code></dd>
<dd><code>treeStyle</code> - the style bits for the <code>Tree</code></dd>
<dd><code>filter</code> - the filter to be used</dd>
</dl>
</li>
</ul>
<a name="XFilteredTree-org.eclipse.swt.widgets.Composite-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XFilteredTree</h4>
<pre>public&nbsp;XFilteredTree(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;treeStyle,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter,
boolean&nbsp;useNewLook)</pre>
<div class="block">Create a new instance of the receiver.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent <code>Composite</code></dd>
<dd><code>treeStyle</code> - the style bits for the <code>Tree</code></dd>
<dd><code>filter</code> - the filter to be used</dd>
<dd><code>useNewLook</code> - <code>true</code> if the new 3.5 look should be used</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</li>
</ul>
<a name="XFilteredTree-org.eclipse.swt.widgets.Composite-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XFilteredTree</h4>
<pre>@Deprecated
protected&nbsp;XFilteredTree(org.eclipse.swt.widgets.Composite&nbsp;parent)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 3.5, replaced by <code>#FilteredTree(Composite, boolean)</code> where using the look is encouraged</span></div>
<div class="block">Create a new instance of the receiver. Subclasses that wish to override the default creation behavior may use this
constructor, but must ensure that the <code>init(composite, int, PatternFilter)</code> method is called in the
overriding constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent <code>Composite</code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#init-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-"><code>init(int, PatternFilter)</code></a></dd>
</dl>
</li>
</ul>
<a name="XFilteredTree-org.eclipse.swt.widgets.Composite-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XFilteredTree</h4>
<pre>protected&nbsp;XFilteredTree(org.eclipse.swt.widgets.Composite&nbsp;parent,
boolean&nbsp;useNewLook)</pre>
<div class="block">Create a new instance of the receiver. Subclasses that wish to override the default creation behavior may use this
constructor, but must ensure that the <code>init(composite, int, PatternFilter)</code> method is called in the
overriding constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent <code>Composite</code></dd>
<dd><code>useNewLook</code> - <code>true</code> if the new 3.5 look should be used</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#init-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-"><code>init(int, PatternFilter)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-int-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>protected&nbsp;void&nbsp;init(int&nbsp;treeStyle,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter)</pre>
<div class="block">Create the filtered tree.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>treeStyle</code> - the style bits for the <code>Tree</code></dd>
<dd><code>filter</code> - the filter to be used</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.3</dd>
</dl>
</li>
</ul>
<a name="createControl-org.eclipse.swt.widgets.Composite-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createControl</h4>
<pre>protected&nbsp;void&nbsp;createControl(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;treeStyle)</pre>
<div class="block">Create the filtered tree's controls. Subclasses should override.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - </dd>
<dd><code>treeStyle</code> - </dd>
</dl>
</li>
</ul>
<a name="createFilterControls-org.eclipse.swt.widgets.Composite-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFilterControls</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Composite&nbsp;createFilterControls(org.eclipse.swt.widgets.Composite&nbsp;parent)</pre>
<div class="block">Create the filter controls. By default, a text and corresponding tool bar button that clears the contents of the
text is created. Subclasses may override.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - parent <code>Composite</code> of the filter controls</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>Composite</code> that contains the filter controls</dd>
</dl>
</li>
</ul>
<a name="createTreeControl-org.eclipse.swt.widgets.Composite-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTreeControl</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Control&nbsp;createTreeControl(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</pre>
<div class="block">Creates and set up the tree and tree viewer. This method calls <a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#doCreateTreeViewer-org.eclipse.swt.widgets.Composite-int-"><code>doCreateTreeViewer(Composite, int)</code></a> to
create the tree viewer. Subclasses should override <a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#doCreateTreeViewer-org.eclipse.swt.widgets.Composite-int-"><code>doCreateTreeViewer(Composite, int)</code></a> instead of
overriding this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - parent <code>Composite</code></dd>
<dd><code>style</code> - SWT style bits used to create the tree</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tree</dd>
</dl>
</li>
</ul>
<a name="doCreateTreeViewer-org.eclipse.swt.widgets.Composite-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doCreateTreeViewer</h4>
<pre>protected&nbsp;org.eclipse.jface.viewers.TreeViewer&nbsp;doCreateTreeViewer(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</pre>
<div class="block">Creates the tree viewer. Subclasses may override.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent composite</dd>
<dd><code>style</code> - SWT style bits used to create the tree viewer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tree viewer</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.3</dd>
</dl>
</li>
</ul>
<a name="doCreateRefreshJob--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doCreateRefreshJob</h4>
<pre>protected&nbsp;org.eclipse.ui.progress.WorkbenchJob&nbsp;doCreateRefreshJob()</pre>
<div class="block">Creates a workbench job that will refresh the tree based on the current filter text. Subclasses may override.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a workbench job that can be scheduled to refresh the tree</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.4</dd>
</dl>
</li>
</ul>
<a name="updateToolbar-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateToolbar</h4>
<pre>protected&nbsp;void&nbsp;updateToolbar(boolean&nbsp;visible)</pre>
</li>
</ul>
<a name="createFilterText-org.eclipse.swt.widgets.Composite-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFilterText</h4>
<pre>protected&nbsp;void&nbsp;createFilterText(org.eclipse.swt.widgets.Composite&nbsp;parent)</pre>
<div class="block">Creates the filter text and adds listeners. This method calls <a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#doCreateFilterText-org.eclipse.swt.widgets.Composite-"><code>doCreateFilterText(Composite)</code></a> to create the
text control. Subclasses should override <a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html#doCreateFilterText-org.eclipse.swt.widgets.Composite-"><code>doCreateFilterText(Composite)</code></a> instead of overriding this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - <code>Composite</code> of the filter text</dd>
</dl>
</li>
</ul>
<a name="doCreateFilterText-org.eclipse.swt.widgets.Composite-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doCreateFilterText</h4>
<pre>protected&nbsp;org.eclipse.swt.widgets.Text&nbsp;doCreateFilterText(org.eclipse.swt.widgets.Composite&nbsp;parent)</pre>
<div class="block">Creates the text control for entering the filter text. Subclasses may override.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the parent composite</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the text widget</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.3</dd>
</dl>
</li>
</ul>
<a name="textChanged--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>textChanged</h4>
<pre>protected&nbsp;void&nbsp;textChanged()</pre>
<div class="block">Update the receiver after the text has changed.</div>
</li>
</ul>
<a name="getRefreshJobDelay--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRefreshJobDelay</h4>
<pre>protected&nbsp;long&nbsp;getRefreshJobDelay()</pre>
<div class="block">Return the time delay that should be used when scheduling the filter refresh job. Subclasses may override.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a time delay in milliseconds before the job should run</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</li>
</ul>
<a name="setBackground-org.eclipse.swt.graphics.Color-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBackground</h4>
<pre>public&nbsp;void&nbsp;setBackground(org.eclipse.swt.graphics.Color&nbsp;background)</pre>
<div class="block">Set the background for the widgets that support the filter text area.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setBackground</code>&nbsp;in class&nbsp;<code>org.eclipse.swt.widgets.Control</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>background</code> - background <code>Color</code> to set</dd>
</dl>
</li>
</ul>
<a name="clearText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearText</h4>
<pre>protected&nbsp;void&nbsp;clearText()</pre>
<div class="block">Clears the text in the filter text widget.</div>
</li>
</ul>
<a name="setFilterText-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilterText</h4>
<pre>protected&nbsp;void&nbsp;setFilterText(java.lang.String&nbsp;string)</pre>
<div class="block">Set the text in the filter control.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>string</code> - </dd>
</dl>
</li>
</ul>
<a name="getPatternFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPatternFilter</h4>
<pre>public final&nbsp;<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;getPatternFilter()</pre>
<div class="block">Returns the pattern filter used by this tree.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The pattern filter; never <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getViewer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getViewer</h4>
<pre>public&nbsp;org.eclipse.jface.viewers.TreeViewer&nbsp;getViewer()</pre>
<div class="block">Get the tree viewer of the receiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tree viewer</dd>
</dl>
</li>
</ul>
<a name="getFilterControl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterControl</h4>
<pre>public&nbsp;org.eclipse.swt.widgets.Text&nbsp;getFilterControl()</pre>
<div class="block">Get the filter text for the receiver, if it was created. Otherwise return <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filter Text, or null if it was not created</dd>
</dl>
</li>
</ul>
<a name="getFilterString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterString</h4>
<pre>protected&nbsp;java.lang.String&nbsp;getFilterString()</pre>
<div class="block">Convenience method to return the text of the filter control. If the text widget is not created, then null is
returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String in the text, or null if the text does not exist</dd>
</dl>
</li>
</ul>
<a name="setInitialText-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialText</h4>
<pre>public&nbsp;void&nbsp;setInitialText(java.lang.String&nbsp;text)</pre>
<div class="block">Set the text that will be shown until the first focus. A default value is provided, so this method only need be
called if overriding the default initial text is desired.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - initial text to appear in text field</dd>
</dl>
</li>
</ul>
<a name="selectAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectAll</h4>
<pre>protected&nbsp;void&nbsp;selectAll()</pre>
<div class="block">Select all text in the filter text field.</div>
</li>
</ul>
<a name="getInitialText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialText</h4>
<pre>protected&nbsp;java.lang.String&nbsp;getInitialText()</pre>
<div class="block">Get the initial text for the receiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String</dd>
</dl>
</li>
</ul>
<a name="getBoldFont-java.lang.Object-org.eclipse.nebula.widgets.xviewer.util.internal.dialog.XFilteredTree-org.eclipse.nebula.widgets.xviewer.util.internal.PatternFilter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBoldFont</h4>
<pre>public static&nbsp;org.eclipse.swt.graphics.Font&nbsp;getBoldFont(java.lang.Object&nbsp;element,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog">XFilteredTree</a>&nbsp;tree,
<a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/PatternFilter.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">PatternFilter</a>&nbsp;filter)</pre>
<div class="block">Return a bold font if the given element matches the given pattern. Clients can opt to call this method from a
Viewer's label provider to get a bold font for which to highlight the given element in the tree.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - element for which a match should be determined</dd>
<dd><code>tree</code> - FilteredTree in which the element resides</dd>
<dd><code>filter</code> - PatternFilter which determines a match</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>bold font</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XFilteredTree.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XCheckFilteredTreeDialog.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.NotifyingTreeViewer.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal.dialog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/util/internal/dialog/XFilteredTree.html" target="_top">Frames</a></li>
<li><a href="XFilteredTree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>