Class ECSortCustomizerDialog

  • All Implemented Interfaces:
    org.eclipse.jface.window.IShellProvider, KeysController, SortCustomizer

    @API(type=NOT_EXTENDABLE,
         src=PRIVATE)
    public class ECSortCustomizerDialog
    extends org.eclipse.jface.dialogs.TrayDialog
    implements SortCustomizer, KeysController
    Eclipse implementation of the customizer used to select the criterion information used when sorting.
    • 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
    • Constructor Summary

      Constructors 
      Constructor Description
      ECSortCustomizerDialog​(org.eclipse.swt.widgets.Shell parentFrame, AuthorResourceBundle authorResourceBundle, java.lang.String selectedElemensString, java.lang.String allElementsString)
      Constructor.
      ECSortCustomizerDialog​(org.eclipse.swt.widgets.Shell parentFrame, AuthorResourceBundle authorResourceBundle, java.lang.String selectedElemensString, java.lang.String allElementsString, java.lang.String helpPageID)
      Constructor.
    • 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)  
      SortCriteriaInformation getSortInformation​(java.util.List<CriterionInformation> criteriaInformation, boolean hasSelectedSortableElements, boolean cannotSortAllElements)
      Obtain the sort information given some initial sort criteria.
      protected boolean isResizable()  
      protected void okPressed()  
      void selectionChanged​(java.lang.String newSelection, java.lang.String oldSelection)
      Method which controls the change of the selected key.
      • 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, 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

      • ECSortCustomizerDialog

        public ECSortCustomizerDialog​(org.eclipse.swt.widgets.Shell parentFrame,
                                      AuthorResourceBundle authorResourceBundle,
                                      java.lang.String selectedElemensString,
                                      java.lang.String allElementsString)
        Constructor.
        Parameters:
        parentFrame - The parent shell.
        authorResourceBundle - The author resource bundle.
        selectedElemensString - The name of the "selected elements" radio combo.
        allElementsString - The name of the "all elements" radio combo.
      • ECSortCustomizerDialog

        public ECSortCustomizerDialog​(org.eclipse.swt.widgets.Shell parentFrame,
                                      AuthorResourceBundle authorResourceBundle,
                                      java.lang.String selectedElemensString,
                                      java.lang.String allElementsString,
                                      java.lang.String helpPageID)
        Constructor.
        Parameters:
        parentFrame - The parent shell.
        authorResourceBundle - The author resource bundle.
        selectedElemensString - The name of the "selected elements" radio combo.
        allElementsString - The name of the "all elements" radio combo.
        helpPageID - Help page ID
    • Method Detail

      • 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)
      • 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)
      • getSortInformation

        public SortCriteriaInformation getSortInformation​(java.util.List<CriterionInformation> criteriaInformation,
                                                          boolean hasSelectedSortableElements,
                                                          boolean cannotSortAllElements)
        Description copied from interface: SortCustomizer
        Obtain the sort information given some initial sort criteria.
        Specified by:
        getSortInformation in interface SortCustomizer
        Parameters:
        criteriaInformation - The information about the available sorting criteria.
        hasSelectedSortableElements - true when elements selected in the document can be sorted.
        cannotSortAllElements - true when all the elements from the parent of the sort operation cannot be sorted. for example when the selected rows from a table can be sorted but the whole table cannot because it contains, outside the selected rows, some rows with multiple rowspan cells.
        Returns:
        The sort information, about criteria and the sort scope.
        See Also:
        SortCustomizer.getSortInformation(java.util.List, boolean, boolean)
      • okPressed

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

        protected boolean isResizable()
        Overrides:
        isResizable in class org.eclipse.jface.dialogs.Dialog
        See Also:
        Dialog.isResizable()