Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eclipse.net4j.util.ui.widgets
Class HistoryTextDialog

java.lang.Object
  extended by org.eclipse.jface.window.Window
      extended by org.eclipse.jface.dialogs.Dialog
          extended by org.eclipse.jface.dialogs.InputDialog
              extended by org.eclipse.net4j.util.ui.widgets.HistoryTextDialog
All Implemented Interfaces:
IShellProvider
public class HistoryTextDialog
extends InputDialog

TODO extend BaseDialog

Author:
Eike Stepper

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
HistoryTextDialog(Shell parentShell, String dialogTitle, String dialogMessage, IHistory<String> history, IInputValidator validator)
           
 
Method Summary
protected  void buttonPressed(int buttonId)
          Notifies that this dialog's button with the given id has been pressed.
protected  void createButtonsForButtonBar(Composite parent)
          Adds buttons to this dialog's button bar.
protected  Control createDialogArea(Composite parent)
          Creates and returns the contents of the upper part of this dialog (above the button bar).
 IHistory<String> getHistory()
           
 HistoryText getHistoryText()
           
 String getValue()
          Returns the string typed into this input dialog.
protected  void validateInput()
          Validates the input.
 
Methods inherited from class org.eclipse.jface.dialogs.InputDialog
configureShell, getErrorMessageLabel, getInputTextStyle, getOkButton, getText, getValidator, setErrorMessage
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonBar, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, 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

HistoryTextDialog

public HistoryTextDialog(Shell parentShell,
                         String dialogTitle,
                         String dialogMessage,
                         IHistory<String> history,
                         IInputValidator validator)
Method Detail

getHistory

public IHistory<String> getHistory()

getHistoryText

public HistoryText getHistoryText()

getValue

public String getValue()
Description copied from class: org.eclipse.jface.dialogs.InputDialog
Returns the string typed into this input dialog.

Overrides:
getValue in class InputDialog
Returns:
the input string

createDialogArea

protected Control createDialogArea(Composite parent)
Description copied from class: org.eclipse.jface.dialogs.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 InputDialog
Parameters:
parent - the parent composite to contain the dialog area
Returns:
the dialog area control

buttonPressed

protected void buttonPressed(int buttonId)
Description copied from class: org.eclipse.jface.dialogs.Dialog
Notifies that this dialog's button with the given id has been pressed.

The Dialog implementation of this framework method calls okPressed if the ok button is the pressed, and cancelPressed if the cancel button is the pressed. All other button presses are ignored. Subclasses may override to handle other buttons, but should call super.buttonPressed if the default handling of the ok and cancel buttons is desired.

Overrides:
buttonPressed in class InputDialog
Parameters:
buttonId - the id of the button that was pressed (see IDialogConstants.*_ID constants)

createButtonsForButtonBar

protected void createButtonsForButtonBar(Composite parent)
Description copied from class: org.eclipse.jface.dialogs.Dialog
Adds buttons to this dialog's button bar.

The Dialog implementation of this framework method adds standard ok and cancel buttons using the createButton framework method. These standard buttons will be accessible from getCancelButton, and getOKButton. Subclasses may override.

Overrides:
createButtonsForButtonBar in class InputDialog
Parameters:
parent - the button bar composite

validateInput

protected void validateInput()
Description copied from class: org.eclipse.jface.dialogs.InputDialog
Validates the input.

The default implementation of this framework method delegates the request to the supplied input validator object; if it finds the input invalid, the error message is displayed in the dialog's message line. This hook method is called whenever the text changes in the input field.

Overrides:
validateInput in class InputDialog
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.