Class TextInputWizardPage

  • All Implemented Interfaces:
    org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage

    public abstract class TextInputWizardPage
    extends org.eclipse.ltk.ui.refactoring.UserInputWizardPage
    Default implementation of UserInputWizardPage for Bsl extracting refactoring
    The main facilities of this class is to create text input field and validate inserting value
    • Field Summary

      Modifier and Type Field Description
      static String PAGE_NAME  
      • Fields inherited from class org.eclipse.ltk.ui.refactoring.RefactoringWizardPage

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.eclipse.swt.widgets.Text createTextInputField​(org.eclipse.swt.widgets.Composite parent)
      Create input field control
      void dispose()  
      protected String getText()
      Returns the content of the text input field.
      protected org.eclipse.swt.widgets.Text getTextField()
      Returns the text entry field
      void setVisible​(boolean visible)  
      protected void textModified​(String text)
      Checks the page's state and issues a corresponding error message.
      protected abstract org.eclipse.ltk.core.refactoring.RefactoringStatus validateTextField​(String text)
      Validates inputing text
      • Methods inherited from class org.eclipse.ltk.ui.refactoring.UserInputWizardPage

        canFlipToNextPage, computeSuccessorPage, getNextPage, isLastUserInputPage, performFinish, setPageComplete
      • Methods inherited from class org.eclipse.ltk.ui.refactoring.RefactoringWizardPage

        getRefactoring, getRefactoringSettings, getRefactoringWizard, setWizard
      • Methods inherited from class org.eclipse.jface.wizard.WizardPage

        getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, 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, setMessage
      • Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

        createControl, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp
    • Constructor Detail

      • TextInputWizardPage

        public TextInputWizardPage​(String description,
                                   String initialValue)
        description - description of the page, can be null if none description
        initialValue - the start value, can't be null
    • Method Detail

      • dispose

        public void dispose()
        Specified by:
        dispose in interface org.eclipse.jface.dialogs.IDialogPage
        dispose in class org.eclipse.jface.dialogs.DialogPage
      • setVisible

        public void setVisible​(boolean visible)
        Specified by:
        setVisible in interface org.eclipse.jface.dialogs.IDialogPage
        setVisible in class org.eclipse.ltk.ui.refactoring.UserInputWizardPage
      • validateTextField

        protected abstract org.eclipse.ltk.core.refactoring.RefactoringStatus validateTextField​(String text)
        Validates inputing text
        text - for validation, can't be null
        result of validation RefactoringStatus
      • getText

        protected String getText()
        Returns the content of the text input field.
        the content of the text input field. Returns null if not text input field has been created
      • getTextField

        protected org.eclipse.swt.widgets.Text getTextField()
        Returns the text entry field
        the text entry field
      • createTextInputField

        protected org.eclipse.swt.widgets.Text createTextInputField​(org.eclipse.swt.widgets.Composite parent)
        Create input field control
        parent - parent composite, can't be null
        created control, can't be null
      • textModified

        protected void textModified​(String text)
        Checks the page's state and issues a corresponding error message. The page validation is computed by calling validatePage.