org.eclipse.rse.ui.propertypages
Class SystemAbstractPropertyPageExtensionAction

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

All Implemented Interfaces:

IDialogPage, IMessageProvider, IPreferencePage, ISystemMessageLine, ISystemMessageLineTarget, IWorkbenchPropertyPage

Direct Known Subclasses:

SystemAbstractRemoteFilePropertyPageExtensionAction

public abstract class SystemAbstractPropertyPageExtensionAction

extends SystemBasePropertyPage

implements IWorkbenchPropertyPage

This is a base class to simplify the creation of remote object property pages supplied via the org.eclipse.rse.core.propertyPages extension point.

This class extends SystemBasePropertyPage and so inherits the benefits of that class.
To get these benefits though, you must override createContentArea(Composite) versus the usual createContents(Composite) method..

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 getRemoteObject() for querying the selected remote object.
• Supplies helper methods getRemoteObjectXXX() for querying the attributes of the selected remote object.
• Supplies helper methods to query the subsystem and connection containing the selected remote object.

If your property page is for a file-system file or folder, use SystemAbstractRemoteFilePropertyPageExtensionAction.

Field Summary

protected static Object[]

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

SystemAbstractPropertyPageExtensionAction()
Constructor

Method Summary

protected abstract Control	createContentArea(Composite parent) Abstract.
protected Composite	createTestComposite(Composite parent) Debug method to print out details of given selected object, in a composite GUI widget...
ISystemRemoteElementAdapter	getRemoteAdapter() Retrieve the adapter of the input remote object as an ISystemRemoteElementAdapter object, for convenience.
protected ISystemRemoteElementAdapter	getRemoteAdapter(Object o) Returns the implementation of ISystemRemoteElementAdapter for the given object.
Object	getRemoteObject() Retrieve the input remote object
String	getRemoteObjectName() Returns the name of the input remote object
String	getRemoteObjectSubSubType() Returns the sub-subtype of the input remote object
String	getRemoteObjectSubSystemConfigurationId() Returns the id of the subsystem factory of the input remote object.
String	getRemoteObjectSubType() Returns the subtype of the input remote object
String	getRemoteObjectType() Returns the type of the input remote object
String	getRemoteObjectTypeCategory() Returns the type category of the input remote object
ISubSystem	getSubSystem() Returns the subsystem from which the input remote object was resolved
ISubSystemConfiguration	getSubSystemConfiguration() Returns the subsystem factory which owns the subsystem from which the input remote object was resolved
IHost	getSystemConnection() Return the SystemConnection 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.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

Field Detail

EMPTY_ARRAY

protected static final Object[] EMPTY_ARRAY

Constructor Detail

SystemAbstractPropertyPageExtensionAction

public SystemAbstractPropertyPageExtensionAction()

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 SystemBasePropertyPage

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()

Specified by:

verifyPageContents in class SystemBasePropertyPage

Returns:

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

getRemoteObject

public Object getRemoteObject()

Retrieve the input remote object

See Also:

getRemoteAdapter(Object)

getRemoteAdapter

public ISystemRemoteElementAdapter getRemoteAdapter()

Retrieve the adapter of the input remote object as an ISystemRemoteElementAdapter object, for convenience. Will be null if there is nothing selected

getRemoteAdapter

protected ISystemRemoteElementAdapter getRemoteAdapter(Object o)

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

getRemoteObjectName

public String getRemoteObjectName()

Returns the name of the input remote object

getRemoteObjectSubSystemConfigurationId

public String getRemoteObjectSubSystemConfigurationId()

Returns the id of the subsystem factory of the input remote object.

getRemoteObjectTypeCategory

public String getRemoteObjectTypeCategory()

Returns the type category of the input remote object

getRemoteObjectType

public String getRemoteObjectType()

Returns the type of the input remote object

getRemoteObjectSubType

public String getRemoteObjectSubType()

Returns the subtype of the input remote object

getRemoteObjectSubSubType

public String getRemoteObjectSubSubType()

Returns the sub-subtype of the input remote object

getSubSystem

public ISubSystem getSubSystem()

Returns the subsystem from which the input remote object was resolved

getSubSystemConfiguration

public ISubSystemConfiguration getSubSystemConfiguration()

Returns the subsystem factory which owns the subsystem from which the input remote object was resolved

getSystemConnection

public IHost getSystemConnection()

Return the SystemConnection from which the selected remote objects were resolved

createTestComposite

protected Composite createTestComposite(Composite parent)

Debug method to print out details of given selected object, in a composite GUI widget...