iSeries Remote Systems
v6.0.0

com.ibm.etools.iseries.core.ui.dialogs
Class ISeriesSaveFileTransferAndRestoreDialog

java.lang.Object
  extended byorg.eclipse.jface.window.Window
      extended byorg.eclipse.jface.dialogs.Dialog
          extended bycom.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
              extended bycom.ibm.etools.iseries.core.ui.dialogs.ISeriesSaveFileTransferAndRestoreDialog
All Implemented Interfaces:
EventListener, IDialogConstants, IDialogPage, IISeriesLibraryPromptListener, IISeriesObjectPromptListener, IRunnableContext, com.ibm.etools.systems.core.ui.messages.ISystemMessageLine, com.ibm.etools.systems.core.ui.dialogs.ISystemPromptDialog, Listener, ModifyListener, Runnable, SWTEventListener

public class ISeriesSaveFileTransferAndRestoreDialog
extends com.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
implements IISeriesObjectPromptListener, ModifyListener

This dialog is launched when user selects "Restore on iSeries..." on a .savf local file, and it prompts the user for the information we will need to do the action.


Nested Class Summary
 
Nested classes inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
 
Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
activeRunningOperations, ADD_BUTTON_NO, ADD_BUTTON_YES, ADD_ID, addButton, arrowCursor, BROWSE_BUTTON_NO, BROWSE_BUTTON_YES, BROWSE_ID, browseButton, buttonsComposite, cancelButton, cancelListener, copyright, DETAILS_BUTTON_NO, DETAILS_BUTTON_YES, DETAILS_ID, detailsButton, detailsButtonHideMode, detailsHideLabel, detailsShowLabel, dialogAreaComposite, dialogMnemonics, fMessageLine, helpId, horizontalSpacing, initialAddButtonEnabledState, initialDetailsButtonEnabledState, initialOKButtonEnabledState, inputObject, labelAdd, labelBrowse, labelCancel, labelDetailsHide, labelDetailsShow, labelOk, labelTest, marginHeight, marginWidth, minHeight, minWidth, needsProgressMonitor, okButton, okPressed, operationCancelableState, outputObject, outputObjectValidator, overallShell, pack, parentComposite, pendingErrorMessage, pendingMessage, progressMonitorPart, showAddButton, showBrowseButton, showDetailsButton, showOkButton, showTestButton, TEST_BUTTON_NO, TEST_BUTTON_YES, TEST_ID, testButton, tipAdd, tipBrowse, tipCancel, tipDetailsHide, tipDetailsShow, tipOk, tipTest, title, titleImage, verticalSpacing, waitCursor, windowClosingDialog
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, dialogArea, DLG_IMG_ERROR, 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 com.ibm.etools.iseries.core.ui.widgets.IISeriesObjectPromptListener
copyright
 
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
ISeriesSaveFileTransferAndRestoreDialog(Shell shell)
          Constructor
 
Method Summary
protected  Control createInner(Composite parent)
           
protected  Control getInitialFocusControl()
           
 String getRestoreLibraryName()
           
 int getSaveFileCommand()
          Gets the save file command.
 String getSaveFileLibraryName()
          Gets the library name of the save file.
 void libraryNameChanged(com.ibm.etools.systems.core.messages.SystemMessage errorMessage)
          The user has entered or selected text in the library entry field and it has been validated by the ISeriesLibraryPrompt.
 void modifyText(ModifyEvent e)
           
 void objectNameChanged(com.ibm.etools.systems.core.messages.SystemMessage errorMessage)
          The user has entered or selected text in the object entry field and it has been validated by the ISeriesObjectPrompt.
protected  boolean processOK()
          Called when user presses OK button.
 void setLocalFileName(String fullName, String name)
          Set the selected local file (eg, xxx.savf)
protected  com.ibm.etools.systems.core.messages.SystemMessage verify(boolean setFocus)
          Verify the contents of the dialog
 
Methods inherited from class com.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
aboutToStart, addFillerLine, addGrowableFillerLine, addSeparatorLine, adjustButtonWidth, applyMnemonics, buttonPressed, clearErrorMessage, clearMessage, close, configureShell, createButtonBar, createButtonsForButtonBar, createContents, createControl, createDialogArea, createMessageLine, createWizardClosingDialog, dispose, enableAddButton, enableBrowseButton, enableCancelButton, enableDetailsButton, enableOkButton, enableTestButton, getAddButton, getBrowseButton, 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, processDetails, processTest, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, restoreEnableState, restoreUIState, run, run, saveEnableStateAndSet, saveUIState, setAddButtonLabel, setAddButtonToolTipText, setBrowseButtonLabel, setBrowseButtonToolTipText, setBusyCursor, setCancelButtonLabel, setCancelButtonToolTipText, setControl, setDescription, setDetailsButtonLabel, setDetailsButtonToolTipText, setDisplayCursor, setDisplayCursor, setErrorMessage, setErrorMessage, setErrorMessage, setHelp, setHelp, setImageDescriptor, setInitialOKButtonEnabledState, setInputObject, setMessage, setMessage, setMinimumSize, setNeedsProgressMonitor, setOkButtonLabel, setOkButtonToolTipText, setOutputObject, setOutputObjectValidator, setPageComplete, setShowAddButton, setShowBrowseButton, setShowDetailsButton, setShowOkButton, setShowTestButton, setTestButtonLabel, setTestButtonToolTipText, setTitle, setVisible, wasCancelled
 
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, getImage, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getInitialLocation, getInitialSize, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

ISeriesSaveFileTransferAndRestoreDialog

public ISeriesSaveFileTransferAndRestoreDialog(Shell shell)
Constructor

Method Detail

setLocalFileName

public void setLocalFileName(String fullName,
                             String name)
Set the selected local file (eg, xxx.savf)


createInner

protected Control createInner(Composite parent)

getSaveFileCommand

public int getSaveFileCommand()
                       throws IOException
Gets the save file command.

Returns:
the save file command.
Throws:
IOException - if an I/O error occurs.

getSaveFileLibraryName

public String getSaveFileLibraryName()
                              throws IOException
Gets the library name of the save file.

Returns:
the save file library name.
Throws:
IOException - if an I/O error occurs.

getInitialFocusControl

protected Control getInitialFocusControl()

objectNameChanged

public void objectNameChanged(com.ibm.etools.systems.core.messages.SystemMessage errorMessage)
Description copied from interface: IISeriesObjectPromptListener
The user has entered or selected text in the object entry field and it has been validated by the ISeriesObjectPrompt.

Specified by:
objectNameChanged in interface IISeriesObjectPromptListener
Parameters:
errorMessage - Will be null if the input is valid, or a translated msg if not

libraryNameChanged

public void libraryNameChanged(com.ibm.etools.systems.core.messages.SystemMessage errorMessage)
Description copied from interface: IISeriesLibraryPromptListener
The user has entered or selected text in the library entry field and it has been validated by the ISeriesLibraryPrompt.

Specified by:
libraryNameChanged in interface IISeriesLibraryPromptListener
Parameters:
errorMessage - Will be null if the input is valid, or a translated msg if not

modifyText

public void modifyText(ModifyEvent e)
Specified by:
modifyText in interface ModifyListener

verify

protected com.ibm.etools.systems.core.messages.SystemMessage verify(boolean setFocus)
Verify the contents of the dialog


processOK

protected boolean processOK()
Called when user presses OK button. Return true to close dialog. Return false to not close dialog.


getRestoreLibraryName

public String getRestoreLibraryName()
Returns:
Returns the rstLibName.

iSeries Remote Systems
v6.0.0

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.