Package org.csstudio.ui.util.wizards

Class WizardNewFileCreationPage

java.lang.Object
org.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
org.csstudio.ui.util.wizards.WizardNewFileCreationPage
All Implemented Interfaces:
IDialogPage, IMessageProvider, IWizardPage, Listener
Direct Known Subclasses:
NewJavaScriptWizardPage, NewOPIFileWizardPage, NewParFileWizardPage, NewPythonScriptWizardPage
public class WizardNewFileCreationPage extends WizardPage implements Listener
Standard main page for a wizard that creates a file resource.

This page may be used by clients as-is; it may be also be subclassed to suit.

Subclasses may override

  • getInitialContents
  • getNewFileLabel
Subclasses may extend
  • handleEvent

Code is based upon org.eclipse.ui.dialogs.WizardNewFileCreationPage in plugin org.eclipse.ui.ide.

  • Constructor Details

    • WizardNewFileCreationPage

      public WizardNewFileCreationPage(String pageName, IStructuredSelection selection)
      Creates a new file creation wizard page. If the initial resource selection contains exactly one container resource then it will be used as the default container resource.
      Parameters:
      pageName - the name of the page
      selection - the current resource selection

    • WizardNewFileCreationPage

      public WizardNewFileCreationPage(String pageName, IStructuredSelection selection, boolean canChooseProject)
      Creates a new file creation wizard page. If the initial resource selection contains exactly one container resource then it will be used as the default container resource.
      Parameters:
      pageName - the name of the page
      selection - the current resource selection
      canChooseProject - flag to allow the selection of the target project

  • Method Details

    • createControl

      public void createControl(Composite parent)
      Specified by:
      createControl in interface IDialogPage

    • createFile

      protected void createFile(IFile fileHandle, InputStream contents) throws CoreException
      Creates a file resource given the file handle and contents.
      Parameters:
      fileHandle - the file handle to create a file resource with
      contents - the initial contents of the new file resource, or null if none (equivalent to an empty stream)
      Throws:
      CoreException - if the operation fails

    • createFileHandle

      protected final IFile createFileHandle(IPath filePath)
      Creates a file resource handle for the file with the given workspace path. This method does not create the file resource; this is the responsibility of createFile.
      Parameters:
      filePath - the path of the file resource to create a handle for
      Returns:
      the new file resource handle

    • createNewFile

      public final IFile createNewFile()
      Creates a new file resource in the selected container and with the selected name. Creates any missing resource containers along the path; does nothing if the container resources already exist.

      In normal usage, this method is invoked after the user has pressed Finish on the wizard; the enablement of the Finish button implies that all controls on on this page currently contain valid values.

      Note that this page caches the new file once it has been successfully created; subsequent invocations of this method will answer the same file resource without attempting to create it again.

      This method should be called within a workspace modify operation since it creates resources.

      Returns:
      the created file resource, or null if the file was not created

    • getContainerFullPath

      public final IPath getContainerFullPath()
      Returns the current full path of the containing resource as entered or selected by the user, or its anticipated initial value.
      Returns:
      the container's full path, anticipated initial value, or null if no path is known

    • getFileName

      public String getFileName()
      Returns the current file name as entered by the user, or its anticipated initial value.
      Returns:
      the file name, its anticipated initial value, or null if no file name is known

    • getInitialContents

      protected InputStream getInitialContents()
      Returns a stream containing the initial contents to be given to new file resource instances. Subclasses may wish to override. This default implementation provides no initial contents.
      Returns:
      initial contents to be given to new file resource instances

    • getNewFileLabel

      protected String getNewFileLabel()
      Returns the label to display in the file name specification visual component group.

      Subclasses may reimplement.

      Returns:
      the label to display in the file name specification visual component group

    • handleEvent

      public void handleEvent(Event event)
      The WizardNewFileCreationPage implementation of this Listener method handles all events and enablements for controls on this page. Subclasses may extend.
      Specified by:
      handleEvent in interface Listener

    • initialPopulateContainerNameField

      protected void initialPopulateContainerNameField()
      Sets the initial contents of the container name entry field, based upon either a previously-specified initial value or the ability to determine such a value.

    • setContainerFullPath

      public void setContainerFullPath(IPath path)
      Sets the value of this page's container name field, or stores it for future use if this page's controls do not exist yet.
      Parameters:
      path - the full path to the container

    • setFileName

      public void setFileName(String value)
      Sets the value of this page's file name field, or stores it for future use if this page's controls do not exist yet.
      Parameters:
      value - new file name

    • validatePage

      protected final boolean validatePage()
      Returns whether this page's controls currently all contain valid values.
      Returns:
      true if all controls are valid, and false if at least one is invalid

    • setVisible

      public void setVisible(boolean visible)
      Specified by:
      setVisible in interface IDialogPage
      Overrides:
      setVisible in class DialogPage

    • getFileExtension

      public String getFileExtension()