org.eclipse.rse.ui.dialogs
Class SystemRenameDialog

java.lang.Object
  org.eclipse.jface.window.Window
      org.eclipse.jface.dialogs.Dialog
          org.eclipse.rse.ui.dialogs.SystemPromptDialog
              org.eclipse.rse.ui.dialogs.SystemRenameDialog

All Implemented Interfaces:

Runnable, EventListener, IDialogConstants, IDialogPage, IRunnableContext, ICellEditorListener, ISelectionChangedListener, IShellProvider, ISystemPromptDialog, ISystemMessageLine, FocusListener, TraverseListener, org.eclipse.swt.internal.SWTEventListener, Listener

public class SystemRenameDialog
extends SystemPromptDialog
implements ISelectionChangedListener, TraverseListener, ICellEditorListener, Runnable, FocusListener

Dialog for renaming multiple resources.

This is a re-usable dialog that you can use directly, or via the SystemCommonRenameAction action.

To use this dialog, you must call setInputObject with a StructuredSelection of the objects to be renamed. If those objects adapt to ISystemRemoteElementAdapter or ISystemRemoteElementAdapter, the dialog will offer built-in error checking.

If the input objects do not adapt to org.eclipse.rse.ui.view.ISystemRemoteElementAdapter or ISystemViewElementAdapter, then you should call setNameValidator(org.eclipse.rse.ui.validators.ISystemValidator) to specify a validator that is called to verify the typed new name is valid. Further, to show the type value of the input objects, they should implement ISystemTypedObject.

This dialog does not do the actual renames. Rather, it will return an array of the user-typed new names. These are queriable via getNewNames(), after testing that SystemPromptDialog.wasCancelled() is false. The array entries will match the input order.

See Also:

SystemCommonRenameAction

Nested Class Summary

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

Window.IExceptionHandler

Field Summary

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

Fields inherited from interface org.eclipse.jface.dialogs.IDialogConstants

ABORT_ID, ABORT_LABEL, BACK_ID, BACK_LABEL, BUTTON_BAR_HEIGHT, BUTTON_HEIGHT, BUTTON_MARGIN, BUTTON_WIDTH, CANCEL_ID, CANCEL_LABEL, CLIENT_ID, CLOSE_ID, CLOSE_LABEL, DESELECT_ALL_ID, ENTRY_FIELD_WIDTH, FINISH_ID, FINISH_LABEL, HELP_ID, HELP_LABEL, HIDE_DETAILS_LABEL, HORIZONTAL_MARGIN, HORIZONTAL_SPACING, IGNORE_ID, IGNORE_LABEL, INDENT, INTERNAL_ID, LEFT_MARGIN, MINIMUM_MESSAGE_AREA_WIDTH, NEXT_ID, NEXT_LABEL, NO_ID, NO_LABEL, NO_TO_ALL_ID, NO_TO_ALL_LABEL, OK_ID, OK_LABEL, OPEN_ID, OPEN_LABEL, PROCEED_ID, PROCEED_LABEL, RETRY_ID, RETRY_LABEL, SELECT_ALL_ID, SELECT_TYPES_ID, SHOW_DETAILS_LABEL, SKIP_ID, SKIP_LABEL, SMALL_INDENT, STOP_ID, STOP_LABEL, VERTICAL_MARGIN, VERTICAL_SPACING, YES_ID, YES_LABEL, YES_TO_ALL_ID, YES_TO_ALL_LABEL

Constructor Summary

SystemRenameDialog(Shell shell)
Constructor for SystemRenameDialog

SystemRenameDialog(Shell shell, String title)
Constructor when you have your own title

Method Summary

void	applyEditorValue()
void	cancelEditor()
protected Control	createInner(Composite parent) Called by createContents method.
protected ISystemMessageLine	createMessageLine(Composite c) Create message line.
void	editorValueChanged(boolean oldValidState, boolean newValidState)
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
protected Control	getInitialFocusControl() Return the Control to be given initial focus.
String[]	getNewNames() Returns an array of the new names.
protected ISystemRemoteElementAdapter	getRemoteAdapter(Object o) Returns the implementation of ISystemRemoteElement for the given object.
SystemRenameTableRow[]	getRows() Returns the rows of rename items.
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.
void	keyTraversed(TraverseEvent e) Required by TraverseListener.
protected boolean	processOK() Called when user presses OK button.
void	run() Runnable method
void	selectionChanged(SelectionChangedEvent event)
void	setInputObject(Object inputObject) Override of parent.
void	setNameValidator(ISystemValidator nameValidator) Set the validator for the new name,as supplied by the adaptor for name checking.
void	setPageComplete() Inform caller of page-complete status of this form
protected ValidatorUniqueString	setUniqueNameValidator(Object inputElement, ISystemValidator nameValidator) Given an input element and externally-suppplied name validator for it, determine if we need to augment that validator with one that will check for uniqueness, and if so create and register that uniqueness validator
void	setVerbiage(String verbiage) Set the verbiage to show above the table.
protected SystemMessage	validateNameInput() This hook method is called whenever the text changes in the input field.
boolean	verify() Verifies all input.

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, pack, performHelp, processAdd, processBrowse, processCancel, processCancelAll, processDetails, processTest, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, restoreEnableState, restoreUIState, 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, 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

Constructor Detail

SystemRenameDialog

public SystemRenameDialog(Shell shell)

Constructor for SystemRenameDialog

SystemRenameDialog

public SystemRenameDialog(Shell shell,
                          String title)

Constructor when you have your own title

Method Detail

setVerbiage

public void setVerbiage(String verbiage)

Set the verbiage to show above the table. The default is "Enter new name for each resource"

setNameValidator

public void setNameValidator(ISystemValidator nameValidator)

Set the validator for the new name,as supplied by the adaptor for name checking. Overrides the default which is to query it from the object's adapter.

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)

selectionChanged

public void selectionChanged(SelectionChangedEvent event)

Specified by:

selectionChanged in interface ISelectionChangedListener

setInputObject

public void setInputObject(Object inputObject)

Override of parent. Must pass selected object onto the form for initializing fields. Called by SystemDialogAction's default run() method after dialog instantiated.

Specified by:

setInputObject in interface ISystemPromptDialog

Overrides:

setInputObject in class SystemPromptDialog

processOK

protected boolean processOK()

Called when user presses OK button. This does not do the actual renames, but rather updates the new name array. You need to query this via getNewNames(), after ensuring the dialog was not cancelled by calling SystemPromptDialog.wasCancelled().

Overrides:

processOK in class SystemPromptDialog

verify

public boolean verify()

Verifies all input.

Returns:

true if there are no errors in the user input

validateNameInput

protected SystemMessage validateNameInput()

This hook method is called whenever the text changes in the input field. The default implementation delegates the request to an ISystemValidator object. If the ISystemValidator reports an error the error message is displayed in the Dialog's message line.

See Also:

setNameValidator(ISystemValidator)

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

keyTraversed

public void keyTraversed(TraverseEvent e)

Required by TraverseListener. We want to know when the tab key is pressed so we can give edit focus to the next name

Specified by:

keyTraversed in interface TraverseListener

getRows

public SystemRenameTableRow[] getRows()

Returns the rows of rename items.

getNewNames

public String[] getNewNames()

Returns an array of the new names.

applyEditorValue

public void applyEditorValue()

Specified by:

applyEditorValue in interface ICellEditorListener

cancelEditor

public void cancelEditor()

Specified by:

cancelEditor in interface ICellEditorListener

editorValueChanged

public void editorValueChanged(boolean oldValidState,
                               boolean newValidState)

Specified by:

editorValueChanged in interface ICellEditorListener

run

public void run()

Runnable method

Specified by:

run in interface Runnable

Overrides:

run in class SystemPromptDialog

setUniqueNameValidator

protected ValidatorUniqueString setUniqueNameValidator(Object inputElement,
                                                       ISystemValidator nameValidator)

Given an input element and externally-suppplied name validator for it, determine if we need to augment that validator with one that will check for uniqueness, and if so create and register that uniqueness validator

getRemoteAdapter

protected ISystemRemoteElementAdapter getRemoteAdapter(Object o)

Returns the implementation of ISystemRemoteElement for the given object. Returns null if this object does not adaptable to this.

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener