com.cedarsolutions.client.gwt.handler.AbstractRowClickActionHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cedar-common-gwt Show documentation

Utility code for use with GWT and Mvp4g.

There is a newer version: 5.8.4

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 *              C E D A R
 *          S O L U T I O N S       "Software done right."
 *           S O F T W A R E
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 * Copyright (c) 2013 Kenneth J. Pronovici.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the Apache License, Version 2.0.
 * See LICENSE for more information about the licensing terms.
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 * Author   : Kenneth J. Pronovici 
 * Language : Java 6
 * Project  : Common Java Functionality
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
package com.cedarsolutions.client.gwt.handler;

import static com.cedarsolutions.web.metadata.NativeEventType.CLICK;

import com.cedarsolutions.web.metadata.NativeEventType;
import com.google.gwt.view.client.CellPreviewEvent;

/**
 * A simple click handler that deals with row click events by invoking a simple action.
 * @param  Parent presenter or view associated with handler
 * @param  Type of the expected row
 * @author Kenneth J. Pronovici 
 */
public abstract class AbstractRowClickActionHandler extends AbstractEventHandler implements CellPreviewEvent.Handler {

    /** Create a click handler in terms of a parent. */
    public AbstractRowClickActionHandler(P parent) {
        super(parent);
    }

    /** Handle the CellPreview event. */
    @Override
    public void onCellPreview(CellPreviewEvent event) {
        this.handleSelectedRow(event.getNativeEvent().getType(), event.getColumn(), event.getValue());
    }

    /**
     * Get the zero-based selection column number, if any.
     * Child classes should override this to define which column is their selection column.
     * Return null if there is no selection column.
     */
    protected Integer getSelectionColumn() {
        return null;
    }

    /** Handle the row that was selected. */
    protected abstract void handleRow(T row);

    /** Handle the selected row, if it's a click event for something other than the selection column. */
    protected void handleSelectedRow(String event, int column, T row) {
        if (row != null) {
            if (CLICK.equals(NativeEventType.convert(event))) {
                if (this.getSelectionColumn() == null) {
                    this.handleRow(row);
                } else {
                    if (column != this.getSelectionColumn()) {
                        this.handleRow(row);
                    }
                }
            }
        }
    }

}