root/dwt/custom/CTabItem.d

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module dwt.custom.CTabItem;

import dwt.dwthelper.utils;



import dwt.DWT;
import dwt.DWTException;
import dwt.graphics.Color;
import dwt.graphics.Font;
import dwt.graphics.GC;
import dwt.graphics.Image;
import dwt.graphics.Point;
import dwt.graphics.RGB;
import dwt.graphics.Rectangle;
import dwt.graphics.TextLayout;
import dwt.widgets.Control;
import dwt.widgets.Display;
import dwt.widgets.Item;
import dwt.widgets.Widget;
import dwt.custom.CTabFolder;

/**
 * Instances of this class represent a selectable user interface object
 * that represent a page in a notebook widget.
 *
 * <dl>
 * <dt><b>Styles:</b></dt>
 * <dd>DWT.CLOSE</dd>
 * <dt><b>Events:</b></dt>
 * <dd>(none)</dd>
 * </dl>
 * <p>
 * IMPORTANT: This class is <em>not</em> intended to be subclassed.
 * </p>
 *
 * @see <a href="http://www.eclipse.org/swt/snippets/#ctabfolder">CTabFolder, CTabItem snippets</a>
 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 */
public class CTabItem : Item {
    CTabFolder parent;
    int x,y,width,height = 0;
    Control control; // the tab page

    String toolTipText;
    String shortenedText;
    int shortenedTextWidth;

    // Appearance
    Font font;
    Image disabledImage;

    Rectangle closeRect;
    int closeImageState = CTabFolder.NONE;
    bool showClose = false;
    bool showing = false;

    // internal constants
    static final int TOP_MARGIN = 2;
    static final int BOTTOM_MARGIN = 2;
    static final int LEFT_MARGIN = 4;
    static final int RIGHT_MARGIN = 4;
    static final int INTERNAL_SPACING = 4;
    static final int FLAGS = DWT.DRAW_TRANSPARENT | DWT.DRAW_MNEMONIC;
    static final String ELLIPSIS = "..."; //$NON-NLS-1$ // could use the ellipsis glyph on some platforms "\u2026"

/**
 * Constructs a new instance of this class given its parent
 * (which must be a <code>CTabFolder</code>) and a style value
 * describing its behavior and appearance. The item is added
 * to the end of the items maintained by its parent.
 * <p>
 * The style value is either one of the style constants defined in
 * class <code>DWT</code> which is applicable to instances of this
 * class, or must be built by <em>bitwise OR</em>'ing together
 * (that is, using the <code>int</code> "|" operator) two or more
 * of those <code>DWT</code> style constants. The class description
 * lists the style constants that are applicable to the class.
 * Style bits are also inherited from superclasses.
 * </p>
 *
 * @param parent a CTabFolder which will be the parent of the new instance (cannot be null)
 * @param style the style of control to construct
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
 * </ul>
 * @exception DWTException <ul>
 *    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
 * </ul>
 *
 * @see DWT
 * @see Widget#getStyle()
 */
public this (CTabFolder parent, int style) {
    this(parent, style, parent.getItemCount());
}
/**
 * Constructs a new instance of this class given its parent
 * (which must be a <code>CTabFolder</code>), a style value
 * describing its behavior and appearance, and the index
 * at which to place it in the items maintained by its parent.
 * <p>
 * The style value is either one of the style constants defined in
 * class <code>DWT</code> which is applicable to instances of this
 * class, or must be built by <em>bitwise OR</em>'ing together
 * (that is, using the <code>int</code> "|" operator) two or more
 * of those <code>DWT</code> style constants. The class description
 * lists the style constants that are applicable to the class.
 * Style bits are also inherited from superclasses.
 * </p>
 *
 * @param parent a CTabFolder which will be the parent of the new instance (cannot be null)
 * @param style the style of control to construct
 * @param index the zero-relative index to store the receiver in its parent
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
 *    <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li>
 * </ul>
 * @exception DWTException <ul>
 *    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
 * </ul>
 *
 * @see DWT
 * @see Widget#getStyle()
 */
public this (CTabFolder parent, int style, int index) {
    closeRect = new Rectangle(0, 0, 0, 0);
    super (parent, style);
    showClose = (style & DWT.CLOSE) !is 0;
    parent.createItem (this, index);
}

/*
 * Return whether to use ellipses or just truncate labels
 */
bool useEllipses() {
    return parent.simple;
}

String shortenText(GC gc, String text, int width) {
    return useEllipses()
        ? shortenText(gc, text, width, ELLIPSIS)
        : shortenText(gc, text, width, ""); //$NON-NLS-1$
}

String shortenText(GC gc, String text, int width, String ellipses) {
    if (gc.textExtent(text, FLAGS).x <= width) return text;
    int ellipseWidth = gc.textExtent(ellipses, FLAGS).x;
    int length = text.length;
    TextLayout layout = new TextLayout(getDisplay());
    layout.setText(text);
    int end = layout.getPreviousOffset(length, DWT.MOVEMENT_CLUSTER);
    while (end > 0) {
        text = text[ 0 .. end ];
        int l = gc.textExtent(text, FLAGS).x;
        if (l + ellipseWidth <= width) {
            break;
        }
        end = layout.getPreviousOffset(end, DWT.MOVEMENT_CLUSTER);
    }
    layout.dispose();
    return end is 0 ? text.substring(0, 1) : text ~ ellipses;
}

public override void dispose() {
    if (isDisposed ()) return;
    //if (!isValidThread ()) error (DWT.ERROR_THREAD_INVALID_ACCESS);
    parent.destroyItem(this);
    super.dispose();
    parent = null;
    control = null;
    toolTipText = null;
    shortenedText = null;
    font = null;
}
void drawClose(GC gc) {
    if (closeRect.width is 0 || closeRect.height is 0) return;
    Display display = getDisplay();

    // draw X 9x9
    int indent = Math.max(1, (CTabFolder.BUTTON_SIZE-9)/2);
    int x = closeRect.x + indent;
    int y = closeRect.y + indent;
    y += parent.onBottom ? -1 : 1;

    Color closeBorder = display.getSystemColor(CTabFolder.BUTTON_BORDER);
    switch (closeImageState) {
        case CTabFolder.NORMAL: {
            int[] shape = [x,y, x+2,y, x+4,y+2, x+5,y+2, x+7,y, x+9,y,
                                     x+9,y+2, x+7,y+4, x+7,y+5, x+9,y+7, x+9,y+9,
                                     x+7,y+9, x+5,y+7, x+4,y+7, x+2,y+9, x,y+9,
                                     x,y+7, x+2,y+5, x+2,y+4, x,y+2];
            gc.setBackground(display.getSystemColor(CTabFolder.BUTTON_FILL));
            gc.fillPolygon(shape);
            gc.setForeground(closeBorder);
            gc.drawPolygon(shape);
            break;
        }
        case CTabFolder.HOT: {
            int[] shape = [x,y, x+2,y, x+4,y+2, x+5,y+2, x+7,y, x+9,y,
                                     x+9,y+2, x+7,y+4, x+7,y+5, x+9,y+7, x+9,y+9,
                                     x+7,y+9, x+5,y+7, x+4,y+7, x+2,y+9, x,y+9,
                                     x,y+7, x+2,y+5, x+2,y+4, x,y+2];
            Color fill = new Color(display, CTabFolder.CLOSE_FILL);
            gc.setBackground(fill);
            gc.fillPolygon(shape);
            fill.dispose();
            gc.setForeground(closeBorder);
            gc.drawPolygon(shape);
            break;
        }
        case CTabFolder.SELECTED: {
            int[] shape = [x+1,y+1, x+3,y+1, x+5,y+3, x+6,y+3, x+8,y+1, x+10,y+1,
                                     x+10,y+3, x+8,y+5, x+8,y+6, x+10,y+8, x+10,y+10,
                                     x+8,y+10, x+6,y+8, x+5,y+8, x+3,y+10, x+1,y+10,
                                     x+1,y+8, x+3,y+6, x+3,y+5, x+1,y+3];
            Color fill = new Color(display, CTabFolder.CLOSE_FILL);
            gc.setBackground(fill);
            gc.fillPolygon(shape);
            fill.dispose();
            gc.setForeground(closeBorder);
            gc.drawPolygon(shape);
            break;
        }
        case CTabFolder.NONE: {
            int[] shape = [x,y, x+10,y, x+10,y+10, x,y+10];
            if (parent.gradientColors !is null && !parent.gradientVertical) {
                parent.drawBackground(gc, shape, false);
            } else {
                Color defaultBackground = parent.getBackground();
                Image image = parent.bgImage;
                Color[] colors = parent.gradientColors;
                int[] percents = parent.gradientPercents;
                bool vertical = parent.gradientVertical;
                parent.drawBackground(gc, shape, x, y, 10, 10, defaultBackground, image, colors, percents, vertical);
            }
            break;
        }
        default:
    }
}
void drawSelected(GC gc ) {
    Point size = parent.getSize();
    int rightEdge = Math.min (x + width, parent.getRightItemEdge());

    //   Draw selection border across all tabs
    int xx = parent.borderLeft;
    int yy = parent.onBottom ? size.y - parent.borderBottom - parent.tabHeight - parent.highlight_header : parent.borderTop + parent.tabHeight + 1;
    int ww = size.x - parent.borderLeft - parent.borderRight;
    int hh = parent.highlight_header - 1;
    int[] shape = [xx,yy, xx+ww,yy, xx+ww,yy+hh, xx,yy+hh];
    if (parent.selectionGradientColors !is null && !parent.selectionGradientVertical) {
        parent.drawBackground(gc, shape, true);
    } else {
        gc.setBackground(parent.selectionBackground);
        gc.fillRectangle(xx, yy, ww, hh);
    }

    if (parent.single) {
        if (!showing) return;
    } else {
        // if selected tab scrolled out of view or partially out of view
        // just draw bottom line
        if (!showing){
            int x1 = Math.max(0, parent.borderLeft - 1);
            int y1 = (parent.onBottom) ? y - 1 : y + height;
            int x2 = size.x - parent.borderRight;
            gc.setForeground(CTabFolder.borderColor);
            gc.drawLine(x1, y1, x2, y1);
            return;
        }

        // draw selected tab background and outline
        shape = null;
        if (this.parent.onBottom) {
            int[] left = parent.simple ? CTabFolder.SIMPLE_BOTTOM_LEFT_CORNER : CTabFolder.BOTTOM_LEFT_CORNER;
            int[] right = parent.simple ? CTabFolder.SIMPLE_BOTTOM_RIGHT_CORNER : parent.curve;
            if (parent.borderLeft is 0 && parent.indexOf(this) is parent.firstIndex) {
                left = [x, y+height];
            }
            shape = new int[left.length+right.length+8];
            int index = 0;
            shape[index++] = x; // first point repeated here because below we reuse shape to draw outline
            shape[index++] = y - 1;
            shape[index++] = x;
            shape[index++] = y - 1;
            for (int i = 0; i < left.length/2; i++) {
                shape[index++] = x + left[2*i];
                shape[index++] = y + height + left[2*i+1] - 1;
            }
            for (int i = 0; i < right.length/2; i++) {
                shape[index++] = parent.simple ? rightEdge - 1 + right[2*i] : rightEdge - parent.curveIndent + right[2*i];
                shape[index++] = parent.simple ? y + height + right[2*i+1] - 1 : y + right[2*i+1] - 2;
            }
            shape[index++] = parent.simple ? rightEdge - 1 : rightEdge + parent.curveWidth - parent.curveIndent;
            shape[index++] = y - 1;
            shape[index++] = parent.simple ? rightEdge - 1 : rightEdge + parent.curveWidth - parent.curveIndent;
            shape[index++] = y - 1;
        } else {
            int[] left = parent.simple ? CTabFolder.SIMPLE_TOP_LEFT_CORNER : CTabFolder.TOP_LEFT_CORNER;
            int[] right = parent.simple ? CTabFolder.SIMPLE_TOP_RIGHT_CORNER : parent.curve;
            if (parent.borderLeft is 0 && parent.indexOf(this) is parent.firstIndex) {
                left = [x, y];
            }
            shape = new int[left.length+right.length+8];
            int index = 0;
            shape[index++] = x; // first point repeated here because below we reuse shape to draw outline
            shape[index++] = y + height + 1;
            shape[index++] = x;
            shape[index++] = y + height + 1;
            for (int i = 0; i < left.length/2; i++) {
                shape[index++] = x + left[2*i];
                shape[index++] = y + left[2*i+1];
            }
            for (int i = 0; i < right.length/2; i++) {
                shape[index++] = parent.simple ? rightEdge - 1 + right[2*i] : rightEdge - parent.curveIndent + right[2*i];
                shape[index++] = y + right[2*i+1];
            }
            shape[index++] = parent.simple ? rightEdge - 1 : rightEdge + parent.curveWidth - parent.curveIndent;
            shape[index++] = y + height + 1;
            shape[index++] = parent.simple ? rightEdge - 1 : rightEdge + parent.curveWidth - parent.curveIndent;
            shape[index++] = y + height + 1;
        }

        Rectangle clipping = gc.getClipping();
        Rectangle bounds = getBounds();
        bounds.height += 1;
        if (parent.onBottom) bounds.y -= 1;
        bool tabInPaint = clipping.intersects(bounds);

        if (tabInPaint) {
            // fill in tab background
            if (parent.selectionGradientColors !is null && !parent.selectionGradientVertical) {
                parent.drawBackground(gc, shape, true);
            } else {
                Color defaultBackground = parent.selectionBackground;
                Image image = parent.selectionBgImage;
                Color[] colors = parent.selectionGradientColors;
                int[] percents = parent.selectionGradientPercents;
                bool vertical = parent.selectionGradientVertical;
                xx = x;
                yy = parent.onBottom ? y -1 : y + 1;
                ww = width;
                hh = height;
                if (!parent.single && !parent.simple) ww += parent.curveWidth - parent.curveIndent;
                parent.drawBackground(gc, shape, xx, yy, ww, hh, defaultBackground, image, colors, percents, vertical);
            }
        }

        //Highlight MUST be drawn before the outline so that outline can cover it in the right spots (start of swoop)
        //otherwise the curve looks jagged
        drawHighlight(gc, rightEdge);

        // draw outline
        shape[0] = Math.max(0, parent.borderLeft - 1);
        if (parent.borderLeft is 0 && parent.indexOf(this) is parent.firstIndex) {
            shape[1] = parent.onBottom ? y + height - 1 : y;
            shape[5] = shape[3] = shape[1];
        }
        shape[shape.length - 2] = size.x - parent.borderRight + 1;
        for (int i = 0; i < shape.length/2; i++) {
            if (shape[2*i + 1] is y + height + 1) shape[2*i + 1] -= 1;
        }
        RGB inside = parent.selectionBackground.getRGB();
        if (parent.selectionBgImage !is null ||
            (parent.selectionGradientColors !is null && parent.selectionGradientColors.length > 1)) {
            inside = null;
        }
        RGB outside = parent.getBackground().getRGB();
        if (parent.bgImage !is null ||
            (parent.gradientColors !is null && parent.gradientColors.length > 1)) {
            outside = null;
        }
        parent.antialias(shape, CTabFolder.borderColor.getRGB(), inside, outside, gc);
        gc.setForeground(CTabFolder.borderColor);
        gc.drawPolyline(shape);

        if (!tabInPaint) return;
    }

    // draw Image
    int xDraw = x + LEFT_MARGIN;
    if (parent.single && (parent.showClose || showClose)) xDraw += CTabFolder.BUTTON_SIZE;
    Image image = getImage();
    if (image !is null) {
        Rectangle imageBounds = image.getBounds();
        // only draw image if it won't overlap with close button
        int maxImageWidth = rightEdge - xDraw - RIGHT_MARGIN;
        if (!parent.single && closeRect.width > 0) maxImageWidth -= closeRect.width + INTERNAL_SPACING;
        if (imageBounds.width < maxImageWidth) {
            int imageX = xDraw;
            int imageY = y + (height - imageBounds.height) / 2;
            imageY += parent.onBottom ? -1 : 1;
            gc.drawImage(image, imageX, imageY);
            xDraw += imageBounds.width + INTERNAL_SPACING;
        }
    }

    // draw Text
    int textWidth = rightEdge - xDraw - RIGHT_MARGIN;
    if (!parent.single && closeRect.width > 0) textWidth -= closeRect.width + INTERNAL_SPACING;
    if (textWidth > 0) {
        Font gcFont = gc.getFont();
        gc.setFont(font is null ? parent.getFont() : font);

        if (shortenedText is null || shortenedTextWidth !is textWidth) {
            shortenedText = shortenText(gc, getText(), textWidth);
            shortenedTextWidth = textWidth;
        }
        Point extent = gc.textExtent(shortenedText, FLAGS);
        int textY = y + (height - extent.y) / 2;
        textY += parent.onBottom ? -1 : 1;

        gc.setForeground(parent.selectionForeground);
        gc.drawText(shortenedText, xDraw, textY, FLAGS);
        gc.setFont(gcFont);

        // draw a Focus rectangle
        if (parent.isFocusControl()) {
            Display display = getDisplay();
            if (parent.simple || parent.single) {
                gc.setBackground(display.getSystemColor(DWT.COLOR_BLACK));
                gc.setForeground(display.getSystemC