Eclipse RSE Development Guide (Galileo) - SystemSimpleCopyDialog (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.ui.dialogs
Class SystemSimpleCopyDialog


java.lang.Object
  

org.eclipse.jface.window.Window
      

org.eclipse.jface.dialogs.Dialog
          

org.eclipse.rse.ui.dialogs.SystemPromptDialog
              
org.eclipse.rse.ui.dialogs.SystemSimpleCopyDialog

All Implemented Interfaces:: Runnable, IDialogPage, IRunnableContext, ISelectionChangedListener, IShellProvider, ISystemPromptDialog, ISystemMessageLine, Listener

public class SystemSimpleCopyDialog
extends SystemPromptDialog
implements ISelectionChangedListener
extends SystemPromptDialog
implements ISelectionChangedListener

Dialog for selecting a target location on a copy operation.

Nested Class Summary

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

Window.IExceptionHandler

Field Summary

static int MODE_COPY


static int MODE_MOVE


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

SystemSimpleCopyDialog ( Shell shell, String prompt, int mode, ISystemCopyTargetSelectionCallback caller, SystemSimpleContentElement copyTreeContent, SystemSimpleContentElement selection)
          Constructor

Method Summary

void clearSelection ()


boolean close ()


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.

SystemSimpleContentElement getSelectedElement ()
          Return current selection

Object getTargetContainer ()
          Get the selected target container

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.

boolean isSelectionEmpty ()
          Return true if something selected

protected boolean processOK ()
          Called when user presses OK button.

void selectionChanged ( SelectionChangedEvent event)
          ISelectionChangedListener method.

void setPageComplete ()
          Inform caller of page-complete status of this form

boolean verify ()
          Verifies all input.

Methods inherited from class org.eclipse.rse.ui.dialogs. SystemPromptDialog

aboutToStart, addFillerLine, addGrowableFillerLine, addSeparatorLine, adjustButtonWidth, applyMnemonics, buttonPressed, clearErrorMessage, clearMessage, 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, setInputObject, 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

Field Detail

MODE_COPY

public static final int MODE_COPY

See Also:: Constant Field Values

MODE_MOVE

public static final int MODE_MOVE

See Also:: Constant Field Values

Constructor Detail

SystemSimpleCopyDialog

public SystemSimpleCopyDialog(
Shell shell,
                              
String prompt,
                              int mode,
                              
ISystemCopyTargetSelectionCallback caller,
                              
SystemSimpleContentElement copyTreeContent,
                              
SystemSimpleContentElement selection)

Constructor

Method Detail

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)

ISelectionChangedListener method. Called when user changes selection in tree

Specified by:: selectionChanged in interface ISelectionChangedListener

getSelectedElement

public 
SystemSimpleContentElement getSelectedElement()

Return current selection

isSelectionEmpty

public boolean isSelectionEmpty()

Return true if something selected

clearSelection

public void clearSelection()

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

close

public boolean close()

Overrides:: close 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

getTargetContainer

public 
Object getTargetContainer()

Get the selected target container