Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.ui.dialogs
Class SystemRemoteResourceDialog

java.lang.Object
  extended by 

org.eclipse.jface.window.Window
      extended by 

org.eclipse.jface.dialogs.Dialog
          extended by 

org.eclipse.rse.ui.dialogs.SystemPromptDialog
              extended by 
org.eclipse.rse.ui.dialogs.SystemRemoteResourceDialog
All Implemented Interfaces:
Runnable, IDialogPage, IRunnableContext, IShellProvider, ISystemPromptDialog, ISystemMessageLine, Listener
Direct Known Subclasses:
SystemRemoteFileDialog

public abstract class SystemRemoteResourceDialog
extends SystemPromptDialog


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
 
Constructor Summary
SystemRemoteResourceDialog ( Shell shell, String title, ISystemResourceSelectionInputProvider inputProvider)
           
 
Method Summary
protected   Control createInner ( Composite parent)
          Called by createContents method.
protected   ISystemMessageLine createMessageLine ( Composite c)
          Create message line.
protected   Control getInitialFocusControl ()
          Return the Control to be given initial focus.
  IHost getSelectedConnection ()
           
  Object getSelectedObject ()
          Return selected file or folder
  Object[] getSelectedObjects ()
          Return all selected objects.
  ISystemTree getSystemTree ()
          Returns the system tree
abstract   String getTreeTip ()
           
abstract   String getVerbiage ()
           
abstract   SystemActionViewerFilter getViewerFilter ()
           
 void initForm ()
           
 boolean isPageComplete ()
          Indicates whether the page for the form is complete or not.
protected  boolean processDetails (boolean hideMode)
          Private method.
protected  boolean processOK ()
          Private method.
 void setConnectionComboLabel ( String label)
          Sets the label for the connection combo in the form
 void setCustomViewerFilter ( SystemActionViewerFilter viewerFilter)
           
 void setDefaultSystemConnection ( IHost connection, boolean onlyConnection)
           
 void setMessage ( String message)
          Set the message shown at the top of the form
 void setMultipleSelectionMode (boolean multiple)
          Set multiple selection mode.
 void setPreSelection ( Object selection)
           
 void setSelectionTreeToolTipText ( String tip)
          Set the tooltip text for the remote systems tree from which an item is selected.
 void setSelectionValidator ( IValidatorRemoteSelection validator)
           
 void setShowNewConnectionPrompt (boolean showNewConnectionPrompt)
           
 void setShowPropertySheet (boolean show)
          Show the property sheet on the right hand side, to show the properties of the selected object.
 void setShowPropertySheet (boolean show, boolean initialState)
          Show the property sheet on the right hand side, to show the properties of the selected object.
 void setSystemTypes ( IRSESystemType[] types)
           
 
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, 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, setInputObject, 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
 

Constructor Detail

SystemRemoteResourceDialog

public SystemRemoteResourceDialog(
Shell shell,
                                  
String title,
                                  
ISystemResourceSelectionInputProvider inputProvider)
Since:
3.0 replaced SystemResourceSelectionInputProvider by ISystemResourceSelectionInputProvider
Method Detail

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

createMessageLine

protected 
ISystemMessageLine createMessageLine(
Composite c)
Create message line. Intercept so we can set msg line of form.

Overrides:
createMessageLine in class SystemPromptDialog

initForm

public void initForm()

setDefaultSystemConnection

public void setDefaultSystemConnection(
IHost connection,
                                       boolean onlyConnection)

setSystemTypes

public void setSystemTypes(
IRSESystemType[] types)

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

setPreSelection

public void setPreSelection(
Object selection)

setSelectionValidator

public void setSelectionValidator(
IValidatorRemoteSelection validator)

setCustomViewerFilter

public void setCustomViewerFilter(
SystemActionViewerFilter viewerFilter)

setMultipleSelectionMode

public void setMultipleSelectionMode(boolean multiple)
Set multiple selection mode. Default is single selection mode

If you turn on multiple selection mode, you must use the getSelectedObjects() method to retrieve the list of selected objects.

Further, if you turn this on, it has the side effect of allowing the user to select any remote object. The assumption being if you are prompting for files, you also want to allow the user to select a folder, with the meaning being that all files within the folder are implicitly selected.

See Also:
getSelectedObjects()

setMessage

public void setMessage(
String message)
Set the message shown at the top of the form

Specified by:
setMessage in interface ISystemMessageLine
Overrides:
setMessage in class SystemPromptDialog

setSelectionTreeToolTipText

public void setSelectionTreeToolTipText(
String tip)
Set the tooltip text for the remote systems tree from which an item is selected.


setShowPropertySheet

public void setShowPropertySheet(boolean show)
Show the property sheet on the right hand side, to show the properties of the selected object.

This overload always shows the property sheet

Default is false


setShowPropertySheet

public void setShowPropertySheet(boolean show,
                                 boolean initialState)
Show the property sheet on the right hand side, to show the properties of the selected object.

This overload shows a Details>>> button so the user can decide if they want to see the property sheet.

Parameters:
show - True if show the property sheet within the dialog
initialState - True if the property is to be initially displayed, false if it is not to be displayed until the user presses the Details button.

getSelectedObject

public 
Object getSelectedObject()
Return selected file or folder


getSelectedObjects

public 
Object[] getSelectedObjects()
Return all selected objects. This method will return an array of one unless you have called setMultipleSelectionMode(true)!

See Also:
setMultipleSelectionMode(boolean)

getSelectedConnection

public 
IHost getSelectedConnection()

processOK

protected boolean processOK()
Private method.

Called when user presses OK button. Return true to close dialog. Return false to not close dialog.

Overrides:
processOK in class SystemPromptDialog

setShowNewConnectionPrompt

public void setShowNewConnectionPrompt(boolean showNewConnectionPrompt)
Since:
3.0

processDetails

protected boolean processDetails(boolean hideMode)
Private method.

Called when user presses DETAILS button.

Note the text is automatically toggled for us! We need only do whatever the functionality is that we desire

Overrides:
processDetails in class SystemPromptDialog
Parameters:
hideMode - the current state of the details toggle, prior to this request. If we return true from this method, this state and the button text will be toggled.
Returns:
true if the details state toggle was successful, false if it failed.

getSystemTree

public 
ISystemTree getSystemTree()
Returns the system tree

Returns:
the system tree
Since:
3.0

isPageComplete

public boolean isPageComplete()
Indicates whether the page for the form is complete or not.

Returns:
true if the page associated with the form is complete
Since:
3.0

setConnectionComboLabel

public void setConnectionComboLabel(
String label)
Sets the label for the connection combo in the form

Since:
3.1

getViewerFilter

public abstract 
SystemActionViewerFilter getViewerFilter()

getVerbiage

public abstract 
String getVerbiage()

getTreeTip

public abstract 
String getTreeTip()

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire