ecommons.waltable/org.eclipse.statet.ecommons.waltable.core/srcBase/org/eclipse/statet/ecommons/waltable/selection/core/SelectCellCommand.java

/*=============================================================================#
 # Copyright (c) 2012, 2022 Original NatTable authors and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0
 # 
 # Contributors:
 #     Original NatTable authors and others - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ecommons.waltable.selection.core;

import org.eclipse.statet.jcommons.lang.NonNullByDefault;

import org.eclipse.statet.ecommons.waltable.command.AbstractPositionCommand;
import org.eclipse.statet.ecommons.waltable.core.layer.Layer;


/**
 * Event indicating that the user has selected a specific cell in the data grid. This command should be used for 
 * implementing all selection handling by layers. 
 * 
 * <strong>Note that this command takes a Grid PositionCoordinate describing a cell on the screen on which the user has 
 * clicked. Do not pass it anything else or you will introduce very subtle and very difficult to debug bugs into the 
 * code and then we will have to pay you a visit on one random Sunday morning when you least expect it.</strong>
 */
@NonNullByDefault
public class SelectCellCommand extends AbstractPositionCommand {
	
	
	private final int selectionFlags;
	
	private final boolean revealCell;
	
	
	public SelectCellCommand(final Layer layer, final long columnPosition, final long rowPosition,
			final int selectionFlags) {
		this(layer, columnPosition, rowPosition, selectionFlags, true);
	}
	
	public SelectCellCommand(final Layer layer, final long columnPosition, final long rowPosition,
			final int selectionFlags, final boolean revealCell) {
		super(layer, columnPosition, rowPosition);
		
		this.selectionFlags= selectionFlags;
		this.revealCell= revealCell;
	}
	
	protected SelectCellCommand(final SelectCellCommand command) {
		super(command);
		
		this.selectionFlags= command.selectionFlags;
		this.revealCell= command.revealCell;
	}
	
	@Override
	public SelectCellCommand cloneCommand() {
		return new SelectCellCommand(this);
	}
	
	
	public int getSelectionFlags() {
		return this.selectionFlags;
	}
	
	public boolean getRevealCell() {
		return this.revealCell;
	}
	
}