Package 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

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

Field Summary

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

handle

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
PatternFilter	getPatternFilter()	Returns the pattern filter used by this tree.
org.eclipse.jface.viewers.TreeViewer	getViewer()	Get the tree viewer of the receiver.
void	setBackground(org.eclipse.swt.graphics.Color background)	Set the background for the widgets that support the filter text area.
void	setInitialText(java.lang.String text)	Set the text that will be shown until the first focus.

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

changed, 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.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 interface org.eclipse.swt.graphics.Drawable

isAutoScalable

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

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

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

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

Method Detail

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

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

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

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