org.eclipse.riena.internal.ui.ridgets.swt.TableRidgetTableViewer.java Source code

Introduction

Here is the source code for org.eclipse.riena.internal.ui.ridgets.swt.TableRidgetTableViewer.java

Source

/*******************************************************************************
 * Copyright (c) 2007, 2013 compeople AG 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:
 *    compeople AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.riena.internal.ui.ridgets.swt;

import java.beans.PropertyDescriptor;

import org.osgi.service.log.LogService;

import org.eclipse.core.databinding.beans.PojoObservables;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.equinox.log.Logger;
import org.eclipse.jface.viewers.CheckStateChangedEvent;
import org.eclipse.jface.viewers.CheckboxTableViewer;
import org.eclipse.jface.viewers.ICheckStateListener;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.ViewerRow;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Table;

import org.eclipse.riena.core.Log4r;
import org.eclipse.riena.ui.ridgets.ITableRidget;

/**
 * A viewer of a SWT {@link Table} control that also know the corresponding Ridget.
 */
public class TableRidgetTableViewer extends CheckboxTableViewer {

    private final static Logger LOGGER = Log4r.getLogger(TableRidgetTableViewer.class);

    private final TableRidget tableRidget;
    private boolean allowRefresh = true;
    private TableRidgetCheckStateListener checkStateListener = null;

    /**
     * Creates a table viewer on the SWT table that's binded with the given Ridget.
     * 
     * @param tableRidget
     *            Ridget of the {@link Table}
     */
    public TableRidgetTableViewer(final TableRidget tableRidget) {
        super(tableRidget.getUIControl());
        this.tableRidget = tableRidget;
        if (tableRidget.isCheckBoxInFirstColumn(this)) {
            checkStateListener = new TableRidgetCheckStateListener(tableRidget);
            addCheckStateListener(checkStateListener);
        }
    }

    @Override
    protected void handleDispose(final DisposeEvent event) {
        super.handleDispose(event);
        if (checkStateListener != null) {
            removeCheckStateListener(checkStateListener);
            checkStateListener = null;
        }
    }

    @Override
    public ViewerRow getViewerRow(final Point point) {
        return super.getViewerRow(point);
    }

    public TableRidget getTableRidget() {
        return tableRidget;
    }

    /**
     * Configures refresh behavior. If set to false, refresh requests will be denied, otherwise allowed. This is useful if the viewer is shared between
     * different {@link ITableRidget} instances as bind/unbind logic can put the viewer in a dirty state for a short period of time. While in dirty state, there
     * should happen no refreshing in the direction of the user interface. This is when you would set the flag to false. After cleaning up ( reaching clean
     * viewer state ) you should call this method with allowRefresh=true and then explicitly call {@link TableViewer#refresh()}.
     * 
     * @param allowRefresh
     */
    public void setAllowRefresh(final boolean allowRefresh) {
        this.allowRefresh = allowRefresh;
    }

    @Override
    public void refresh() {
        if (!allowRefresh()) {
            return;
        }
        super.refresh();
    }

    protected boolean allowRefresh() {
        return allowRefresh;
    }

    /**
     * Updates inside the data model the property value of the first column.
     */
    private static final class TableRidgetCheckStateListener implements ICheckStateListener {

        private final TableRidget tableRidget;

        public TableRidgetCheckStateListener(final TableRidget tableRidget) {
            this.tableRidget = tableRidget;
        }

        public void checkStateChanged(final CheckStateChangedEvent event) {
            final PropertyDescriptor propertyDescriptor = tableRidget.getPropertyDescriptor(0);
            if (propertyDescriptor.getPropertyType() == boolean.class) {
                if (!tableRidget.isOutputOnly()) {
                    final String propertyName = propertyDescriptor.getName();
                    final IObservableValue observableValue = PojoObservables.observeValue(event.getElement(),
                            propertyName);
                    observableValue.setValue(event.getChecked());
                }
            } else {
                LOGGER.log(LogService.LOG_WARNING, "Unexpected property type of first column!"); //$NON-NLS-1$
            }
            tableRidget.updateFromModel();
        }
    }

}