Class PropertyDialog

  • All Implemented Interfaces:
    org.eclipse.jface.window.IShellProvider

    public class PropertyDialog
    extends org.eclipse.jface.dialogs.TitleAreaDialog
    Dialog to edit one property.
    Author:
    Eike Stepper
    • Nested Class Summary

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

        org.eclipse.jface.window.Window.IExceptionHandler
    • Field Summary

      • Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

        DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE
      • 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, resizeHasOccurred
    • Constructor Summary

      Constructors 
      Constructor Description
      PropertyDialog​(org.eclipse.swt.widgets.Shell parentShell)
      Constructor for a new property.
      PropertyDialog​(org.eclipse.swt.widgets.Shell parentShell, boolean keyEditable, java.lang.String key, java.lang.String value)
      Constructor to edit an existing property.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void cancelPressed()  
      protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)  
      protected org.eclipse.swt.graphics.Point getInitialSize()  
      java.lang.String getKey()  
      java.lang.String getValue()  
      boolean isKeyEditable()  
      • Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

        createContents, getErrorMessage, getMessage, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage
      • Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

        closeTray, createButtonBar, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
      • Methods inherited from class org.eclipse.jface.dialogs.Dialog

        applyDialogFont, buttonPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonsForButtonBar, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
      • Methods inherited from class org.eclipse.jface.window.Window

        canHandleShellCloseEvent, configureShell, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, 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

      • PropertyDialog

        public PropertyDialog​(org.eclipse.swt.widgets.Shell parentShell,
                              boolean keyEditable,
                              java.lang.String key,
                              java.lang.String value)
        Constructor to edit an existing property.
        Parameters:
        parentShell - the paren Shell
        keyEditable - if the property is editable
        key - the key of the property
        value - the current value of the property
      • PropertyDialog

        public PropertyDialog​(org.eclipse.swt.widgets.Shell parentShell)
        Constructor for a new property.
        Parameters:
        parentShell - the parent Shell
    • Method Detail

      • getKey

        public final java.lang.String getKey()
        Returns:
        the key of the currently edited property
      • getValue

        public final java.lang.String getValue()
        Returns:
        the value of the currently edited property
      • isKeyEditable

        public final boolean isKeyEditable()
        Returns:
        whether the property is editable
      • createDialogArea

        protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)
        Overrides:
        createDialogArea in class org.eclipse.jface.dialogs.TitleAreaDialog
      • cancelPressed

        protected void cancelPressed()
        Overrides:
        cancelPressed in class org.eclipse.jface.dialogs.Dialog
      • getInitialSize

        protected org.eclipse.swt.graphics.Point getInitialSize()
        Overrides:
        getInitialSize in class org.eclipse.jface.dialogs.TitleAreaDialog