org.eclipse.rse.files.ui.propertypages
Class SystemAbstractRemoteFilePropertyPageExtensionAction

java.lang.Object
  org.eclipse.jface.dialogs.DialogPage
      org.eclipse.jface.preference.PreferencePage
          org.eclipse.ui.dialogs.PropertyPage
              org.eclipse.rse.ui.propertypages.SystemBasePropertyPage
                  org.eclipse.rse.ui.propertypages.SystemAbstractPropertyPageExtensionAction
                      org.eclipse.rse.files.ui.propertypages.SystemAbstractRemoteFilePropertyPageExtensionAction

All Implemented Interfaces:

IDialogPage, IMessageProvider, IPreferencePage, ISystemMessageLine, ISystemMessageLineTarget, IWorkbenchPropertyPage

public abstract class SystemAbstractRemoteFilePropertyPageExtensionAction

extends SystemAbstractPropertyPageExtensionAction

implements IWorkbenchPropertyPage

This is a base class to simplify the creation of property pages supplied via the org.eclipse.rse.ui.propertyPages extension point, targeting remote files and/or remote folders.

The only method you must implement is createContentArea(Composite).

The benefits of this class are:

• From SystemBasePropertyPage: Adds a message line and ISystemMessageLine message methods.
• From SystemBasePropertyPage: Automatically assigns mnemonics to controls on this page, simplifying this common task. See {#wantMnemonics()}.
• From SystemBasePropertyPage: For pages with input controls, simplifies the page validation burden: only one method need be overridden: verifyPageContents()
• From SystemBasePropertyPage: If no Default and Apply buttons wanted, the area reserved for this is removed, removing extra white space.
• Supplies helper method getRemoteFile() for querying the selected remote file/folder.
• Supplies helper methods to query the file-subsystem and connection containing the selected remote file.

Field Summary

Fields inherited from class org.eclipse.rse.ui.propertypages.SystemAbstractPropertyPageExtensionAction

EMPTY_ARRAY

Fields inherited from class org.eclipse.rse.ui.propertypages.SystemBasePropertyPage

buttonsComposite, contentArea, msgLine, msgLineSet

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

SystemAbstractRemoteFilePropertyPageExtensionAction()
Constructor

Method Summary

protected abstract Control	createContentArea(Composite parent) Abstract.
IRemoteFile	getRemoteFile() Retrieve the input selected object, as an IRemoteFile, for convenience.
IRemoteFileSubSystem	getRemoteFileSubSystem() Get the remote file subsystem from which the selected objects were resolved.
IRemoteFileSubSystemConfiguration	getRemoteFileSubSystemConfiguration() Returns the remote file subsystem factory which owns the subsystem from which the selected remote objects were resolved.
protected boolean	verifyPageContents() You may override if your page has input fields.

Methods inherited from class org.eclipse.rse.ui.propertypages.SystemAbstractPropertyPageExtensionAction

createTestComposite, getRemoteAdapter, getRemoteAdapter, getRemoteObject, getRemoteObjectName, getRemoteObjectSubSubType, getRemoteObjectSubSystemConfigurationId, getRemoteObjectSubType, getRemoteObjectType, getRemoteObjectTypeCategory, getSubSystem, getSubSystemConfiguration, getSystemConnection

Methods inherited from class org.eclipse.rse.ui.propertypages.SystemBasePropertyPage

addFillerLine, addSeparatorLine, clearErrorMessage, clearMessage, configureMessageLine, contributeButtons, createContents, createLabeledCombo, createLabeledLabel, createLabeledText, createLabeledVerbage, getMessageLine, getSystemErrorMessage, grabExcessSpace, okToLeave, performOk, setBusyCursor, setErrorMessage, setErrorMessage, setErrorMessage, setHelp, setMessage, setMessage, setMessageLine, wantAutomaticValidManagement, wantDefaultAndApplyButton, wantMnemonics

Methods inherited from class org.eclipse.ui.dialogs.PropertyPage

getElement, setElement

Methods inherited from class org.eclipse.jface.preference.PreferencePage

applyData, applyDialogFont, computeSize, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, performApply, performCancel, performDefaults, performHelp, setContainer, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton

Methods inherited from class org.eclipse.jface.dialogs.DialogPage

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.ui.IWorkbenchPropertyPage

getElement, setElement

Methods inherited from interface org.eclipse.jface.preference.IPreferencePage

computeSize, isValid, okToLeave, performCancel, performOk, setContainer, setSize

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible

Methods inherited from interface org.eclipse.rse.ui.messages.ISystemMessageLine

getErrorMessage, getMessage

Constructor Detail

SystemAbstractRemoteFilePropertyPageExtensionAction

public SystemAbstractRemoteFilePropertyPageExtensionAction()

Constructor

Method Detail

createContentArea

protected abstract Control createContentArea(Composite parent)

Abstract. You must override.
This is where child classes create their content area versus createContent, in order to have the message line configured for them and mnemonics assigned.

Specified by:

createContentArea in class SystemAbstractPropertyPageExtensionAction

verifyPageContents

protected boolean verifyPageContents()

You may override if your page has input fields. By default returns true.
Validate all the widgets on the page. Based on this, the Eclipse framework will know whether to veto any user attempt to select another property page from the list on the left in the Properties dialog.

Subclasses should override to do full error checking on all the widgets on the page. Recommendation:

• If an error is detected, issue a org.eclipse.rse.ui.messages.SystemMessage via SystemBasePropertyPage.setErrorMessage(SystemMessage) or text message via SystemBasePropertyPage.setErrorMessage(String).
• If no errors detected, clear the message line via SystemBasePropertyPage.clearErrorMessage()

Overrides:

verifyPageContents in class SystemAbstractPropertyPageExtensionAction

Returns:

true if there are no errors, false if any errors were found.

getRemoteFile

public IRemoteFile getRemoteFile()

Retrieve the input selected object, as an IRemoteFile, for convenience.

getRemoteFileSubSystem

public IRemoteFileSubSystem getRemoteFileSubSystem()

Get the remote file subsystem from which the selected objects were resolved. This has many useful methods in it, including support to transfer files to and from the local and remote systems.

getRemoteFileSubSystemConfiguration

public IRemoteFileSubSystemConfiguration getRemoteFileSubSystemConfiguration()

Returns the remote file subsystem factory which owns the subsystem from which the selected remote objects were resolved. This has some useful methods in it, including isUnixStyle() indicating if this remote file system is unix or windows.