org.eclipse.nebula.widgets.xviewer.util.internal

Class FilteredTreeComposite

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.nebula.widgets.xviewer.util.internal.FilteredTreeComposite

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

Direct Known Subclasses:

XViewerFilteredTree

public class FilteredTreeComposite
extends org.eclipse.swt.widgets.Composite

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.

Since:

3.2

See Also:

PatternFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	FilteredTreeComposite.NotifyingTreeViewer Custom tree viewer subclass that clears the caches in patternFilter on any change to the tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.widgets.Composite	filterComposite The Composite on which the filter controls are created.
protected org.eclipse.swt.widgets.Text	filterText The filter text widget to be used by this tree.
protected org.eclipse.jface.action.ToolBarManager	filterToolBar The control representing the clear button for the filter text entry.
protected java.lang.String	initialText The text to initially show in the filter text control.
protected org.eclipse.swt.widgets.Composite	parent The parent composite of the filtered tree.
protected boolean	showFilterControls Whether or not to show the filter controls (text and clear button).
protected org.eclipse.swt.widgets.Composite	treeComposite
protected org.eclipse.jface.viewers.TreeViewer	treeViewer The viewer for the filtered tree.

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilteredTreeComposite(org.eclipse.swt.widgets.Composite parent) Create a new instance of the receiver.
	FilteredTreeComposite(org.eclipse.swt.widgets.Composite parent, int treeStyle, PatternFilter filter) Create a new instance of the receiver.

Method Summary

Modifier and Type	Method and Description
protected void	clearText() Clears the text in the filter text widget.
protected void	createControl(org.eclipse.swt.widgets.Composite parent, int treeStyle) Create the filtered tree's controls.
protected org.eclipse.swt.widgets.Composite	createFilterControls(org.eclipse.swt.widgets.Composite parent) Create the filter controls.
protected void	createFilterText(org.eclipse.swt.widgets.Composite parent) Creates the filter text and adds listeners.
protected org.eclipse.swt.widgets.Control	createTreeControl(org.eclipse.swt.widgets.Composite parent, int style) Creates and set up the tree and tree viewer.
protected org.eclipse.swt.widgets.Text	doCreateFilterText(org.eclipse.swt.widgets.Composite parent) Creates the text control for entering the filter text.
protected XViewerWorkbenchJob	doCreateRefreshJob() Creates a workbench job that will refresh the tree based on the current filter text.
protected org.eclipse.jface.viewers.TreeViewer	doCreateTreeViewer(org.eclipse.swt.widgets.Composite parent, int style) Creates the tree viewer.
static org.eclipse.swt.graphics.Font	getBoldFont(java.lang.Object element, FilteredTreeComposite tree, PatternFilter filter) Return a bold font if the given element matches the given pattern.
org.eclipse.swt.widgets.Text	getFilterControl() Get the filter text for the receiver, if it was created.
protected java.lang.String	getFilterString() Convenience method to return the text of the filter control.
protected java.lang.String	getInitialText() Get the initial text for the receiver.
PatternFilter	getPatternFilter() Returns the pattern filter used by this tree.
org.eclipse.jface.viewers.TreeViewer	getViewer() Get the tree viewer of the receiver.
protected void	init(int treeStyle, PatternFilter filter) Create the filtered tree.
protected void	selectAll() Select all text in the filter text field.
void	setBackground(org.eclipse.swt.graphics.Color background) Set the background for the widgets that support the filter text area.
protected void	setFilterText(java.lang.String string) Set the text in the filter control.
void	setInitialText(java.lang.String text) Set the text that will be shown until the first focus.
protected void	textChanged() Update the receiver after the text has changed.
protected void	updateToolbar(boolean visible)

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

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

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.swt.graphics.Drawable

isAutoScalable

Field Detail

filterText

protected org.eclipse.swt.widgets.Text filterText

The filter text widget to be used by this tree. This value may be null if there is no filter widget, or if the controls have not yet been created.

filterToolBar

protected org.eclipse.jface.action.ToolBarManager filterToolBar

The control representing the clear button for the filter text entry. This value may be null if no such button exists, or if the controls have not yet been created.

treeViewer

protected org.eclipse.jface.viewers.TreeViewer treeViewer

The viewer for the filtered tree. This value should never be null after the widget creation methods are complete.

filterComposite

protected org.eclipse.swt.widgets.Composite filterComposite

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.

initialText

protected java.lang.String initialText

The text to initially show in the filter text control.

parent

protected org.eclipse.swt.widgets.Composite parent

The parent composite of the filtered tree.

Since:

3.3

showFilterControls

protected boolean showFilterControls

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

treeComposite

protected org.eclipse.swt.widgets.Composite treeComposite

Since:

3.3

Constructor Detail

FilteredTreeComposite

public FilteredTreeComposite(org.eclipse.swt.widgets.Composite parent,
                             int treeStyle,
                             PatternFilter filter)

Create a new instance of the receiver.

Parameters:

parent - the parent Composite

treeStyle - the style bits for the Tree

filter - the filter to be used

FilteredTreeComposite

protected FilteredTreeComposite(org.eclipse.swt.widgets.Composite parent)

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 init(composite, int, PatternFilter) method is called in the overriding constructor.

Parameters:

parent - the parent Composite

Since:

3.3

See Also:

init(int, PatternFilter)

Method Detail

init

protected void init(int treeStyle,
                    PatternFilter filter)

Create the filtered tree.

Parameters:

treeStyle - the style bits for the Tree

filter - the filter to be used

Since:

3.3

createControl

protected void createControl(org.eclipse.swt.widgets.Composite parent,
                             int treeStyle)

Create the filtered tree's controls. Subclasses should override.

createFilterControls

protected org.eclipse.swt.widgets.Composite createFilterControls(org.eclipse.swt.widgets.Composite parent)

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.

Parameters:

parent - parent Composite of the filter controls

Returns:

the Composite that contains the filter controls

createTreeControl

protected org.eclipse.swt.widgets.Control createTreeControl(org.eclipse.swt.widgets.Composite parent,
                                                            int style)

Creates and set up the tree and tree viewer. This method calls doCreateTreeViewer(Composite, int) to create the tree viewer. Subclasses should override doCreateTreeViewer(Composite, int) instead of overriding this method.

Parameters:

parent - parent Composite

style - SWT style bits used to create the tree

Returns:

the tree

doCreateTreeViewer

protected org.eclipse.jface.viewers.TreeViewer doCreateTreeViewer(org.eclipse.swt.widgets.Composite parent,
                                                                  int style)

Creates the tree viewer. Subclasses may override.

Parameters:

parent - the parent composite

style - SWT style bits used to create the tree viewer

Returns:

the tree viewer

Since:

3.3

doCreateRefreshJob

protected XViewerWorkbenchJob doCreateRefreshJob()

Creates a workbench job that will refresh the tree based on the current filter text. Subclasses may override.

Returns:

a workbench job that can be scheduled to refresh the tree

Since:

3.4

updateToolbar

protected void updateToolbar(boolean visible)

createFilterText

protected void createFilterText(org.eclipse.swt.widgets.Composite parent)

Creates the filter text and adds listeners. This method calls doCreateFilterText(Composite) to create the text control. Subclasses should override doCreateFilterText(Composite) instead of overriding this method.

Parameters:

parent - Composite of the filter text

doCreateFilterText

protected org.eclipse.swt.widgets.Text doCreateFilterText(org.eclipse.swt.widgets.Composite parent)

Creates the text control for entering the filter text. Subclasses may override.

Parameters:

parent - the parent composite

Returns:

the text widget

Since:

3.3

textChanged

protected void textChanged()

Update the receiver after the text has changed.

setBackground

public void setBackground(org.eclipse.swt.graphics.Color background)

Set the background for the widgets that support the filter text area.

Overrides:

setBackground in class org.eclipse.swt.widgets.Control

Parameters:

background - background Color to set

clearText

protected void clearText()

Clears the text in the filter text widget. Also removes the optional additional filter that is provided via addFilter(ViewerFilter).

setFilterText

protected void setFilterText(java.lang.String string)

Set the text in the filter control.

getPatternFilter

public final PatternFilter getPatternFilter()

Returns the pattern filter used by this tree.

Returns:

The pattern filter; never null.

getViewer

public org.eclipse.jface.viewers.TreeViewer getViewer()

Get the tree viewer of the receiver.

Returns:

the tree viewer

getFilterControl

public org.eclipse.swt.widgets.Text getFilterControl()

Get the filter text for the receiver, if it was created. Otherwise return null.

Returns:

the filter Text, or null if it was not created

getFilterString

protected java.lang.String getFilterString()

Convenience method to return the text of the filter control. If the text widget is not created, then null is returned.

Returns:

String in the text, or null if the text does not exist

setInitialText

public void setInitialText(java.lang.String text)

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.

Parameters:

text - initial text to appear in text field

selectAll

protected void selectAll()

Select all text in the filter text field.

getInitialText

protected java.lang.String getInitialText()

Get the initial text for the receiver.

getBoldFont

public static org.eclipse.swt.graphics.Font getBoldFont(java.lang.Object element,
                                                        FilteredTreeComposite tree,
                                                        PatternFilter filter)

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.

Parameters:

element - element for which a match should be determined

tree - FilteredTree in which the element resides

filter - PatternFilter which determines a match

Returns:

bold font