2014-08-17

SWT による GUI プログラミング (7) - NatTable のサンプル (2)

NatTable をネットで見つけて、これを使えるようにするには時間を書ける必要があると見積もり、夏休みが始まるのを首を長くして待っていました。

NatTable を利用するには、まず SWT/JFace を理解しておく必要があると考え、休みの前半にはそこそこ理解できたと思えるようになりました。そこで、そろそろ NatTable に取り組めるだろうと判断し、サンプルプログラムを眺めながら内容の理解を始めました。

いろいろと迷いがでてきたのはこの頃です。迷走を繰り返し、結局、Java プログラミングに対する自分の取り組み方があまり良くないことに気が付きました。それは、

  • 機能を理解するための早道は単純な一つのファイルで記述することだ、という幻想を捨てるべき。
    • AWT や SWT の機能を確認するだけなら良いが、あまりこだわると、却って Java らしくないプログラミングを追求することになりかねない。
  • Eclipse を開発環境に使うのであれば、Eclipse RCP を利用すべし。
    • 手っ取り早く、プラグインのリソースを利用したアプリケーションを効果的に構築するのであれば、これを利用しない手はない。

今日は夏休みの最終日。残念ながら Eclipse RCP の理解はいまいちで、時間切れです。もう一週間休むことができれば…

以前勤めていた外資系の会社では(激務であるためか) 3 年毎に 4 週間の sabbatical leave が認められましたが、今の会社にはそのような制度はありません。本業はプログラマでないので、継続的に少しずつ時間を見つけて習得していくしかありません。

そういう訳で夏休みの取り組みの成果としては心許無いのですが、NatTable のサンプルをひとつ紹介します。

NatTable のサンプル

NatTable については、理解しているというレベルにはまだ程遠いです。NatTable のサンプルプログラム NatTableExamples.jar から興味があるものを抜き出して、自分が理解しやすいように手を加えてコードの中身を調べているような段階です。ここでは、サンプル _304_DynamicColumnExample.java を(要するに)パクったものを紹介するにとどめます。余分な機能は整理して削除してあります。

今回紹介するサンプルは右の 4 つになります。

最初は、サンプルの機能概要を記述したインターフェイスです。

List: ISampleApp.java
/*******************************************************************************
 * Copyright (c) 2012 Original authors 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:
 *     Original authors and others - initial API and implementation
 ******************************************************************************/
// Original File is INatExample.java in NatTableExamples.jar
// modified by Suguri Fuhito, 15-Aug-2014
package sample;

import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;

public interface ISampleApp {

    public String getName();
 
    public Control createNatTableControl(Composite parent);
 
    public void onStart();
 
    public void onStop();
 
}

次は、インターフェイス INatTableApp.java を実装した抽象クラスです。

List: AbstractSampleApp.java
/*******************************************************************************
 * Copyright (c) 2012 Original authors 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:
 *     Original authors and others - initial API and implementation
 ******************************************************************************/
// Original File is AbstractNatExample.java in NatTableExamples.jar
// modified by Suguri Fuhito, 15-Aug-2014
package sample;

import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;

public abstract class AbstractSampleApp implements ISampleApp {

    public String getName() {
        return getClass().getSimpleName().replaceAll("^_[0-9]*_", "")
                .replace('_', ' ');
    }

    public void onStart() {
    }

    public void onStop() {
    }

    public Control createNatTableControl(Composite parent) {
        return null;
    }
}

抽象クラス AbstractNatTable を継承/オーバーライドして、NatTable のインスタンスを生成するクラスです。

List: NatTableApp.java
// Original File is _304_DynamicColumnExample.java in NatTableExamples.jar
// modified by Suguri Fuhito, 15-Aug-2014

package sample;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.nebula.widgets.nattable.NatTable;
import org.eclipse.nebula.widgets.nattable.config.ConfigRegistry;
import org.eclipse.nebula.widgets.nattable.config.DefaultNatTableStyleConfiguration;
import org.eclipse.nebula.widgets.nattable.data.IColumnPropertyAccessor;
import org.eclipse.nebula.widgets.nattable.data.IDataProvider;
import org.eclipse.nebula.widgets.nattable.data.ListDataProvider;
import org.eclipse.nebula.widgets.nattable.grid.data.DefaultCornerDataProvider;
import org.eclipse.nebula.widgets.nattable.grid.data.DefaultRowHeaderDataProvider;
import org.eclipse.nebula.widgets.nattable.grid.layer.ColumnHeaderLayer;
import org.eclipse.nebula.widgets.nattable.grid.layer.CornerLayer;
import org.eclipse.nebula.widgets.nattable.grid.layer.DefaultRowHeaderDataLayer;
import org.eclipse.nebula.widgets.nattable.grid.layer.GridLayer;
import org.eclipse.nebula.widgets.nattable.grid.layer.RowHeaderLayer;
import org.eclipse.nebula.widgets.nattable.layer.DataLayer;
import org.eclipse.nebula.widgets.nattable.layer.ILayer;
import org.eclipse.nebula.widgets.nattable.layer.event.ColumnInsertEvent;
import org.eclipse.nebula.widgets.nattable.layer.stack.DefaultBodyLayerStack;
import org.eclipse.nebula.widgets.nattable.sort.config.SingleClickSortConfiguration;
import org.eclipse.nebula.widgets.nattable.ui.menu.HeaderMenuConfiguration;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;

public class NatTableApp extends AbstractSampleApp {

    private List<String> columns = new ArrayList<String>();
    private List<Map<String, String>> values = new ArrayList<Map<String, String>>();

    public static void main(String[] args) throws Exception {
        StandaloneRunner.run(600, 300, new NatTableApp());
    }

    @Override
    public Control createNatTableControl(Composite parent) {
        // start with 3 columns
        columns.add("Column_0");
        columns.add("Column_1");
        columns.add("Column_2");

        values.add(createValueRow("Homer"));
        values.add(createValueRow("Marge"));
        values.add(createValueRow("Bart"));
        values.add(createValueRow("Lisa"));
        values.add(createValueRow("Maggie"));

        Composite panel = new Composite(parent, SWT.NONE);
        panel.setLayout(new GridLayout());
        GridDataFactory.fillDefaults().grab(true, true).applyTo(panel);

        Composite gridPanel = new Composite(panel, SWT.NONE);
        gridPanel.setLayout(new GridLayout());
        GridDataFactory.fillDefaults().grab(true, true).applyTo(gridPanel);

        Composite buttonPanel = new Composite(panel, SWT.NONE);
        buttonPanel.setLayout(new GridLayout());
        GridDataFactory.fillDefaults().grab(true, true).applyTo(buttonPanel);

        ConfigRegistry configRegistry = new ConfigRegistry();

        // create the body layer stack
        IDataProvider bodyDataProvider = new ListDataProvider<Map<String, String>>(
                values, new MyColumnPropertyAccessor());
        final DataLayer bodyDataLayer = new DataLayer(bodyDataProvider);
        DefaultBodyLayerStack bodyLayerStack = new DefaultBodyLayerStack(
                bodyDataLayer);

        // create the column header layer stack
        IDataProvider columnHeaderDataProvider = new SimpleColumnHeaderDataProvider();
        ILayer columnHeaderLayer = new ColumnHeaderLayer(new DataLayer(
                columnHeaderDataProvider), bodyLayerStack.getViewportLayer(),
                bodyLayerStack.getSelectionLayer());

        // create the row header layer stack
        IDataProvider rowHeaderDataProvider = new DefaultRowHeaderDataProvider(
                bodyDataProvider);
        ILayer rowHeaderLayer = new RowHeaderLayer(
                new DefaultRowHeaderDataLayer(new DefaultRowHeaderDataProvider(
                        bodyDataProvider)), bodyLayerStack.getViewportLayer(),
                bodyLayerStack.getSelectionLayer());

        // create the corner layer stack
        ILayer cornerLayer = new CornerLayer(new DataLayer(
                new DefaultCornerDataProvider(columnHeaderDataProvider,
                        rowHeaderDataProvider)), rowHeaderLayer,
                columnHeaderLayer);

        // create the grid layer composed with the prior created layer stacks
        GridLayer gridLayer = new GridLayer(bodyLayerStack, columnHeaderLayer,
                rowHeaderLayer, cornerLayer);

        final NatTable natTable = new NatTable(gridPanel, gridLayer, false);
        natTable.setConfigRegistry(configRegistry);
        natTable.addConfiguration(new DefaultNatTableStyleConfiguration());
        natTable.addConfiguration(new HeaderMenuConfiguration(natTable));
        natTable.addConfiguration(new SingleClickSortConfiguration());
        natTable.configure();
        GridDataFactory.fillDefaults().grab(true, true).applyTo(natTable);

        Button addColumnButton = new Button(buttonPanel, SWT.PUSH);
        addColumnButton.setText("列の追加");
        addColumnButton.addSelectionListener(new SelectionAdapter() {
            @Override
            public void widgetSelected(SelectionEvent e) {
                String newColumn = "Column_" + columns.size();
                columns.add(newColumn);

                for (Map<String, String> value : values) {
                    String prefix = value.get("Column_0");
                    prefix = prefix.substring(0, prefix.indexOf("_"));
                    value.put(newColumn, prefix + "_" + (columns.size() - 1));
                }

                bodyDataLayer.fireLayerEvent(new ColumnInsertEvent(
                        bodyDataLayer, columns.size() - 1));
            }
        });

        return panel;
    }

    private Map<String, String> createValueRow(String value) {
        Map<String, String> valueRow = new HashMap<String, String>();

        for (int i = 0; i < columns.size(); i++) {
            String column = columns.get(i);
            valueRow.put(column, value + "_" + i);
        }

        return valueRow;
    }

    class MyColumnPropertyAccessor implements
            IColumnPropertyAccessor<Map<String, String>> {

        @Override
        public Object getDataValue(Map<String, String> rowObject,
                int columnIndex) {
            return rowObject.get(getColumnProperty(columnIndex));
        }

        @Override
        public void setDataValue(Map<String, String> rowObject,
                int columnIndex, Object newValue) {
            rowObject.put(getColumnProperty(columnIndex), newValue.toString());
        }

        @Override
        public int getColumnCount() {
            return columns.size();
        }

        @Override
        public String getColumnProperty(int columnIndex) {
            return columns.get(columnIndex);
        }

        @Override
        public int getColumnIndex(String propertyName) {
            return columns.indexOf(propertyName);
        }
    }

    class SimpleColumnHeaderDataProvider implements IDataProvider {

        @Override
        public Object getDataValue(int columnIndex, int rowIndex) {
            return "Column " + (columnIndex + 1); //$NON-NLS-1$
        }

        @Override
        public void setDataValue(int columnIndex, int rowIndex, Object newValue) {
            throw new UnsupportedOperationException();
        }

        @Override
        public int getColumnCount() {
            return columns.size();
        }

        @Override
        public int getRowCount() {
            return 1;
        }
    }
}

最後はインスタンスを実行する部分です。

List: StandaloneRunner.java
/*******************************************************************************
 * Copyright (c) 2012 Original authors 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:
 *     Original authors and others - initial API and implementation
 ******************************************************************************/
// Original File is StandaloneNatExampleRunner.java in NatTableExamples.jar
// modified by Suguri Fuhito, 15-Aug-2014
package sample;

import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;

public class StandaloneRunner {

    public static void run(ISampleApp obj) {
        run(800, 800, obj);
    }

    public static void run(int width, int height, ISampleApp obj) {
        // Setup
        Display display = Display.getDefault();
        Shell shell = new Shell(display, SWT.SHELL_TRIM);
        shell.setLayout(new FillLayout());
        shell.setSize(width, height);
        shell.setText(obj.getName());

        // Create example control
        Control instanceControl = obj.createNatTableControl(shell);

        // Start
        obj.onStart();

        shell.open();

        while (!shell.isDisposed()) {
            if (!display.readAndDispatch()) {
                display.sleep();
            }
        }

        // Stop
        obj.onStop();

        instanceControl.dispose();

        shell.dispose();
        display.dispose();
    }
}

実行例

引用サイト

  1. Overview (parent 1.1.0-SNAPSHOT API)
  2. NatTable - Download
  3. Lang - Download Apache Commons Lang
    • NatTable のライブラリが一部の処理で commons-lang を使用しています。最新のではなく、common-lang 2.x で動作しました。

 

0 件のコメント: