Eclipse Plug-in Developer Guide (Galileo) - NewFolderDialog (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.dialogs
Class NewFolderDialog


java.lang.Object
  

org.eclipse.jface.window.Window
      

org.eclipse.jface.dialogs.Dialog
          

org.eclipse.jface.dialogs.TrayDialog
              

org.eclipse.ui.dialogs.SelectionDialog
                  

org.eclipse.ui.dialogs.SelectionStatusDialog
                      
org.eclipse.ui.dialogs.NewFolderDialog

All Implemented Interfaces:: IShellProvider

public class NewFolderDialog
extends SelectionStatusDialog
extends SelectionStatusDialog

The NewFolderDialog is used to create a new folder. The folder can optionally be linked to a file system folder.

This class may be instantiated; it is not intended to be subclassed.

Restriction:: This class is not intended to be subclassed by clients.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window. Window

Window.IExceptionHandler

Field Summary

Fields inherited from class org.eclipse.jface.dialogs. Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window. Window

CANCEL, OK

Constructor Summary

NewFolderDialog ( Shell parentShell, IContainer container)
          Creates a NewFolderDialog

Method Summary

protected void computeResult ()
          Creates the folder using the name and link target entered by the user.

protected void configureShell ( Shell shell)
          Configures the given shell in preparation for opening this window in it.

void create ()
          Creates this window's widgetry in a new top-level shell.

protected void createAdvancedControls ( Composite parent)
          Creates the widget for advanced options.

protected Control createDialogArea ( Composite parent)
          Creates and returns the contents of the upper part of this dialog (above the button bar).

protected void handleAdvancedButtonSelect ()
          Shows/hides the advanced option widgets.

protected void okPressed ()
          Notifies that the ok button of this dialog has been pressed.

protected void updateStatus ( IStatus status)
          Update the dialog's status line to reflect the given status.

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

createButtonBar, getFirstResult, setImage, setResult, setStatusLineAboveButtons, updateButtonsEnableState

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

createButtonsForButtonBar, createMessageArea, getDialogBoundsSettings, getDialogBoundsStrategy, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, isResizable, setDialogBoundsSettings, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle

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

close, closeTray, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

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

applyDialogFont, buttonPressed, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window. Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang. Object

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

Constructor Detail

NewFolderDialog

public NewFolderDialog(
Shell parentShell,
                       
IContainer container)

Creates a NewFolderDialog

Parameters:: parentShell - parent of the new dialog; container - parent of the new folder

Method Detail

computeResult

protected void computeResult()

Creates the folder using the name and link target entered by the user. Sets the dialog result to the created folder.

Specified by:: computeResult in class SelectionStatusDialog

configureShell

protected void configureShell(
Shell shell)

Description copied from class: Window

Configures the given shell in preparation for opening this window in it.

The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.

Overrides:: configureShell in class SelectionStatusDialog

Parameters:: shell - the shell

create

public void create()

Description copied from class: Window

Creates this window's widgetry in a new top-level shell.

The default implementation of this framework method creates this window's shell (by calling createShell), and its controls (by calling createContents), then initializes this window's shell bounds (by calling initializeBounds).

Overrides:: create in class SelectionStatusDialog

See Also:: Window.create()

createAdvancedControls

protected void createAdvancedControls(
Composite parent)

Creates the widget for advanced options.

Parameters:: parent - the parent composite

createDialogArea

protected 
Control createDialogArea(
Composite parent)

Description copied from class: Dialog

Creates and returns the contents of the upper part of this dialog (above the button bar).

The Dialog implementation of this framework method creates and returns a new Composite with standard margins and spacing.

The returned control's layout data must be an instance of GridData. This method must not modify the parent's layout.

Subclasses must override this method but may call super as in the following example:

 Composite composite = (Composite) super.createDialogArea(parent);
 //add controls to composite as necessary
 return composite;

Overrides:: createDialogArea in class Dialog

Parameters:: parent - the parent composite to contain the dialog area
Returns:: the dialog area control

handleAdvancedButtonSelect

protected void handleAdvancedButtonSelect()

Shows/hides the advanced option widgets.

updateStatus

protected void updateStatus(
IStatus status)

Update the dialog's status line to reflect the given status. It is safe to call this method before the dialog has been opened.

Overrides:: updateStatus in class SelectionStatusDialog

okPressed

protected void okPressed()