root/branches/0.2/controlexample/tab.d

/*******************************************************************************
 * Copyright (c) 2000, 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
module controlexample.tab;

private {
import controlexample.controlexample;
import swt.all;
}


/**
 * <code>Tab</code> is the abstract superclass of every page
 * in the example's tab folder.  Each page in the tab folder
 * describes a control.
 *
 * A Tab itself is not a control but instead provides a
 * hierarchy with which to share code that is common to
 * every page in the folder.
 *
 * A typical page in a Tab contains a two column composite.
 * The left column contains the "Example" group.  The right
 * column contains "Control" group.  The "Control" group
 * contains controls that allow the user to interact with
 * the example control.  The "Control" group typically
 * contains a "Style", "Other" and "Size" group.  Subclasses
 * can override these defaults to augment a group or stop
 * a group from being created.
 */
abstract class Tab {
    /* Common control buttons */
    Button borderButton, enabledButton, visibleButton;
    Button preferredButton, tooSmallButton, smallButton, largeButton, fillButton;
    

    /* Common groups and composites */
    Composite tabFolderPage;
    Group exampleGroup, controlGroup, listenersGroup, otherGroup, sizeGroup, styleGroup, colorGroup;
    
    // <Shawn> listenCheckbox in listenersGroup;
    Button listenCheckbox;
    
    /* Controlling instance_ren */
    ControlExample instance_ren;

    /* Sizing constants for the "Size" group */
    static int TOO_SMALL_SIZE   = 10;
    static int SMALL_SIZE       = 50;
    static int LARGE_SIZE       = 200;
    
    /* Right-to-left support */
    static BOOL RTL_SUPPORT_ENABLE = false;
    Group orientationGroup;
    Button rtlButton, ltrButton, defaultOrietationButton;

    /* Controls and resources for the "Colors" group */
    Button foregroundButton, backgroundButton, fontButton;
    Image foregroundImage, backgroundImage;
    Color foregroundColor, backgroundColor;
    Font font;

    /* Event logging variables and controls */
    Text eventConsole;
    BOOL logging = false;
    BOOL [] eventsFilter;

    static String [] EVENT_NAMES = [
        "KeyDown", "KeyUp",
        "MouseDown", "MouseUp", "MouseMove", "MouseEnter", "MouseExit", "MouseDoubleClick",
        "Paint", "Move", "Resize", "Dispose",
        "Selection", "DefaultSelection",
        "FocusIn", "FocusOut",
        "Expand", "Collapse",
        "Iconify", "Deiconify", "Close",
        "Show", "Hide",
        "Modify", "Verify",
        "Activate", "Deactivate",
        "Help", "DragDetect", "Arm", "Traverse", "MouseHover",
        "HardKeyDown", "HardKeyUp",
        "MenuDetect"
    ];

    /**
     * Creates the Tab within a given instance_ren of ControlExample.
     */
    this(ControlExample instance_ren) {
        this.instance_ren = instance_ren;
    }

    /**
     * Creates the "Control" group.  The "Control" group
     * is typically the right hand column in the tab.
     */
    void createControlGroup () {
    
        /*
         * Create the "Control" group.  This is the group on the
         * right half of each example tab.  It consists of the
         * "Style" group, the "Other" group and the "Size" group.
         */ 
        controlGroup = new Group (tabFolderPage, SWT.NONE);
        controlGroup.setLayout (new GridLayout (2, true));
        controlGroup.setLayoutData (new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_FILL));
        controlGroup.setText (ControlExample.getResourceString("Parameters"));
    
        /* Create individual groups inside the "Control" group */
        createStyleGroup ();
        createOtherGroup ();
        createSizeGroup ();
        createColorGroup ();
        if (RTL_SUPPORT_ENABLE) {
            createOrientationGroup ();
        }
    
        /*
         * For each Button child in the style group, add a selection
         * listener that will recreate the example controls.  If the
         * style group button is a RADIO button, ensure that the radio
         * button is selected before recreating the example controls.
         * When the user selects a RADIO button, the current RADIO
         * button in the group is deselected and the new RADIO button
         * is selected automatically.  The listeners are notified for
         * both these operations but typically only do work when a RADIO
         * button is selected.
         */
         
        void widgetSelected (SelectionEvent event) {
            Tab tab = cast(Tab)event.cData;
            assert(tab);
            if ((event.widget.getStyle () & SWT.RADIO) != 0) {
                if (!(cast(Button) event.widget).getSelection ()) return;
            }
            tab.recreateExampleWidgets ();
        };
     
        
        Control [] children = styleGroup.getChildren ();
        for (int i=0; i<children.length; i++) {
            if ( cast(Button)children[i]) {
                Button button = cast(Button) children [i];
                button.handleSelection (this, &widgetSelected);
            }
        }
        if (RTL_SUPPORT_ENABLE) {
            rtlButton.handleSelection (this, &widgetSelected);
            ltrButton.handleSelection (this, &widgetSelected);      
            defaultOrietationButton.handleSelection (this, &widgetSelected);
        }
    }
    
    /**
     * Creates the "Control" widget children.
     * Subclasses override this method to augment
     * the standard controls created in the "Style",
     * "Other" and "Size" groups.
     */
    void createControlWidgets () {
    }
    
    /**
     * Creates the "Colors" group. This is typically
     * a child of the "Control" group. Subclasses override
     * this method to customize and set system colors.
     */
    void createColorGroup () {
        /* Create the group */
        colorGroup = new Group(controlGroup, SWT.NONE);
        colorGroup.setLayout (new GridLayout (2, false));
        colorGroup.setLayoutData (new GridData (GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_FILL));
        colorGroup.setText (ControlExample.getResourceString ("Colors"));
        Label label = new Label(colorGroup, SWT.NONE);
        label.setText (ControlExample.getResourceString ("Foreground_Color"));
        foregroundButton = new Button (colorGroup, SWT.PUSH);
        label = new Label(colorGroup, SWT.NONE);
        label.setText (ControlExample.getResourceString ("Background_Color"));
        backgroundButton = new Button (colorGroup, SWT.PUSH);
        fontButton = new Button (colorGroup, SWT.PUSH);
        fontButton.setText(ControlExample.getResourceString("Font"));
        fontButton.setLayoutData(new GridData (GridData.HORIZONTAL_ALIGN_FILL));
        Button defaultsButton = new Button (colorGroup, SWT.PUSH);
        defaultsButton.setText(ControlExample.getResourceString("Defaults"));

        Shell shell = controlGroup.getShell ();
        /* Create images to display current colors */
        int imageSize = 12;
        Display display = shell.getDisplay ();
        foregroundImage = new Image (display, imageSize, imageSize);
        backgroundImage = new Image (display, imageSize, imageSize);    

        /* Add listeners to set the colors and font */
        foregroundButton.setImage(foregroundImage); // sets the size of the button      
        foregroundButton.handleSelection(this, delegate(SelectionEvent event) {
            Tab c = cast(Tab)event.cData;
            ColorDialog foregroundDialog = new ColorDialog (c.controlGroup.getShell());
            Color oldColor = c.foregroundColor;
            if (oldColor is null) {
                Control [] controls = c.getExampleWidgets ();
                if (controls.length > 0) oldColor = controls [0].getForeground ();
            }
            if (oldColor !== null) foregroundDialog.setRGB(oldColor.getRGB()); // seed dialog with current color
            RGB rgb = foregroundDialog.open();
            if (rgb is null) return;
            oldColor = c.foregroundColor; // save old foreground color to dispose when done
            c.foregroundColor = new Color (event.display, rgb);
            c.setExampleWidgetForeground ();
            if (oldColor !== null) oldColor.dispose ();
        });
        
        backgroundButton.setImage(backgroundImage); // sets the size of the button
        backgroundButton.handleSelection(this, delegate(SelectionEvent event){
            Tab c = cast(Tab)event.cData;
            ColorDialog backgroundDialog = new ColorDialog (c.controlGroup.getShell());
            Color oldColor = c.backgroundColor;
            if (oldColor is null) {
                Control [] controls = c.getExampleWidgets ();
                if (controls.length > 0) oldColor = controls [0].getBackground (); // seed dialog with current color
            }
            if (oldColor !== null) backgroundDialog.setRGB(oldColor.getRGB());
            RGB rgb = backgroundDialog.open();
            if (rgb is null) return;
            oldColor = c.backgroundColor; // save old background color to dispose when done
            c.backgroundColor = new Color (event.display, rgb);
            c.setExampleWidgetBackground ();
            if (oldColor !== null) oldColor.dispose ();
        });
        
        fontButton.handleSelection(this, delegate(SelectionEvent event){
            Tab c = cast(Tab)event.cData;
            FontDialog fontDialog = new FontDialog (c.controlGroup.getShell());
            Font oldFont = c.font;
            if (oldFont is null) {
                Control [] controls = c.getExampleWidgets ();
                if (controls.length > 0) oldFont = controls [0].getFont ();
            }
            if (oldFont !== null) fontDialog.setFontList(oldFont.getFontData()); // seed dialog with current font
            FontData fontData = fontDialog.open ();
            if (fontData is null) return;
            oldFont = c.font; // dispose old font when done
            c.font = new Font (event.display, fontData);
            c.setExampleWidgetFont ();
            c.setExampleWidgetSize ();
            if (oldFont !== null) oldFont.dispose ();       
        });
        defaultsButton.handleEvent(this, SWT.Selection, &resetColorsAndFonts);

        shell.handleEvent(this, SWT.Selection, delegate(Event e) {
            Tab tab = cast(Tab)e.cData;
            if (tab.foregroundImage !== null) tab.foregroundImage.dispose();
            if (tab.backgroundImage !== null) tab.backgroundImage.dispose();
            if (tab.foregroundColor !== null) tab.foregroundColor.dispose();
            if (tab.backgroundColor !== null) tab.backgroundColor.dispose();
            if (tab.font !== null) font.dispose();
            tab.foregroundColor = null;
            tab.backgroundColor = null;
            tab.font = null;                
        });
    }
    
    /**
     * Creates the "Other" group.  This is typically
     * a child of the "Control" group.
     */
    void createOtherGroup () {
        /* Create the group */
        otherGroup = new Group (controlGroup, SWT.NONE);
        otherGroup.setLayout (new GridLayout ());
        otherGroup.setLayoutData (new GridData (GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_FILL));
        otherGroup.setText (ControlExample.getResourceString("Other"));
    
        /* Create the controls */
        enabledButton = new Button(otherGroup, SWT.CHECK);
        enabledButton.setText(ControlExample.getResourceString("Enabled"));
        visibleButton = new Button(otherGroup, SWT.CHECK);
        visibleButton.setText(ControlExample.getResourceString("Visible"));
    
        /* Add the listeners */
        enabledButton.handleEvent(this, SWT.Selection, &setExampleWidgetEnabled);
        visibleButton.handleEvent(this, SWT.Selection, &setExampleWidgetVisibility);
    
        /* Set the default state */
        enabledButton.setSelection(true);
        visibleButton.setSelection(true);
    }
    
    /**
     * Create the event console popup menu.
     */
    void createEventConsolePopup () {
        Menu popup = new Menu (eventConsole.getShell (), SWT.POP_UP);
        eventConsole.setMenu (popup);

        MenuItem cut = new MenuItem (popup, SWT.PUSH);
        cut.setText (ControlExample.getResourceString("MenuItem_Cut"));
        cut.handleEvent (eventConsole, SWT.Selection, delegate(Event e){
            Text txt = cast(Text)e.cData;
            txt.cut();
        });
        
        MenuItem copy = new MenuItem (popup, SWT.PUSH);
        copy.setText (ControlExample.getResourceString("MenuItem_Copy"));
        copy.handleEvent(eventConsole, SWT.Selection, delegate(Event e){
            Text txt = cast(Text)e.cData;
            txt.copy();
        });
        
        MenuItem paste = new MenuItem (popup, SWT.PUSH);
        paste.setText (ControlExample.getResourceString("MenuItem_Paste"));
        paste.handleEvent(eventConsole, SWT.Selection, delegate(Event e){
            Text txt = cast(Text)e.cData;
            txt.paste();
        });
        new MenuItem (popup, SWT.SEPARATOR);
        MenuItem selectAll = new MenuItem (popup, SWT.PUSH);
        selectAll.setText(ControlExample.getResourceString("MenuItem_SelectAll"));
        selectAll.handleEvent(eventConsole, SWT.Selection, delegate(Event e){
            Text txt = cast(Text)e.cData;
            txt.selectAll();
        });
    }

    /**
     * Creates the "Example" group.  The "Example" group
     * is typically the left hand column in the tab.
     */
    void createExampleGroup () {
        exampleGroup = new Group (tabFolderPage, SWT.NONE);
        GridLayout gridLayout = new GridLayout ();
        exampleGroup.setLayout (gridLayout);
        exampleGroup.setLayoutData (new GridData (GridData.FILL_BOTH));
    }
    
    /**
     * Creates the "Example" widget children of the "Example" group.
     * Subclasses override this method to create the particular
     * example control.
     */
    void createExampleWidgets () {
        /* Do nothing */
    }
    
    /**
     * Creates and opens the "Listener selection" dialog.
     */
    void createListenerSelectionDialog () {
        Shell dialog = new Shell (tabFolderPage.getShell (), SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL);
        dialog.setText (ControlExample.getResourceString ("Select_Listeners"));
        dialog.setLayout (new GridLayout (2, false));
        Table table = new Table (dialog, SWT.BORDER | SWT.V_SCROLL | SWT.CHECK);
        GridData data = new GridData(GridData.FILL_BOTH);
        data.verticalSpan = 2;
        table.setLayoutData(data);
        for (int i = 0; i < EVENT_NAMES.length; i++) {
            TableItem item = new TableItem (table, SWT.NONE);
            item.setText (EVENT_NAMES[i]);
            item.setChecked (eventsFilter[i]);
        }
        String [] customNames = getCustomEventNames ();
        for (int i = 0; i < customNames.length; i++) {
            TableItem item = new TableItem (table, SWT.NONE);
            item.setText (customNames[i]);
            item.setChecked (eventsFilter[EVENT_NAMES.length + i]);
        }
        
        Button selectAll = new Button (dialog, SWT.PUSH);
        selectAll.setText(ControlExample.getResourceString ("Select_All"));
        selectAll.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL));
        selectAll.handleSelection(this, delegate(SelectionEvent e){
            Tab c = cast(Tab)e.cData;
            TableItem [] items = table.getItems();
            for (int i = 0; i < c.EVENT_NAMES.length; i++) {
                items[i].setChecked(true);
            }
            for (int i = 0; i < c.getCustomEventNames().length; i++) {
                items[c.EVENT_NAMES.length + i].setChecked(true);
            }
        });

        
        Button deselectAll = new Button (dialog, SWT.PUSH);
        deselectAll.setText(ControlExample.getResourceString ("Deselect_All"));
        deselectAll.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_BEGINNING));
        deselectAll.handleSelection(this, delegate(SelectionEvent e){
            Tab c = cast(Tab)e.cData;
            TableItem [] items = table.getItems();
            for (int i = 0; i < c.EVENT_NAMES.length; i++) {
                items[i].setChecked(false);
            }
            for (int i = 0; i < c.getCustomEventNames().length; i++) {
                items[c.EVENT_NAMES.length + i].setChecked(false);
            }
        });
        
        Label filler = new Label(dialog, SWT.NONE);
        Button ok = new Button (dialog, SWT.PUSH);
        ok.setText(ControlExample.getResourceString ("OK"));
        dialog.setDefaultButton(ok);
        ok.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL));
        ok.handleSelection(this, delegate(SelectionEvent e){
            Tab t = cast(Tab)e.cData;
            TableItem [] items = table.getItems();
            for (int i = 0; i < t.EVENT_NAMES.length; i++) {
                eventsFilter[i] = items[i].getChecked();
            }
            for (int i = 0; i < t.getCustomEventNames().length; i++) {
                eventsFilter[t.EVENT_NAMES.length + i] = items[t.EVENT_NAMES.length + i].getChecked();
            }
            dialog.dispose();
        });
        
        dialog.pack ();
        dialog.open ();
        while (! dialog.isDisposed()) {
            if (! dialog.getDisplay().readAndDispatch()) 
                dialog.getDisplay().sleep();
        }
    }

    /**
     * Creates the "Listeners" group.  The "Listeners" group
     * goes below the "Example" and "Control" groups.
     */
    void createListenersGroup () {
        listenersGroup = new Group (tabFolderPage, SWT.NONE);
        listenersGroup.setLayout (new GridLayout (3, false));
        GridData gridData = new GridData (GridData.HORIZONTAL_ALIGN_FILL | GridData.FILL_VERTICAL);
        gridData.horizontalSpan = 2;
        listenersGroup.setLayoutData (gridData);
        listenersGroup.setText (ControlExample.getResourceString ("Listeners"));

        /*
         * Create the button to access the 'Listeners' dialog.
         */
        Button listenersButton = new Button (listenersGroup, SWT.PUSH);
        listenersButton.setText (ControlExample.getResourceString ("Select_Listeners"));
        listenersButton.handleSelection(this, delegate(SelectionEvent e){
            Tab c = cast(Tab)e.cData;
            c.createListenerSelectionDialog ();
            c.recreateExampleWidgets ();
        });
        
        /*
         * Create the checkbox to add/remove listeners to/from the example widgets.
         */
        listenCheckbox = new Button (listenersGroup, SWT.CHECK);
        listenCheckbox.setText (ControlExample.getResourceString ("Listen"));
        void onListCheckbox(SelectionEvent e){
            Tab c = cast(Tab)e.cData;
            c.logging = c.listenCheckbox.getSelection ();
            c.recreateExampleWidgets ();
        }
        listenCheckbox.handleSelection(this, &onListCheckbox);
        /*
         * Create the button to clear the text.
         */
        Button clearButton = new Button (listenersGroup, SWT.PUSH);
        clearButton.setText (ControlExample.getResourceString ("Clear"));
        clearButton.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_END));
        clearButton.handleSelection(this, delegate(SelectionEvent e){
            Tab c = cast(Tab)e.cData;
            c.eventConsole.setText ("");
        });
        
        /* Initialize the eventsFilter to log all events. */
        int customEventCount = getCustomEventNames ().length;
        eventsFilter = new BOOL [EVENT_NAMES.length + customEventCount];
        for (int i = 0; i < EVENT_NAMES.length + customEventCount; i++) {
            eventsFilter [i] = true;
        }

        /* Create the event console Text. */
        eventConsole = new Text (listenersGroup, SWT.BORDER | SWT.MULTI | SWT.V_SCROLL | SWT.H_SCROLL);
        GridData data = new GridData (GridData.FILL_BOTH);
        data.horizontalSpan = 3;
        data.heightHint = 80;
        eventConsole.setLayoutData (data);
        createEventConsolePopup ();

        eventConsole.handleKeyDown(this, delegate(KeyEvent e) {
            Tab c = cast(Tab)e.cData;
            if ((e.keyCode == 'A' || e.keyCode == 'a') && (e.stateMask & SWT.MOD1) != 0) {
                c.eventConsole.selectAll ();
                e.doit = false;
            }