RSE
Release 3.4

org.eclipse.rse.ui.wizards
Class SystemNewProfileWizardMainPage

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.eclipse.jface.wizard.WizardPage
          extended by org.eclipse.rse.ui.wizards.AbstractSystemWizardPage
              extended by org.eclipse.rse.ui.wizards.SystemNewProfileWizardMainPage
All Implemented Interfaces:
IDialogPage, IMessageProvider, IWizardPage, ISystemMessageLine, ISystemWizardPage

public class SystemNewProfileWizardMainPage
extends AbstractSystemWizardPage
implements ISystemMessageLine

Default main page of the "New Profile" wizard. This page asks for the following information:


Field Summary
protected  ISystemValidator nameValidator
           
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
SystemNewProfileWizardMainPage(Wizard wizard)
          Constructor.
 
Method Summary
 Control createContents(Composite parent)
          CreateContents is the one method that must be overridden from the parent class.
protected  Control getInitialFocusControl()
          Return the Control to be given initial focus.
 Object getLayoutData()
           
 boolean getMakeActive()
          Return user-entered decision to make the new profile active.
 String getProfileName()
          Return user-entered profile name.
 boolean isPageComplete()
          Return true if the page is complete, so to enable Finish.
 boolean performFinish()
          Completes processing of the wizard.
 void setLayoutData(Object gridData)
           
protected  SystemMessage validateNameInput()
          This hook method is called whenever the text changes in the input field.
 
Methods inherited from class org.eclipse.rse.ui.wizards.AbstractSystemWizardPage
addFillerLine, addGrowableFillerLine, addSeparatorLine, applyMnemonics, clearErrorMessage, clearMessage, createControl, dispose, getHelpContextId, getInputObject, getMessageLine, getSystemErrorMessage, setErrorMessage, setErrorMessage, setErrorMessage, setFocus, setHelp, setInputObject, setMessage, setMessage, setMessage, setVisible
 
Methods inherited from class org.eclipse.jface.wizard.WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, setDescription, setImageDescriptor, setPageComplete, setPreviousPage, setTitle, setWizard, toString
 
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.rse.ui.messages.ISystemMessageLine
clearErrorMessage, clearMessage, getErrorMessage, getMessage, getSystemErrorMessage, setErrorMessage, setErrorMessage, setErrorMessage, setMessage, setMessage
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp
 

Field Detail

nameValidator

protected ISystemValidator nameValidator
Constructor Detail

SystemNewProfileWizardMainPage

public SystemNewProfileWizardMainPage(Wizard wizard)
Constructor.

Method Detail

createContents

public Control createContents(Composite parent)
CreateContents is the one method that must be overridden from the parent class. In this method, we populate an SWT container with widgets and return the container to the caller (JFace). This is used as the contents of this page.

Specified by:
createContents in class AbstractSystemWizardPage
See Also:
SystemWidgetHelpers

getInitialFocusControl

protected Control getInitialFocusControl()
Return the Control to be given initial focus. Override from parent. Return control to be given initial focus.

Specified by:
getInitialFocusControl in class AbstractSystemWizardPage

validateNameInput

protected SystemMessage validateNameInput()
This hook method is called whenever the text changes in the input field. The default implementation delegates the request to an ISystemValidator object. If the ISystemValidator reports an error the error message is displayed in the Dialog's message line.


performFinish

public boolean performFinish()
Completes processing of the wizard. If this method returns true, the wizard will close; otherwise, it will stay active. This method is an override from the parent Wizard class.

Specified by:
performFinish in interface ISystemWizardPage
Specified by:
performFinish in class AbstractSystemWizardPage
Returns:
whether the wizard finished successfully

getProfileName

public String getProfileName()
Return user-entered profile name. Call this after finish ends successfully.


getMakeActive

public boolean getMakeActive()
Return user-entered decision to make the new profile active. Call this after finish ends successfully.


getLayoutData

public Object getLayoutData()

setLayoutData

public void setLayoutData(Object gridData)

isPageComplete

public boolean isPageComplete()
Return true if the page is complete, so to enable Finish. Called by wizard framework.

Specified by:
isPageComplete in interface IWizardPage
Overrides:
isPageComplete in class WizardPage

RSE
Release 3.4

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