org.eclipse.jface.layout.TableColumnLayout.java Source code

Introduction

Here is the source code for org.eclipse.jface.layout.TableColumnLayout.java

Source

/*******************************************************************************
 * Copyright (c) 2007, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *       Tom Schindl <tom.schindl@bestsolution.at> - initial API and implementation
 *                                               - fix for bug 178280
 *     IBM Corporation - API refactoring and general maintenance
 *******************************************************************************/

package org.eclipse.jface.layout;

import org.eclipse.jface.viewers.ColumnLayoutData;
import org.eclipse.jface.viewers.ColumnPixelData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Layout;
import org.eclipse.swt.widgets.Scrollable;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.Widget;

/**
 * The TableColumnLayout is the {@link Layout} used to maintain
 * {@link TableColumn} sizes in a {@link Table}.
 *
 * <p>
 * <b>You can only add the {@link Layout} to a container whose <i>only</i> child
 * is the {@link Table} control you want the {@link Layout} applied to. Don't
 * assign the layout directly the {@link Table}</b>
 * </p>
 *
 * @since 3.3
 */
public class TableColumnLayout extends AbstractColumnLayout {

    /**
     * Creates a new table column layout.
     */
    public TableColumnLayout() {
    }

    /**
     * Creates a new table column layout.
     *
     * @param adjustForScrollBar
     *            <code>true</code> if the layout should reserve space for the
     *            vertical scroll bar
     * @since 3.12
     */
    public TableColumnLayout(boolean adjustForScrollBar) {
        super(adjustForScrollBar);
    }

    /**
     * {@inheritDoc}
     *
     * @since 3.5
     */
    @Override
    protected int getColumnCount(Scrollable tableTree) {
        return ((Table) tableTree).getColumnCount();
    }

    /**
     * {@inheritDoc}
     *
     * @since 3.5
     */
    @Override
    protected void setColumnWidths(Scrollable tableTree, int[] widths) {
        TableColumn[] columns = ((Table) tableTree).getColumns();
        for (int i = 0; i < widths.length; i++) {
            columns[i].setWidth(widths[i]);
        }
    }

    /**
     * {@inheritDoc}
     *
     * @since 3.5
     */
    @Override
    protected ColumnLayoutData getLayoutData(Scrollable tableTree, int columnIndex) {
        TableColumn column = ((Table) tableTree).getColumn(columnIndex);
        return (ColumnLayoutData) column.getData(LAYOUT_DATA);
    }

    Composite getComposite(Widget column) {
        return ((TableColumn) column).getParent().getParent();
    }

    /**
     * @since 3.5
     */
    @Override
    protected void updateColumnData(Widget column) {
        TableColumn tColumn = (TableColumn) column;
        Table t = tColumn.getParent();

        if (!IS_GTK || t.getColumn(t.getColumnCount() - 1) != tColumn) {
            tColumn.setData(LAYOUT_DATA, new ColumnPixelData(tColumn.getWidth()));
            layout(t.getParent(), true);
        }
    }
}