package org.omnetpp.common.ui;


import java.util.HashMap;
import java.util.Map;

import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.layout.PixelConverter;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CLabel;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.custom.ViewForm;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.MouseTrackAdapter;
import org.eclipse.swt.events.MouseTrackListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.FontData;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Layout;
import org.eclipse.swt.widgets.Spinner;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.ui.forms.widgets.ExpandableComposite;
import org.omnetpp.common.util.CollectionUtils;
import org.omnetpp.common.wizard.support.InfoLink;

/**
 * Factory class to create some SWT resources.
 *
 * This is a copy the class of similar name in the org.eclipse.debug.internal.ui.
 * It is added here so that it can be used from code that does not depend on
 * the Debug UI plugin. It has also been expanded with new methods.
 */
public class SWTFactory {

    public static int FILL_BOTH = GridData.VERTICAL_ALIGN_FILL | GridData.HORIZONTAL_ALIGN_FILL;
    public static int GRAB_AND_FILL_BOTH = GridData.VERTICAL_ALIGN_FILL | GridData.HORIZONTAL_ALIGN_FILL| GridData.GRAB_HORIZONTAL | GridData.GRAB_VERTICAL;
    public static int GRAB_AND_FILL_HORIZONTAL = GridData.VERTICAL_ALIGN_BEGINNING | GridData.HORIZONTAL_ALIGN_FILL| GridData.GRAB_HORIZONTAL;
    private static Font smallFont = null;

    private static final String COMBO_MAP_KEY = "itemValues";

    /**
     * Returns a width hint for a button control.
     */
    public static int getButtonWidthHint(Button button) {
        /*button.setFont(JFaceResources.getDialogFont());*/
        PixelConverter converter= new PixelConverter(button);
        int widthHint= converter.convertHorizontalDLUsToPixels(IDialogConstants.BUTTON_WIDTH);
        return Math.max(widthHint, button.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).x);
    }

    /**
     * Sets width and height hint for the button control.
     * <b>Note:</b> This is a NOP if the button's layout data is not
     * an instance of <code>GridData</code>.
     *
     * @param    the button for which to set the dimension hint
     */
    public static void setButtonDimensionHint(Button button) {
        Assert.isNotNull(button);
        Object gd= button.getLayoutData();
        if (gd instanceof GridData) {
            ((GridData)gd).widthHint= getButtonWidthHint(button);
            ((GridData)gd).horizontalAlignment = GridData.FILL;
        }
    }

    protected static Button doCreateCheckButton(Composite parent, String label, Image image, boolean checked, int hspan) {
        Button button = new Button(parent, SWT.CHECK);
        button.setFont(parent.getFont());
        button.setSelection(checked);
        if (image != null)
            button.setImage(image);
        if (label != null)
            button.setText(label);
        GridData gd = new GridData();
        gd.horizontalSpan = hspan;
        button.setLayoutData(gd);
        setButtonDimensionHint(button);
        return button;
    }

    /**
     * Creates a check box button using the parents' font.
     *
     * @param parent the parent to add the button to
     * @param label the label for the button
     * @param image the image for the button
     * @param checked the initial checked state of the button
     * @param hspan the horizontal span to take up in the parent composite
     * @return a new checked button set to the initial checked state
     * @since 3.3
     */
    public static Button createCheckButton(Composite parent, String label, Image image, boolean checked, int hspan) {
        Button button = doCreateCheckButton(parent, label, image, checked, hspan);

        // make a grayed button turn into a normal button on first click (otherwise it alternates
        // between clear and grayed, which is not what is usually needed)
        button.addSelectionListener(new SelectionAdapter() {
            @Override
            public void widgetSelected(SelectionEvent e) {
                if (button.getGrayed() && button.getSelection())
                    button.setGrayed(false);
            }
        });
        return button;
    }

    /**
     * Creates a tristate checkbox.
     *
     * @param parent the parent to add the button to
     * @param label the label for the button
     * @param image the image for the button
     * @param checked the initial checked state of the button
     * @param grayed the initial grayed state of the button
     * @param hspan the horizontal span to take up in the parent composite
     * @return a new check button
     */
    public static TristateCheckButton createTristateCheckButton(Composite parent, String label, Image image, boolean checked, boolean grayed, int hspan) {
        TristateCheckButton button = new TristateCheckButton(parent, SWT.CHECK);
        button.setFont(parent.getFont());
        button.setSelection(checked);
        button.setGrayed(grayed); // note: order of setSelection() and setGrayed() is important
        if (image != null)
            button.setImage(image);
        if (label != null)
            button.setText(label);
        GridData gd = new GridData();
        gd.horizontalSpan = hspan;
        button.setLayoutData(gd);
        setButtonDimensionHint(button);
        return button;
    }

    /**
     * Creates and returns a new push button with the given
     * label and/or image.
     *
     * @param parent parent control
     * @param label button label or <code>null</code>
     * @param image image of <code>null</code>
     *
     * @return a new push button
     */
    public static Button createPushButton(Composite parent, String label, Image image) {
        Button button = new Button(parent, SWT.PUSH);
        button.setFont(parent.getFont());
        if (image != null) {
            button.setImage(image);
        }
        if (label != null) {
            button.setText(label);
        }
        GridData gd = new GridData();
        button.setLayoutData(gd);
        setButtonDimensionHint(button);
        return button;
    }

    /**
     * Creates and returns a new push button with the given
     * label and/or image.
     *
     * @param parent parent control
     * @param label button label or <code>null</code>
     * @param image image of <code>null</code>
     * @param fill the alignment for the new button
     *
     * @return a new push button
     * @since 3.4
     */
    public static Button createPushButton(Composite parent, String label, Image image, int fill) {
        return createPushButton(parent, label, image, new GridData(fill));
    }

    public static Button createPushButton(Composite parent, String label, Image image, GridData gd) {
        Button button = new Button(parent, SWT.PUSH);
        button.setFont(parent.getFont());
        if (image != null)
            button.setImage(image);
        if (label != null)
            button.setText(label);
        button.setLayoutData(gd);
        setButtonDimensionHint(button);
        return button;
    }

    /**
     * Creates and returns a new push button with the given
     * label, tooltip and/or image.
     *
     * @param parent parent control
     * @param label button label or <code>null</code>
     * @param tooltip the tooltip text for the button or <code>null</code>
     * @param image image of <code>null</code>
     *
     * @return a new push button
     * @since 3.6
     */
    public static Button createPushButton(Composite parent, String label, String tooltip, Image image) {
        Button button = createPushButton(parent, label, image);
        button.setToolTipText(tooltip);
        return button;
    }

    /**
     * Creates and returns a new radio button with the given
     * label.
     *
     * @param parent parent control
     * @param label button label or <code>null</code>
     *
     * @return a new radio button
     */
    public static Button createRadioButton(Composite parent, String label) {
        Button button = new Button(parent, SWT.RADIO);
        button.setFont(parent.getFont());
        if (label != null) {
            button.setText(label);
        }
        GridData gd = new GridData();
        button.setLayoutData(gd);
        setButtonDimensionHint(button);
        return button;
    }

    /**
     * Creates and returns a new radio button with the given
     * label.
     *
     * @param parent parent control
     * @param label button label or <code>null</code>
     * @param hspan the number of columns to span in the parent composite
     *
     * @return a new radio button
     * @since 3.6
     */
    public static Button createRadioButton(Composite parent, String label, int hspan) {
        Button button = new Button(parent, SWT.RADIO);
        button.setFont(parent.getFont());
        if (label != null) {
            button.setText(label);
        }
        GridData gd = new GridData(GridData.BEGINNING);
        gd.horizontalSpan = hspan;
        button.setLayoutData(gd);
        setButtonDimensionHint(button);
        return button;
    }

    /**
     * Creates a new label widget
     * @param parent the parent composite to add this label widget to
     * @param text the text for the label
     * @param hspan the horizontal span to take up in the parent composite
     * @return the new label
     * @since 3.2
     *
     */
    public static Label createLabel(Composite parent, String text, int hspan) {
        Label l = new Label(parent, SWT.NONE);
        l.setFont(parent.getFont());
        l.setText(text);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        gd.grabExcessHorizontalSpace = false;
        l.setLayoutData(gd);
        return l;
    }

    /**
     * Creates a new label widget
     * @param parent the parent composite to add this label widget to
     * @param text the text for the label
     * @param font the font for the label
     * @param hspan the horizontal span to take up in the parent composite
     * @return the new label
     * @since 3.3
     */
    public static Label createLabel(Composite parent, String text, Font font, int hspan) {
        Label l = new Label(parent, SWT.NONE);
        l.setFont(font);
        l.setText(text);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        l.setLayoutData(gd);
        return l;
    }

    /**
     * Creates a wrapping label
     * @param parent the parent composite to add this label to
     * @param text the text to be displayed in the label
     * @param hspan the horizontal span that label should take up in the parent composite
     * @param wrapwidth the width hint that the label should wrap at
     * @return a new label that wraps at a specified width
     * @since 3.3
     */
    public static Label createWrapLabel(Composite parent, String text, int hspan, int wrapwidth) {
        Label l = new Label(parent, SWT.NONE | SWT.WRAP);
        l.setFont(parent.getFont());
        l.setText(text);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        gd.widthHint = wrapwidth;
        l.setLayoutData(gd);
        return l;
    }

    /**
     * Creates a new <code>CLabel</code> that will wrap at the specified width and has the specified image
     * @param parent the parent to add this label to
     * @param text the text for the label
     * @param image the image for the label
     * @param hspan the h span to take up in the parent
     * @param wrapwidth the with to wrap at
     * @return a new <code>CLabel</code>
     * @since 3.3
     */
    public static CLabel createWrapCLabel(Composite parent, String text, Image image, int hspan, int wrapwidth) {
        CLabel label = new CLabel(parent, SWT.NONE | SWT.WRAP);
        label.setFont(parent.getFont());
        if(text != null) {
            label.setText(text);
        }
        if(image != null) {
            label.setImage(image);
        }
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        gd.widthHint = wrapwidth;
        label.setLayoutData(gd);
        return label;
    }

    /**
     * Creates a wrapping label
     * @param parent the parent composite to add this label to
     * @param text the text to be displayed in the label
     * @param hspan the horizontal span that label should take up in the parent composite
     * @return a new label that wraps at a specified width
     * @since 3.3
     */
    public static Label createWrapLabel(Composite parent, String text, int hspan) {
        Label l = new Label(parent, SWT.NONE | SWT.WRAP);
        l.setFont(parent.getFont());
        l.setText(text);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        l.setLayoutData(gd);
        return l;
    }

    public static InfoLink createInfoLink(Composite parent, String text, String hoverText, int hspan) {
        InfoLink l = new InfoLink(parent, SWT.NONE);
        l.setFont(parent.getFont());
        l.setText(text);
        l.setHoverText(hoverText);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        gd.grabExcessHorizontalSpace = false;
        l.setLayoutData(gd);
        return l;
    }


    /**
     * Creates a new text widget
     * @param parent the parent composite to add this text widget to
     * @param hspan the horizontal span to take up on the parent composite
     * @return the new text widget
     * @since 3.2
     *
     */
    public static Text createSingleText(Composite parent, int hspan) {
        Text t = new Text(parent, SWT.SINGLE | SWT.BORDER);
        t.setFont(parent.getFont());
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        t.setLayoutData(gd);
        return t;
    }

    /**
     * Creates a new text widget
     * @param parent the parent composite to add this text widget to
     * @param style the style bits for the text widget
     * @param hspan the horizontal span to take up on the parent composite
     * @param fill the fill for the grid layout
     * @return the new text widget
     * @since 3.3
     */
    public static Text createText(Composite parent, int style, int hspan, int fill) {
        return createText(parent, style, hspan, new GridData(fill));
    }

    public static Text createText(Composite parent, int style, int hspan, GridData gd) {
        Text t = new Text(parent, style);
        t.setFont(parent.getFont());
        gd.horizontalSpan = hspan;
        t.setLayoutData(gd);
        return t;
    }

    /**
     * Creates a new text widget
     * @param parent the parent composite to add this text widget to
     * @param style the style bits for the text widget
     * @param hspan the horizontal span to take up on the parent composite
     * @return the new text widget
     * @since 3.3
     */
    public static Text createText(Composite parent, int style, int hspan) {
        Text t = new Text(parent, style);
        t.setFont(parent.getFont());
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        t.setLayoutData(gd);
        return t;
    }

    /**
     * Creates a new text widget
     * @param parent the parent composite to add this text widget to
     * @param style the style bits for the text widget
     * @param hspan the horizontal span to take up on the parent composite
     * @param width the desired width of the text widget
     * @param height the desired height of the text widget
     * @param fill the fill style for the widget
     * @return the new text widget
     * @since 3.3
     */
    public static Text createText(Composite parent, int style, int hspan, int width, int height, int fill) {
        Text t = new Text(parent, style);
        t.setFont(parent.getFont());
        GridData gd = new GridData(fill);
        gd.horizontalSpan = hspan;
        gd.widthHint = width;
        gd.heightHint = height;
        t.setLayoutData(gd);
        return t;
    }

    /**
     * Creates a new styled text widget
     * @param parent the parent composite to add this styled text widget to
     * @param style the style bits for the styled text widget
     * @param hspan the horizontal span to take up on the parent composite
     * @param fill the fill style for the widget
     *        (you may use SWTFactory.FILL_BOTH or SWTFactory.GRAB_AND_FILL_BOTH for convenience)
     * @return the new styled text widget
     * @since 3.9
     */
    public static StyledText createStyledText(Composite parent, int style, int hspan, int fill) {
        StyledText t = new StyledText(parent, style);
        t.setFont(parent.getFont());
        GridData gd = new GridData(fill);
        gd.horizontalSpan = hspan;
        t.setLayoutData(gd);
        return t;
    }

    /**
     * Creates a new styled text widget
     * @param parent the parent composite to add this styled text widget to
     * @param style the style bits for the styled text widget
     * @param hspan the horizontal span to take up on the parent composite
     * @param width the desired width of the styled text widget
     * @param height the desired height of the styled text widget
     * @param fill the fill style for the widget
     *        (you may use SWTFactory.FILL_BOTH or SWTFactory.GRAB_AND_FILL_BOTH for convenience)
     * @return the new styled text widget
     * @since 3.9
     */
    public static StyledText createStyledText(Composite parent, int style, int hspan, int width, int height, int fill) {
        StyledText t = new StyledText(parent, style);
        t.setFont(parent.getFont());
        GridData gd = new GridData(fill);
        gd.horizontalSpan = hspan;
        gd.widthHint = width;
        gd.heightHint = height;
        t.setLayoutData(gd);
        return t;
    }

    /**
     * Creates a new text widget
     * @param parent the parent composite to add this text widget to
     * @param style the style bits for the text widget
     * @param hspan the horizontal span to take up on the parent composite
     * @param text the initial text, not <code>null</code>
     * @return the new text widget
     * @since 3.6
     */
    public static Text createText(Composite parent, int style, int hspan, String text) {
        Text t = new Text(parent, style);
        t.setFont(parent.getFont());
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        t.setLayoutData(gd);
        t.setText(text);
        return t;
    }

    /**
     * Creates a Group widget
     * @param parent the parent composite to add this group to
     * @param text the text for the heading of the group
     * @param columns the number of columns within the group
     * @param hspan the horizontal span the group should take up on the parent
     * @param fill the style for how this composite should fill into its parent
     *        (you may use SWTFactory.FILL_BOTH or SWTFactory.GRAB_AND_FILL_BOTH for convenience)
     * @return the new group
     * @since 3.2
     *
     */
    public static Group createGroup(Composite parent, String text, int columns, int hspan, int fill) {
        return createGroup(parent, text, columns, hspan, new GridData(fill));
    }

    public static Group createGroup(Composite parent, String text, int columns, int hspan, GridData gd) {
        Group g = new Group(parent, SWT.NONE);
        g.setLayout(new GridLayout(columns, false));
        g.setText(text);
        g.setFont(parent.getFont());
        gd.horizontalSpan = hspan;
        g.setLayoutData(gd);
        return g;
    }

    /**
     * Creates a Composite widget
     * @param parent the parent composite to add this composite to
     * @param font the font to set on the control
     * @param columns the number of columns within the composite
     * @param hspan the horizontal span the composite should take up on the parent
     * @param fill the style for how this composite should fill into its parent
     *        (you may use SWTFactory.FILL_BOTH or SWTFactory.GRAB_AND_FILL_BOTH for convenience)
     * @return the new group
     * @since 3.3
     */
    public static Composite createComposite(Composite parent, Font font, int columns, int hspan, int fill) {
        return createComposite(parent, font, columns, hspan, new GridData(fill));
    }

    public static Composite createComposite(Composite parent, Font font, int columns, int hspan, GridData gd) {
        Composite g = new Composite(parent, SWT.NONE);
        g.setLayout(new GridLayout(columns, false));
        g.setFont(font);
        gd.horizontalSpan = hspan;
        g.setLayoutData(gd);
        return g;
    }

    /**
     * Creates an ExpandibleComposite widget
     * @param parent the parent to add this widget to
     * @param style the style for ExpandibleComposite expanding handle, and layout
     * @param label the label for the widget
     * @param hspan how many columns to span in the parent
     * @param fill the fill style for the widget
     * Can be one of <code>GridData.FILL_HORIZONAL</code>, <code>GridData.FILL_BOTH</code> or <code>GridData.FILL_VERTICAL</code>
     * @return a new ExpandibleComposite widget
     * @since 3.6
     */
    public static ExpandableComposite createExpandibleComposite(Composite parent, int style, String label, int hspan, int fill) {
        return createExpandibleComposite(parent, style, label, hspan, new GridData(fill));
    }

    public static ExpandableComposite createExpandibleComposite(Composite parent, int style, String label, int hspan, GridData gd) {
        ExpandableComposite ex = new ExpandableComposite(parent, SWT.NONE, style);
        ex.setText(label);
        ex.setFont(JFaceResources.getFontRegistry().getBold(JFaceResources.DIALOG_FONT));
        gd.horizontalSpan = hspan;
        ex.setLayoutData(gd);
        return ex;
    }

    /**
     * Creates a composite that uses the parent's font and has a grid layout
     * @param parent the parent to add the composite to
     * @param layout grid layout
     * @param gd grid data
     * @return a new composite with a grid layout
     *
     * @since 3.3
     */
    public static Composite createComposite(Composite parent, int columns, GridData gd) {
        Composite g = new Composite(parent, SWT.NONE);
        g.setFont(parent.getFont());
        g.setLayout(new GridLayout(columns, false));
        g.setLayoutData(gd);
        return g;
    }

    /**
     * Creates a composite that uses the parent's font and has a grid layout
     * @param parent the parent to add the composite to
     * @param columns the number of columns the composite should have
     * @param hspan the horizontal span the new composite should take up in the parent
     * @param fill the fill style of the composite {@link GridData}
     *        (you may use SWTFactory.FILL_BOTH or SWTFactory.GRAB_AND_FILL_BOTH for convenience)
     * @return a new composite with a grid layout
     *
     * @since 3.3
     */
    public static Composite createComposite(Composite parent, int columns, int hspan, int fill) {
        Composite g = new Composite(parent, SWT.NONE);
        g.setLayout(new GridLayout(columns, false));
        g.setFont(parent.getFont());
        GridData gd = new GridData(fill);
        gd.horizontalSpan = hspan;
        g.setLayoutData(gd);
        return g;
    }

    /**
     * Creates a vertical spacer for separating components. If applied to a
     * <code>GridLayout</code>, this method will automatically span all of the columns of the parent
     * to make vertical space
     *
     * @param parent the parent composite to add this spacer to
     * @param numlines the number of vertical lines to make as space
     * @since 3.3
     */
    public static void createVerticalSpacer(Composite parent, int numlines) {
        Label lbl = new Label(parent, SWT.NONE);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        Layout layout = parent.getLayout();
        if(layout instanceof GridLayout) {
            gd.horizontalSpan = ((GridLayout)parent.getLayout()).numColumns;
        }
        gd.heightHint = numlines;
        lbl.setLayoutData(gd);
    }

    /**
     * creates a horizontal spacer for separating components
     * @param comp
     * @param numlines
     * @since 3.3
     */
    public static void createHorizontalSpacer(Composite comp, int numlines) {
        Label lbl = new Label(comp, SWT.NONE);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = numlines;
        lbl.setLayoutData(gd);
    }

    /**
     * Creates a Composite widget
     * @param parent the parent composite to add this composite to
     * @param font the font to set on the control
     * @param columns the number of columns within the composite
     * @param hspan the horizontal span the composite should take up on the parent
     * @param fill the style for how this composite should fill into its parent
     *        (you may use SWTFactory.FILL_BOTH or SWTFactory.GRAB_AND_FILL_BOTH for convenience)
     * @param marginwidth the width of the margin to place on the sides of the composite (default is 5, specified by GridLayout)
     * @param marginheight the height of the margin to place o the top and bottom of the composite
     * @return the new composite
     * @since 3.3
     */
    public static Composite createComposite(Composite parent, Font font, int columns, int hspan, int fill, int marginwidth, int marginheight) {
        Composite g = new Composite(parent, SWT.NONE);
        GridLayout layout = new GridLayout(columns, false);
        layout.marginWidth = marginwidth;
        layout.marginHeight = marginheight;
        g.setLayout(layout);
        g.setFont(font);
        GridData gd = new GridData(fill);
        gd.horizontalSpan = hspan;
        g.setLayoutData(gd);
        return g;
    }

    /**
     * Creates a {@link ViewForm}
     * @param parent
     * @param style
     * @param cols
     * @param span
     * @param fill
     * @param marginwidth
     * @param marginheight
     * @return a new {@link ViewForm}
     * @since 3.6
     */
    public static ViewForm createViewform(Composite parent, int style, int cols, int span, int fill, int marginwidth, int marginheight) {
        ViewForm form = new ViewForm(parent, style);
        form.setFont(parent.getFont());
        GridLayout layout = new GridLayout(cols, false);
        layout.marginWidth = marginwidth;
        layout.marginHeight = marginheight;
        form.setLayout(layout);
        GridData gd = new GridData(fill);
        gd.horizontalSpan = span;
        form.setLayoutData(gd);
        return form;
    }

    /**
     * Creates a Composite widget
     * @param parent the parent composite to add this composite to
     * @param font the font to set on the control
     * @param style the style bits for the composite. See {@link Composite} for details on supported style bits
     * @param columns the number of columns within the composite
     * @param hspan the horizontal span the composite should take up on the parent
     * @param fill the style for how this composite should fill into its parent
     *        (you may use SWTFactory.FILL_BOTH or SWTFactory.GRAB_AND_FILL_BOTH for convenience)
     * @param marginwidth the width of the margin to place on the sides of the composite (default is 5, specified by GridLayout)
     * @param marginheight the height of the margin to place o the top and bottom of the composite
     * @return the new composite
     * @since 3.6
     */
    public static Composite createComposite(Composite parent, Font font, int style, int columns, int hspan, int fill, int marginwidth, int marginheight) {
        Composite g = new Composite(parent, style);
        GridLayout layout = new GridLayout(columns, false);
        layout.marginWidth = marginwidth;
        layout.marginHeight = marginheight;
        g.setLayout(layout);
        g.setFont(font);
        GridData gd = new GridData(fill);
        gd.horizontalSpan = hspan;
        g.setLayoutData(gd);
        return g;
    }

    /**
     * This method is used to make a combo box
     * @param parent the parent composite to add the new combo to
     * @param style the style for the Combo
     * @param hspan the horizontal span to take up on the parent composite
     * @param fill how the combo will fill into the composite
     * Can be one of <code>GridData.FILL_HORIZONAL</code>, <code>GridData.FILL_BOTH</code> or <code>GridData.FILL_VERTICAL</code>
     * @param items the item to put into the combo
     * @return a new Combo instance
     * @since 3.3
     */
    public static Combo createCombo(Composite parent, int style, int hspan, int fill, String[] items) {
        return createCombo(parent, style, hspan, new GridData(fill), items);
    }

    public static Combo createCombo(Composite parent, int style, int hspan, GridData gd, String[] items) {
        Combo c = new Combo(parent, style);
        c.setFont(parent.getFont());
        gd.horizontalSpan = hspan;
        c.setLayoutData(gd);
        if (items != null)
            c.setItems(items);
        // Some platforms open up combos in bad sizes without this, see bug 245569
        c.setVisibleItemCount(30);
        c.select(0);
        return c;
    }

    /**
     * This method is used to make a combo box with a default fill style of GridData.FILL_HORIZONTAL
     * @param parent the parent composite to add the new combo to
     * @param style the style for the Combo
     * @param hspan the horizontal span to take up on the parent composite
     * @param items the item to put into the combo
     * @return a new Combo instance
     * @since 3.3
     */
    public static Combo createCombo(Composite parent, int style, int hspan, String[] items) {
        Combo c = new Combo(parent, style);
        c.setFont(parent.getFont());
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        c.setLayoutData(gd);
        if (items != null){
            c.setItems(items);
        }
        // Some platforms open up combos in bad sizes without this, see bug 245569
        c.setVisibleItemCount(30);
        c.select(0);
        return c;
    }

    @SuppressWarnings({ "unchecked", "rawtypes" })
    public static void addComboItemWithValue(Combo combo, String item, Object value) {
        combo.add(item);
        Map map = (Map)combo.getData(COMBO_MAP_KEY);
        if (map == null) {
            map = new HashMap();
            combo.setData(COMBO_MAP_KEY, map);
        }
        map.put(item,  value);
    }

    @SuppressWarnings("unchecked")
    public static void setSelectedComboValue(Combo combo, Object value) {
        Map map = (Map)combo.getData(COMBO_MAP_KEY);
        if (map == null)
            throw new IllegalArgumentException("missing data item in Combo");
        String item = (String)CollectionUtils.findFirstKeyForValue(map, value);
        if (item == null)
            throw new IllegalArgumentException("missing data item in Combo");
        combo.select(combo.indexOf(item));
    }

    @SuppressWarnings("rawtypes")
    public static Object getSelectedComboValue(Combo combo) {
        Map map = (Map)combo.getData(COMBO_MAP_KEY);
        if (map == null)
            throw new IllegalArgumentException("missing data item in Combo");
        int index = combo.getSelectionIndex();
        if (index == -1)
            return null;
        String item = combo.getItem(index);
        return map.containsKey(item) ? map.get(item) : null;
    }

    public static Spinner createSpinner(Composite parent, int style, int hspan) {
        return createSpinner(parent, style, hspan, new GridData());
    }

    public static Spinner createSpinner(Composite parent, int style, int hspan, GridData gd) {
        Spinner c = new Spinner(parent, style);
        c.setFont(parent.getFont());
        gd.horizontalSpan = hspan;
        c.setLayoutData(gd);
        return c;
    }

    public static Spinner configureSpinner(Spinner spinner, int min, int max, int increment, int decimals) {
        spinner.setMinimum(min);
        spinner.setMaximum(max);
        spinner.setIncrement(increment);
        spinner.setDigits(decimals);
        return spinner;
    }

    public static ToolBar createToolbar(Composite parent, int style, int hspan) {
        ToolBar toolbar = new ToolBar(parent, style);
        GridData gd = new GridData(GridData.FILL_HORIZONTAL);
        gd.horizontalSpan = hspan;
        gd.grabExcessHorizontalSpace = false;
        toolbar.setLayoutData(gd);
        return toolbar;
    }

    public static Composite setEqualColumnWidth(Composite c, boolean value) {
        GridLayout l = (GridLayout)c.getLayout();
        l.makeColumnsEqualWidth = value;
        return c;
    }

    /**
     * Sets horizontalIndent on a control.
     */
    public static <T extends Control> T setIndent(T c, int indent) {
        ((GridData)c.getLayoutData()).horizontalIndent = indent;
        return c;
    }

    /**
     * Sets the margin of a composite. Call with zero for composites
     * created solely for grouping.
     */
    public static Composite setMargin(Composite c, int margin) {
        GridLayout l = (GridLayout)c.getLayout();
        l.marginHeight = l.marginWidth = margin;
        return c;
    }

    public static void configureEnablerCheckbox(Button checkButton, Composite group, boolean updateNow) {
        configureEnablerCheckbox(checkButton, new Control[] {group}, updateNow);
    }

    public static void configureEnablerCheckbox(Button checkButton, Control[] slaves, boolean updateNow) {
        checkButton.addSelectionListener(new SelectionAdapter() {
            @Override
            public void widgetSelected(SelectionEvent e) {
                boolean enable = checkButton.getSelection();
                for (Control c : slaves)
                    setEnabled(c, enable, checkButton);
            }
        });
        if (updateNow)
            checkButton.notifyListeners(SWT.Selection, new Event()); // update enablements
    }

    /**
     * Set the enabled state of the given control and recursively all its children,
     * except for the the specified one.
     */
    public static void setEnabled(Control control, boolean enabled, Control except) {
        if (except == null || (control != except && control != except.getParent()))
            control.setEnabled(enabled);
        if (control instanceof Composite)
            for (Control c : ((Composite)control).getChildren())
                setEnabled(c, enabled, except);
    }

    public static Font getSmallFont() {
        if (smallFont == null) {
            FontData baseFontData = JFaceResources.getDialogFont().getFontData()[0];
            String name = baseFontData.getName();
            int height = (7 * baseFontData.getHeight() + 1) / 8;
            FontData fontData = new FontData(name, height, SWT.NONE);
            smallFont = new Font(Display.getCurrent(), fontData);
        }
        return smallFont;
    }

    /**
     * Configures the control to disappear when the mouse is outside the
     * specified container. Returns the installed listener so that it's
     * possible to remove this behavior later by uninstalling the listener.
     */
    public static MouseTrackListener autoHide(Control control, Composite container) {
        MouseTrackListener listener = new MouseTrackAdapter() {
            @Override
            public void mouseExit(MouseEvent e) {
                control.setVisible(false);
            }
            @Override
            public void mouseEnter(MouseEvent e) {
                control.setVisible(true);
            }
        };
        MouseTracker.getInstance().addMouseTrackListener(container, listener);
        control.addDisposeListener((e) -> MouseTracker.getInstance().removeMouseTrackListener(container, listener));
        control.setVisible(MouseTracker.containsMouse(container)); // initial state
        return listener;
    }
}
