Class LocalStringDialog

  • All Implemented Interfaces:
    org.eclipse.jface.window.IShellProvider
    Direct Known Subclasses:
    LocalStringFormatDialog, LocalStringFormattedTextDialog

    public class LocalStringDialog
    extends org.eclipse.jface.dialogs.TitleAreaDialog
    Dialog for entering string on multiple languages
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static String DIALOG_SETTINGS_SECTION_NAME  
      protected static String MULTILINE_SECTION_NAME  
      protected static String SINGLE_LINE_SECTION_NAME  
      • 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
      LocalStringDialog​(org.eclipse.swt.widgets.Shell parentShell, IV8Project v8project, Map<String,​String> inputData, String currentEditingLanguageCode, boolean multiLine, boolean isReadOnly)
      Dialog for entering string on different languages.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean close()  
      protected void configureShell​(org.eclipse.swt.widgets.Shell newShell)  
      protected static Map<String,​String> convert​(List<LocalStringDialog.LocalString> localStrings)
      Converts given list of LocalStringDialog.LocalString into language code to text map.
      protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)
      Creates initial dialog structure
      protected void createMultilineEntry​(org.eclipse.swt.widgets.Composite parent, org.eclipse.core.databinding.DataBindingContext dbc, LocalStringDialog.LocalString localString)
      Create editor for multyline of local string
      protected void createSingleEntry​(org.eclipse.swt.widgets.Composite parent, org.eclipse.core.databinding.DataBindingContext dbc, LocalStringDialog.LocalString localString)
      Create editor for single line of local string
      protected void createTextEditingArea​(org.eclipse.swt.widgets.Composite parent, org.eclipse.core.databinding.DataBindingContext dbc)
      Creates text area with controls to modify localized strings.
      protected void createTextEditor​(org.eclipse.swt.widgets.Composite parent, LocalStringDialog.LocalString localString, org.eclipse.core.databinding.DataBindingContext dbc)
      Create editor for local string
      protected org.eclipse.jface.dialogs.IDialogSettings getDialogBoundsSettings()  
      Map<String,​String> getValues()
      Returns the map of key-value pairs or null if canceled
      • Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

        createContents, getErrorMessage, getInitialSize, 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, createButtonsForButtonBar, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsStrategy, getImage, getInitialLocation, 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, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
    • Constructor Detail

      • LocalStringDialog

        public LocalStringDialog​(org.eclipse.swt.widgets.Shell parentShell,
                                 IV8Project v8project,
                                 Map<String,​String> inputData,
                                 String currentEditingLanguageCode,
                                 boolean multiLine,
                                 boolean isReadOnly)
        Dialog for entering string on different languages.
        Parameters:
        parentShell - the parent SWT shell, cannot be null
        v8project - the current V8 project, cannot be null
        inputData - a map of string key-values pairs where key is language code and value is the input string, cannot be null
        currentEditingLanguageCode - code of configuration editing language, cannot be null
        multiLine - flag, indicating that input text boxes should be multiline
        isReadOnly - flag, indicating that dialog is in read-only mode
    • Method Detail

      • getValues

        public Map<String,​String> getValues()
        Returns the map of key-value pairs or null if canceled
        Returns:
        map of Map<String, String> type
      • close

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

        protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)
        Creates initial dialog structure
        Overrides:
        createDialogArea in class org.eclipse.jface.dialogs.TitleAreaDialog
      • createSingleEntry

        protected void createSingleEntry​(org.eclipse.swt.widgets.Composite parent,
                                         org.eclipse.core.databinding.DataBindingContext dbc,
                                         LocalStringDialog.LocalString localString)
        Create editor for single line of local string
        Parameters:
        parent - the parent container, cannot be null
        dbc - the data binding context, cannot be null
        localString - the editing local string item, cannot be null
      • createMultilineEntry

        protected void createMultilineEntry​(org.eclipse.swt.widgets.Composite parent,
                                            org.eclipse.core.databinding.DataBindingContext dbc,
                                            LocalStringDialog.LocalString localString)
        Create editor for multyline of local string
        Parameters:
        parent - the parent container, cannot be null
        dbc - the data binding context, cannot be null
        localString - the editing local string item, cannot be null
      • createTextEditingArea

        protected void createTextEditingArea​(org.eclipse.swt.widgets.Composite parent,
                                             org.eclipse.core.databinding.DataBindingContext dbc)
        Creates text area with controls to modify localized strings.
        Parameters:
        parent - base dialog composite, cannot be null
        dbc - dialog data binding context, cannot be null
      • createTextEditor

        protected void createTextEditor​(org.eclipse.swt.widgets.Composite parent,
                                        LocalStringDialog.LocalString localString,
                                        org.eclipse.core.databinding.DataBindingContext dbc)
        Create editor for local string
        Parameters:
        parent - the parent container, cannot be null
        localString - the editing local string item, cannot be null
        dbc - the data binding context, cannot be null
      • configureShell

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

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