| |
org.eclipse.rse.ui.dialogs
Class SystemSimpleSelectDialog
java.lang.Object
org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.rse.ui.dialogs.SystemPromptDialog
org.eclipse.rse.ui.dialogs.SystemSimpleSelectDialog
-
All Implemented Interfaces:
-
Runnable,
IDialogPage,
IRunnableContext,
ICheckStateListener,
IShellProvider,
ISystemPromptDialog,
ISystemMessageLine,
Listener
-
public class SystemSimpleSelectDialog
- extends
SystemPromptDialog
- implements
ICheckStateListener
Dialog that uses a checkbox tree viewer to prompt users to select hierarchical items.
Works in concert with
SystemSimpleContentElement
and
SystemSimpleContentProvider.
The
setInputObject(SystemSimpleContentElement) method is used to populate the selection tree:
- The passed object must be of type SystemSimpleContentElement
- The method getChildren will be called on that object to get initial visible elements
- As user expands each item, getChildren() is progressively called
- The initial selection state of each item is determined by calling isSelected on that item
The trick to using this is to first populate a hierarchy of SystemSimpleContentElement elements,
each one wrapping one of your own model objects, and then passing to this constructor the root
element.
Upon successful completion of this dialog (wasCancelled() returns false), the model is
updated to reflect the selections. Call getUpdatedContent() to return the root node, if need be,
and then walk the nodes. The selected items are those that return true
to
SystemSimpleContentElement.isSelected().
-
See Also:
-
SystemSimpleContentElement,
SystemSimpleContentProvider
|
Fields inherited from class org.eclipse.rse.ui.dialogs.
SystemPromptDialog
|
activeRunningOperations,
ADD_BUTTON_NO,
ADD_BUTTON_YES,
ADD_ID,
addButton,
arrowCursor,
BROWSE_BUTTON_NO,
BROWSE_BUTTON_YES,
BROWSE_ID,
browseButton,
buttonsComposite,
CANCEL_ALL_ID,
cancelAllButton,
cancelAllPressed,
cancelButton,
cancelListener,
DETAILS_BUTTON_NO,
DETAILS_BUTTON_YES,
DETAILS_ID,
detailsButton,
detailsButtonHideMode,
detailsHideLabel,
detailsShowLabel,
dialogAreaComposite,
dialogMnemonics,
fMessageLine,
helpId,
horizontalSpacing,
initialAddButtonEnabledState,
initialDetailsButtonEnabledState,
initialOKButtonEnabledState,
inputObject,
labelAdd,
labelBrowse,
labelCancel,
labelCancelAll,
labelDetailsHide,
labelDetailsShow,
labelOk,
labelTest,
marginHeight,
marginWidth,
minHeight,
minWidth,
needsProgressMonitor,
noShowAgainButton,
noShowAgainOption,
okButton,
okPressed,
operationCancelableState,
outputObject,
outputObjectValidator,
overallShell,
pack,
parentComposite,
pendingErrorMessage,
pendingMessage,
prefId,
prefStore,
prefValAsSelected,
progressMonitorPart,
showAddButton,
showBrowseButton,
showCancelAllButton,
showDetailsButton,
showOkButton,
showTestButton,
TEST_BUTTON_NO,
TEST_BUTTON_YES,
TEST_ID,
testButton,
tipAdd,
tipBrowse,
tipCancel,
tipCancelAll,
tipDetailsHide,
tipDetailsShow,
tipOk,
tipTest,
title,
titleImage,
verticalSpacing,
waitCursor,
windowClosingDialog
|
|
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
|
|
Methods inherited from class org.eclipse.rse.ui.dialogs.
SystemPromptDialog
|
aboutToStart,
addFillerLine,
addGrowableFillerLine,
addSeparatorLine,
adjustButtonWidth,
applyMnemonics,
buttonPressed,
clearErrorMessage,
clearMessage,
close,
configureShell,
createButtonBar,
createButtonsForButtonBar,
createContents,
createControl,
createDialogArea,
createNoShowAgainButton,
createWizardClosingDialog,
dispose,
enableAddButton,
enableBrowseButton,
enableCancelAllButton,
enableCancelButton,
enableDetailsButton,
enableOkButton,
enableTestButton,
getAddButton,
getBrowseButton,
getCancelAllButton,
getCancelOrCloseButton,
getControl,
getDescription,
getDetailsButton,
getDialogMnemonics,
getErrorMessage,
getHelpContextId,
getImage,
getInputObject,
getMessage,
getMessageLine,
getOkButton,
getOutputObject,
getOutputObjectValidator,
getProgressMonitor,
getSystemErrorMessage,
getTestButton,
getTitle,
handleEvent,
hardClose,
okToClose,
performHelp,
processAdd,
processBrowse,
processCancel,
processCancelAll,
processDetails,
processTest,
publicConvertHeightInCharsToPixels,
publicConvertWidthInCharsToPixels,
restoreEnableState,
restoreUIState,
run,
run,
saveEnableStateAndSet,
saveUIState,
setAddButtonLabel,
setAddButtonToolTipText,
setBrowseButtonLabel,
setBrowseButtonToolTipText,
setBusyCursor,
setCancelAllButtonLabel,
setCancelAllButtonToolTipText,
setCancelButtonLabel,
setCancelButtonToolTipText,
setControl,
setDescription,
setDetailsButtonLabel,
setDetailsButtonToolTipText,
setDisplayCursor,
setDisplayCursor,
setErrorMessage,
setErrorMessage,
setErrorMessage,
setHelp,
setHelp,
setImageDescriptor,
setInitialOKButtonEnabledState,
setMessage,
setMessage,
setMinimumSize,
setNeedsProgressMonitor,
setNoShowAgainOption,
setOkButtonLabel,
setOkButtonToolTipText,
setOutputObject,
setOutputObjectValidator,
setPageComplete,
setShowAddButton,
setShowBrowseButton,
setShowCancelAllButton,
setShowDetailsButton,
setShowOkButton,
setShowTestButton,
setTestButtonLabel,
setTestButtonToolTipText,
setTitle,
setVisible,
wasCancelled,
wasCancelledAll
|
|
Methods inherited from class org.eclipse.jface.dialogs.
Dialog
|
applyDialogFont,
cancelPressed,
convertHeightInCharsToPixels,
convertHeightInCharsToPixels,
convertHorizontalDLUsToPixels,
convertHorizontalDLUsToPixels,
convertVerticalDLUsToPixels,
convertVerticalDLUsToPixels,
convertWidthInCharsToPixels,
convertWidthInCharsToPixels,
create,
createButton,
dialogFontIsDefault,
getBlockedHandler,
getButton,
getButtonBar,
getCancelButton,
getDialogArea,
getDialogBoundsSettings,
getDialogBoundsStrategy,
getImage,
getInitialLocation,
getInitialSize,
getOKButton,
initializeBounds,
initializeDialogUnits,
isResizable,
okPressed,
setBlockedHandler,
setButtonLayoutData,
setButtonLayoutFormData,
shortenText
|
|
Methods inherited from class org.eclipse.jface.window.
Window
|
canHandleShellCloseEvent,
constrainShellSize,
createShell,
getConstrainedShellBounds,
getContents,
getDefaultImage,
getDefaultImages,
getDefaultOrientation,
getLayout,
getParentShell,
getReturnCode,
getShell,
getShellListener,
getShellStyle,
getWindowManager,
handleFontChange,
handleShellCloseEvent,
open,
setBlockOnOpen,
setDefaultImage,
setDefaultImages,
setDefaultModalParent,
setDefaultOrientation,
setExceptionHandler,
setParentShell,
setReturnCode,
setShellStyle,
setWindowManager
|
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
SystemSimpleSelectDialog
public SystemSimpleSelectDialog(
Shell shell,
String title,
String prompt)
- Constructor
setRootToPreselect
public void setRootToPreselect(
SystemSimpleContentElement preSelectedRoot)
- Set the root to preselect
-
-
createMessageLine
protected
ISystemMessageLine createMessageLine(
Composite c)
- Create message line. Intercept so we can set msg line of form.
-
-
Overrides:
-
createMessageLine
in class
SystemPromptDialog
-
getInitialFocusControl
protected
Control getInitialFocusControl()
-
Description copied from class:
SystemPromptDialog
- Return the Control to be given initial focus.
Child classes must override this, but can return null.
-
-
Specified by:
-
getInitialFocusControl
in class
SystemPromptDialog
-
-
See Also:
-
SystemPromptDialog.getInitialFocusControl()
createInner
protected
Control createInner(
Composite parent)
-
Description copied from class:
SystemPromptDialog
- Called by createContents method.
Create this dialog's widgets inside a composite.
Child classes must override this.
-
-
Specified by:
-
createInner
in class
SystemPromptDialog
-
-
See Also:
-
SystemPromptDialog.createInner(Composite)
checkStateChanged
public void checkStateChanged(
CheckStateChangedEvent event)
- ICheckStateChangedListener method. Called when user changes selection in tree
-
-
Specified by:
-
checkStateChanged
in interface
ICheckStateListener
-
setInputObject
public void setInputObject(
Object inputObject)
- Override of parent. We only support a specific type of input, so we test for it and
throw it out if we don't get it. This is necessary to defeat some default action.
Called by SystemDialogAction's default run() method after dialog instantiated.
-
-
Specified by:
-
setInputObject
in interface
ISystemPromptDialog
-
Overrides:
-
setInputObject
in class
SystemPromptDialog
-
setInputObject
public void setInputObject(
SystemSimpleContentElement inputObject)
- Override of parent. Must pass selected object onto the form for initializing fields.
Called by SystemDialogAction's default run() method after dialog instantiated.
-
-
getShouldBeGrayed
public boolean getShouldBeGrayed(
SystemSimpleContentElement parent)
- Dynamically determine grayed state of parent element
-
-
getShouldBeChecked
public boolean getShouldBeChecked(
SystemSimpleContentElement parent)
- Dynamically determine checked state of parent element
-
-
getUpdatedContent
public
SystemSimpleContentElement getUpdatedContent()
- Return updated input model
-
-
processOK
protected boolean processOK()
- Called when user presses OK button.
Return true to close dialog.
Return false to not close dialog.
-
-
Overrides:
-
processOK
in class
SystemPromptDialog
-
verify
public boolean verify()
- Verifies all input.
-
-
-
Returns:
- true if there are no errors in the user input
isPageComplete
public boolean isPageComplete()
- This method can be called by the dialog or wizard page host, to decide whether to enable
or disable the next, final or ok buttons. It returns true if the minimal information is
available and is correct.
-
-
setPageComplete
public void setPageComplete()
- Inform caller of page-complete status of this form
-
-
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.
|
|
