|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.TrayDialog
org.eclipse.ui.dialogs.SelectionDialog
org.eclipse.ui.dialogs.SelectionStatusDialog
org.eclipse.ui.dialogs.AbstractElementListSelectionDialog
org.eclipse.ui.dialogs.TwoPaneElementSelector
public class TwoPaneElementSelector
A list selection dialog with two panes. Duplicated entries will be folded together and are displayed in the lower pane (qualifier).
| Nested Class Summary |
|---|
| Nested classes/interfaces 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 |
|---|
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS |
| 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,
java.lang.String name)
Creates a label if name was not null. |
protected Table |
createLowerList(Composite parent)
Creates the list widget and sets layout data. |
protected java.lang.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(java.lang.Object[] elements)
Sets the elements to be displayed. |
void |
setLowerListComparator(java.util.Comparator comparator)
Sets the comparator used to sort the list in the lower pane. |
void |
setLowerListLabel(java.lang.String label)
Sets the lower list label. |
protected void |
setLowerSelectedElement(java.lang.Object element)
Selects an element in the lower pane. |
void |
setUpperListLabel(java.lang.String label)
Sets the upper list label. |
protected boolean |
validateCurrentSelection()
Validates the current selection and updates the status line accordingly. |
| Methods inherited from class org.eclipse.ui.dialogs.AbstractElementListSelectionDialog |
|---|
cancelPressed, create, createFilteredList, createFilterText, createMessageArea, getFilter, getFoldedElements, getSelectedElements, getSelectionIndex, getSelectionIndices, getValidator, isCaseIgnored, open, setAllowDuplicates, setEmptyListMessage, setEmptySelectionMessage, setFilter, setIgnoreCase, setListElements, setMatchEmptyString, setMultipleSelection, setSelection, setSize, setValidator, updateOkState |
| 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, getDialogBoundsSettings, getDialogBoundsStrategy, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, isResizable, setDialogBoundsSettings, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle |
| Methods inherited from class org.eclipse.jface.dialogs.TrayDialog |
|---|
close, closeTray, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TwoPaneElementSelector(Shell parent,
ILabelProvider elementRenderer,
ILabelProvider qualifierRenderer)
parent - the parent shell.elementRenderer - the element renderer.qualifierRenderer - the qualifier renderer.| Method Detail |
|---|
public void setUpperListLabel(java.lang.String label)
null (default),
no label is created.
label - public void setLowerListLabel(java.lang.String label)
label - String or null. If the label is
null (default), no label is created.public void setLowerListComparator(java.util.Comparator comparator)
Note: the comparator might want to honor
AbstractElementListSelectionDialog.isCaseIgnored().
comparator - a Comparator or null if String's
comparison methods should be usedpublic void setElements(java.lang.Object[] elements)
elements - the elements to be displayed.public Control createDialogArea(Composite parent)
Dialog
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. This method must not modify the parent's
layout.
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;
createDialogArea in class Dialogparent - the parent composite to contain the dialog area
protected Label createLabel(Composite parent,
java.lang.String name)
null.
parent - the parent composite.name - the name of the label.
null
otherwise.protected Table createLowerList(Composite parent)
parent - the parent composite.
protected void computeResult()
SelectionStatusDialog
computeResult in class SelectionStatusDialogSelectionStatusDialog.computeResult()protected void handleDefaultSelected()
AbstractElementListSelectionDialog
handleDefaultSelected in class AbstractElementListSelectionDialogAbstractElementListSelectionDialog.handleDefaultSelected()protected void handleSelectionChanged()
AbstractElementListSelectionDialog
handleSelectionChanged in class AbstractElementListSelectionDialogAbstractElementListSelectionDialog.handleSelectionChanged()protected void setLowerSelectedElement(java.lang.Object element)
element - protected java.lang.Object getLowerSelectedElement()
protected void handleEmptyList()
AbstractElementListSelectionDialog
handleEmptyList in class AbstractElementListSelectionDialogprotected boolean validateCurrentSelection()
AbstractElementListSelectionDialog
validateCurrentSelection in class AbstractElementListSelectionDialogtrue if the current selection is
valid.AbstractElementListSelectionDialog.validateCurrentSelection()
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.