Class RegisterDialog

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

    public class RegisterDialog
    extends org.eclipse.jface.dialogs.TitleAreaDialog
    The class responsible for creating and working with the register selection dialog box for the movements constructor.
    • 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
      RegisterDialog​(org.eclipse.swt.widgets.Shell parentShell, Document document, Configuration configuration, IBmEditingContext bmEditingContext)
      Creates a dialog box for selecting registers for this document
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean close()  
      void collapseAll()
      Collapse all register tree elements
      protected void configureShell​(org.eclipse.swt.widgets.Shell newShell)  
      protected void createButtonsForButtonBar​(org.eclipse.swt.widgets.Composite parent)  
      protected org.eclipse.swt.widgets.Control createContents​(org.eclipse.swt.widgets.Composite parent)  
      org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)  
      void expandAll()
      Expand all register tree elements
      protected org.eclipse.jface.dialogs.IDialogSettings getDialogBoundsSettings()  
      protected int getDialogBoundsStrategy()  
      protected org.eclipse.swt.graphics.Point getInitialLocation​(org.eclipse.swt.graphics.Point initialSize)  
      protected org.eclipse.swt.graphics.Point getInitialSize()  
      Collection<BasicRegister> getSelectedRegisters()
      Collection of selected registers.
      protected void okPressed()  
      int open()  
      void setElementsChecked​(boolean checked)
      Check or uncheck all tree element
      • Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

        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, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, 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, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
    • Constructor Detail

      • RegisterDialog

        public RegisterDialog​(org.eclipse.swt.widgets.Shell parentShell,
                              Document document,
                              Configuration configuration,
                              IBmEditingContext bmEditingContext)
        Creates a dialog box for selecting registers for this document
        Parameters:
        parentShell - - external window, cannot be null
        document - - document for which the movements constructor opens , cannot be null
        configuration - - current configuration , cannot be null
        bmEditingContext - - editing context for submitting tasks , cannot be null
    • Method Detail

      • getSelectedRegisters

        public Collection<BasicRegister> getSelectedRegisters()
        Collection of selected registers.
        Returns:
        - cannot return null, if the user has not selected registers, returns empty collection
      • setElementsChecked

        public void setElementsChecked​(boolean checked)
        Check or uncheck all tree element
        Parameters:
        checked - - true if tree item should be checked, false otherwise
      • expandAll

        public void expandAll()
        Expand all register tree elements
      • collapseAll

        public void collapseAll()
        Collapse all register tree elements
      • createDialogArea

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

        public int open()
        Overrides:
        open in class org.eclipse.jface.window.Window
      • close

        public boolean close()
        Overrides:
        close in class org.eclipse.jface.dialogs.Dialog
      • createContents

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

        protected void createButtonsForButtonBar​(org.eclipse.swt.widgets.Composite parent)
        Overrides:
        createButtonsForButtonBar in class org.eclipse.jface.dialogs.Dialog
      • getInitialSize

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

        protected org.eclipse.swt.graphics.Point getInitialLocation​(org.eclipse.swt.graphics.Point initialSize)
        Overrides:
        getInitialLocation in class org.eclipse.jface.dialogs.Dialog
      • getDialogBoundsSettings

        protected org.eclipse.jface.dialogs.IDialogSettings getDialogBoundsSettings()
        Overrides:
        getDialogBoundsSettings in class org.eclipse.jface.dialogs.Dialog
      • getDialogBoundsStrategy

        protected int getDialogBoundsStrategy()
        Overrides:
        getDialogBoundsStrategy in class org.eclipse.jface.dialogs.Dialog
      • configureShell

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

        protected void okPressed()
        Overrides:
        okPressed in class org.eclipse.jface.dialogs.Dialog