org.eclipse.ui.dialogs
Class TwoPaneElementSelector

java.lang.Object
  |
  +--org.eclipse.jface.window.Window
        |
        +--org.eclipse.jface.dialogs.Dialog
              |
              +--org.eclipse.ui.dialogs.SelectionDialog
                    |
                    +--org.eclipse.ui.dialogs.SelectionStatusDialog
                          |
                          +--org.eclipse.ui.dialogs.AbstractElementListSelectionDialog
                                |
                                +--org.eclipse.ui.dialogs.TwoPaneElementSelector

public class TwoPaneElementSelector

extends AbstractElementListSelectionDialog

A list selection dialog with two panes. Duplicated entries will be folded together and are displayed in the lower pane (qualifier).

Since:

2.0

Nested Class Summary

Nested classes inherited from class org.eclipse.jface.window.Window

Window.IExceptionHandler

Field Summary

Fields inherited from class org.eclipse.ui.dialogs.AbstractElementListSelectionDialog

fFilteredList

Fields inherited from class org.eclipse.jface.dialogs.Dialog

DLG_IMG_ERROR, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Constructor Summary

TwoPaneElementSelector(Shell parent, ILabelProvider elementRenderer, ILabelProvider qualifierRenderer)
Creates the two pane element selector.

Method Summary

protected void	computeResult() Compute the result and return it.
Control	createDialogArea(Composite parent) Creates and returns the contents of the upper part of this dialog (above the button bar).
protected Label	createLabel(Composite parent, String name) Creates a label if name was not null.
protected Table	createLowerList(Composite parent) Creates the list widget and sets layout data.
protected Object	getLowerSelectedElement() Returns the selected element from the lower pane.
protected void	handleDefaultSelected() Handles default selection (double click).
protected void	handleEmptyList() Handles empty list by disabling widgets.
protected void	handleSelectionChanged() Handles a selection changed event.
void	setElements(Object[] elements) Sets the elements to be displayed.
void	setLowerListLabel(String label) Sets the lower list label.
protected void	setLowerSelectedElement(Object element) Selects an element in the lower pane.
void	setUpperListLabel(String label) Sets the upper list label.

Methods inherited from class org.eclipse.ui.dialogs.AbstractElementListSelectionDialog

cancelPressed, create, createFilteredList, createFilterText, createMessageArea, getFilter, getFoldedElements, getSelectedElements, getSelectionIndex, getSelectionIndices, isCaseIgnored, open, setAllowDuplicates, setEmptyListMessage, setEmptySelectionMessage, setFilter, setIgnoreCase, setListElements, setMatchEmptyString, setMultipleSelection, setSelection, setSize, setValidator, validateCurrentSelection

Methods inherited from class org.eclipse.ui.dialogs.SelectionStatusDialog

configureShell, createButtonBar, getFirstResult, okPressed, setImage, setResult, setStatusLineAboveButtons, updateButtonsEnableState, updateStatus

Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog

createButtonsForButtonBar, getInitialSelections, getMessage, getOkButton, getResult, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle

Methods inherited from class org.eclipse.jface.dialogs.Dialog

buttonPressed, constrainShellSize, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createContents, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeDialogUnits

Methods inherited from class org.eclipse.jface.window.Window

close, createShell, getContents, getDefaultImage, getInitialLocation, getInitialSize, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, initializeBounds, setBlockOnOpen, setDefaultImage, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

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

Constructor Detail

TwoPaneElementSelector

public TwoPaneElementSelector(Shell parent,
                              ILabelProvider elementRenderer,
                              ILabelProvider qualifierRenderer)

Creates the two pane element selector.

Parameters:

elementRenderer - the element renderer.

Method Detail

setUpperListLabel

public void setUpperListLabel(String label)

Sets the upper list label. If the label is null (default), no label is created.

setLowerListLabel

public void setLowerListLabel(String label)

Sets the lower list label. If the label is null (default), no label is created.

setElements

public void setElements(Object[] elements)

Sets the elements to be displayed.

Parameters:

elements - the elements to be displayed.

createDialogArea

public Control createDialogArea(Composite parent)

Description copied from class: Dialog

Creates and returns the contents of the upper part of this dialog (above the button bar).

The Dialog implementation of this framework method creates and returns a new Composite with standard margins and spacing.

The returned control's layout data must be an instance of GridData.

Subclasses must override this method but may call super as in the following example:

 	Composite composite = (Composite)super.createDialogArea(parent);
 	//add controls to composite as necessary
 	return composite;
 

Overrides:

createDialogArea in class Dialog

Parameters:

parent - the parent composite to contain the dialog area

Returns:

the dialog area control

See Also:

Dialog#createDialogArea(Composite)

createLabel

protected Label createLabel(Composite parent,
                            String name)

Creates a label if name was not null.

Parameters:

parent - the parent composite.

name - the name of the label.

Returns:

returns a label if a name was given, null otherwise.

createLowerList

protected Table createLowerList(Composite parent)

Creates the list widget and sets layout data.

Parameters:

parent - the parent composite.

Returns:

returns the list table widget.

computeResult

protected void computeResult()

Description copied from class: SelectionStatusDialog

Compute the result and return it.

Specified by:

computeResult in class SelectionStatusDialog

See Also:

SelectionStatusDialog.computeResult()

handleDefaultSelected

protected void handleDefaultSelected()

Description copied from class: AbstractElementListSelectionDialog

Handles default selection (double click). By default, the OK button is pressed.

Overrides:

handleDefaultSelected in class AbstractElementListSelectionDialog

See Also:

AbstractElementListSelectionDialog.handleDefaultSelected()

handleSelectionChanged

protected void handleSelectionChanged()

Description copied from class: AbstractElementListSelectionDialog

Handles a selection changed event. By default, the current selection is validated.

Overrides:

handleSelectionChanged in class AbstractElementListSelectionDialog

See Also:

AbstractElementListSelectionDialog.handleSelectionChanged()

setLowerSelectedElement

protected void setLowerSelectedElement(Object element)

Selects an element in the lower pane.

getLowerSelectedElement

protected Object getLowerSelectedElement()

Returns the selected element from the lower pane.

handleEmptyList

protected void handleEmptyList()

Description copied from class: AbstractElementListSelectionDialog

Handles empty list by disabling widgets.

Overrides:

handleEmptyList in class AbstractElementListSelectionDialog