org.eclipse.eavp.viz.service.widgets

Class TreeSelectionDialogProvider

java.lang.Object

org.eclipse.eavp.viz.service.widgets.TreeSelectionDialogProvider

public class TreeSelectionDialogProvider
extends java.lang.Object

This class can be used to create a dialog for selecting leaf elements from a tree.

To set up a dialog, instantiate a provider. You must override the following methods as would normally be done for a JFace content or label provider:

• getChildren(Object)
• getText(Object)
• isSelected(Object)

You may now open the dialog by calling openDialog(Shell, Object, boolean).

To get the results of the selection after OK has been pressed, the provider has the following methods:

• getAllSelectedLeafElements()
• getSelectedLeafElements()
• getUnselectedLeafElements()

Author:

Jordan

Constructor Summary

Constructors

Constructor and Description
TreeSelectionDialogProvider()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getAllSelectedLeafElements() Gets all selected leaf nodes in the tree.
java.lang.Object[]	getChildren(java.lang.Object parent) Gets the children of the specified element.
java.util.List<java.lang.Object>	getSelectedLeafElements() Gets all newly selected leaf nodes in the tree.
java.lang.String	getText(java.lang.Object element) Gets the text label for the element.
java.util.List<java.lang.Object>	getUnselectedLeafElements() Gets all leaf nodes that were unselected from the tree.
boolean	isSelected(java.lang.Object element) Whether or not the element is selected.
int	openDialog(org.eclipse.swt.widgets.Shell shell, java.lang.Object input, boolean allowMultipleSelections) Creates and opens a dialog enabling the user to select one or more elements from the specified input tree.
void	setMessage(java.lang.String message) Sets the message to display in the created dialog.
void	setTitle(java.lang.String title) Sets the title to display in the created dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeSelectionDialogProvider

public TreeSelectionDialogProvider()

Method Detail

getAllSelectedLeafElements

public java.util.List<java.lang.Object> getAllSelectedLeafElements()

Gets all selected leaf nodes in the tree.

Returns:

A list containing all selected leaf nodes in the tree.

getChildren

public java.lang.Object[] getChildren(java.lang.Object parent)

Gets the children of the specified element.

Note: Cycles are prohibited and may cause unexpected results.

Parameters:

parent - The element that may or may not have children that will also be put in the tree.

Returns:

An array containing all child elements that will be put in the tree.

getSelectedLeafElements

public java.util.List<java.lang.Object> getSelectedLeafElements()

Gets all newly selected leaf nodes in the tree. This does not include nodes that were selected when the dialog was opened.

Returns:

A list containing newly selected leaf nodes in the tree.

getText

public java.lang.String getText(java.lang.Object element)

Gets the text label for the element.

Parameters:

element - The element that will be put in the tree.

Returns:

A string label for the element.

getUnselectedLeafElements

public java.util.List<java.lang.Object> getUnselectedLeafElements()

Gets all leaf nodes that were unselected from the tree. In other words, this returns all nodes that were part of the initial selection but were at some point unselected by the user.

Returns:

A list containing nodes that were unselected from the tree.

isSelected

public boolean isSelected(java.lang.Object element)

Whether or not the element is selected.

Parameters:

element - The element that will be put in the tree.

Returns:

True if the element is selected, false otherwise.

openDialog

public int openDialog(org.eclipse.swt.widgets.Shell shell,
                      java.lang.Object input,
                      boolean allowMultipleSelections)

Creates and opens a dialog enabling the user to select one or more elements from the specified input tree.

Parameters:

shell - The parent shell for the dialog.

input - The input for the dialog's tree.

allowMultipleSelections - Whether or not to allow multiple items to be selected. If false, then only one item may be selected from the tree, otherwise the tree's selection will be determined by checkboxes.

Returns:

The result of the dialog, usually either Window.OK or Window.CANCEL.

setMessage

public void setMessage(java.lang.String message)

Sets the message to display in the created dialog. This appears above the tree.

Parameters:

message - The new message.

setTitle

public void setTitle(java.lang.String title)

Sets the title to display in the created dialog.

Parameters:

title - The new title.