Class ECIDElementsCustomizerDialog

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

    @API(type=INTERNAL,
         src=PUBLIC)
    public class ECIDElementsCustomizerDialog
    extends org.eclipse.jface.dialogs.TrayDialog
    Dialog used to customize DITA elements which have auto ID generation. It will be also used when the IDs are generated manually. It is used on standalone implementation.
    • 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.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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void configureShell​(org.eclipse.swt.widgets.Shell newShell)  
      protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)  
      protected java.lang.String getHelpPageID()
      Get the ID of the help page which will be called by the end user.
      protected void okPressed()  
      GenerateIDElementsInfo showDialog​(GenerateIDElementsInfo info)  
      • 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, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonsForButtonBar, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, isResizable, 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, 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

      • ECIDElementsCustomizerDialog

        public ECIDElementsCustomizerDialog​(org.eclipse.swt.widgets.Shell parentShell,
                                            java.lang.String listMessage,
                                            AuthorResourceBundle authorResourceBundle,
                                            boolean isDocBook)
        Constructor.
        Parameters:
        parentShell - The parent shell for the dialog.
        listMessage - The message label used on the list.
        authorResourceBundle - The author resource bundle.
        isDocBook - true if we are in DocBook.
    • Method Detail

      • configureShell

        protected void configureShell​(org.eclipse.swt.widgets.Shell newShell)
        Overrides:
        configureShell in class org.eclipse.jface.window.Window
        See Also:
        Window.configureShell(org.eclipse.swt.widgets.Shell)
      • createDialogArea

        protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)
        Overrides:
        createDialogArea in class org.eclipse.jface.dialogs.Dialog
        See Also:
        Dialog.createDialogArea(org.eclipse.swt.widgets.Composite)
      • okPressed

        protected void okPressed()
        Overrides:
        okPressed in class org.eclipse.jface.dialogs.Dialog
        See Also:
        Dialog.okPressed()
      • getHelpPageID

        protected java.lang.String getHelpPageID()
        Get the ID of the help page which will be called by the end user.
        Returns:
        the ID of the help page which will be called by the end user or null.