/*******************************************************************************
* Copyright (c) 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
*******************************************************************************/
package org.eclipse.jface.internal.text;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.StyleRange;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.graphics.TextLayout;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
/**
* Adds owner draw support for tables.
*
* @since 3.4
*/
public class TableOwnerDrawSupport implements Listener {
private static final String STYLED_RANGES_KEY= "styled_ranges"; //$NON-NLS-1$
private TextLayout fLayout;
public static void install(Table table) {
TableOwnerDrawSupport listener= new TableOwnerDrawSupport(table);
table.addListener(SWT.Dispose, listener);
table.addListener(SWT.MeasureItem, listener);
table.addListener(SWT.EraseItem, listener);
table.addListener(SWT.PaintItem, listener);
}
/**
* Stores the styled ranges in the given table item.
*
* @param item table item
* @param column the column index
* @param ranges the styled ranges or <code>null</code> to remove them
*/
public static void storeStyleRanges(TableItem item, int column, StyleRange[] ranges) {
item.setData(STYLED_RANGES_KEY + column, ranges);
}
/**
* Returns the styled ranges which are stored in the given table item.
*
* @param item table item
* @param column the column index
* @return the styled ranges
*/
private static StyleRange[] getStyledRanges(TableItem item, int column) {
return (StyleRange[])item.getData(STYLED_RANGES_KEY + column);
}
private TableOwnerDrawSupport(Table table) {
int orientation= table.getStyle() & (SWT.LEFT_TO_RIGHT | SWT.RIGHT_TO_LEFT);
fLayout= new TextLayout(table.getDisplay());
fLayout.setOrientation(orientation);
}
/*
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
public void handleEvent(Event event) {
switch (event.type) {
case SWT.MeasureItem:
break;
case SWT.EraseItem:
event.detail &= ~SWT.FOREGROUND;
break;
case SWT.PaintItem:
performPaint(event);
break;
case SWT.Dispose:
widgetDisposed();
break;
}
}
/**
* Performs the paint operation.
*
* @param event the event
*/
private void performPaint(Event event) {
TableItem item= (TableItem) event.item;
GC gc= event.gc;
int index= event.index;
boolean isSelected= (event.detail & SWT.SELECTED) != 0;
// Remember colors to restore the GC later
Color oldForeground= gc.getForeground();
Color oldBackground= gc.getBackground();
if (!isSelected) {
Color foreground= item.getForeground(index);
gc.setForeground(foreground);
Color background= item.getBackground(index);
gc.setBackground(background);
}
Image image=item.getImage(index);
if (image != null) {
Rectangle imageBounds=item.getImageBounds(index);
Rectangle bounds=image.getBounds();
int x=imageBounds.x + Math.max(0, (imageBounds.width - bounds.width) / 2);
int y=imageBounds.y + Math.max(0, (imageBounds.height - bounds.height) / 2);
gc.drawImage(image, x, y);
}
fLayout.setFont(item.getFont(index));
// XXX: needed to clear the style info, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=226090
fLayout.setText(""); //$NON-NLS-1$
fLayout.setText(item.getText(index));
StyleRange[] ranges= getStyledRanges(item, index);
if (ranges != null) {
for (int i= 0; i < ranges.length; i++) {
StyleRange curr= ranges[i];
if (isSelected) {
curr= (StyleRange) curr.clone();
curr.foreground= null;
curr.background= null;
}
fLayout.setStyle(curr, curr.start, curr.start + curr.length - 1);
}
}
Rectangle textBounds=item.getTextBounds(index);
if (textBounds != null) {
Rectangle layoutBounds=fLayout.getBounds();
int x=textBounds.x;
int y=textBounds.y + Math.max(0, (textBounds.height - layoutBounds.height) / 2);
fLayout.draw(gc, x, y);
}
if ((event.detail & SWT.FOCUSED) != 0) {
Rectangle focusBounds=item.getBounds();
gc.drawFocus(focusBounds.x, focusBounds.y, focusBounds.width, focusBounds.height);
}
if (!isSelected) {
gc.setForeground(oldForeground);
gc.setBackground(oldBackground);
}
}
private void widgetDisposed() {
fLayout.dispose();
}
}