ecommons.waltable/org.eclipse.statet.ecommons.waltable.core/src/org/eclipse/statet/ecommons/waltable/freeze/FreezeSelectionCommand.java

/*=============================================================================#
 # Copyright (c) 2012, 2021 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.freeze;

import org.eclipse.statet.ecommons.waltable.layer.ILayer;


/**
 * Will inform the handler to use the selection layer for its freeze coordinates.
 * 
 */
public class FreezeSelectionCommand implements IFreezeCommand {
	
	
	/**
	 * Indicates whether this command should toggle the frozen state between
	 * frozen and unfrozen, or if it should always result in a frozen state.	 
	 */
	private final boolean toggle;
	
	/**
	 * Indicates whether this command should override a current frozen state
	 * or if it should be skipped if a frozen state is already applied.
	 */
	private final boolean overrideFreeze;
	
	
	/**
	 * Creates a simple FreezeSelectionCommand that doesn't toggle or override
	 * a current frozen state.
	 */
	public FreezeSelectionCommand() {
		this(false);
	}
	
	/**
	 * Creates a FreezeSelectionCommand that doesn't override a current frozen state.
	 * If it should toggle the current frozen state can be specified by parameter.
	 * @param toggle whether this command should toggle the frozen state between
	 * 			frozen and unfrozen, or if it should always result in a frozen state.
	 */
	public FreezeSelectionCommand(final boolean toggle) {
		this(toggle, false);
	}
	
	/**
	 * Creates a FreezeSelectionCommand.
	 * If it should toggle or override the current frozen state can be specified by parameter.
	 * @param toggle whether this command should toggle the frozen state between
	 * 			frozen and unfrozen, or if it should always result in a frozen state.
	 * @param overrideFreeze whether this command should override a current frozen state
	 * 			or if it should be skipped if a frozen state is already applied.
	 */
	public FreezeSelectionCommand(final boolean toggle, final boolean overrideFreeze) {
		this.toggle= toggle;
		this.overrideFreeze= overrideFreeze;
	}
	
	
	@Override
	public boolean isToggle() {
		return this.toggle;
	}
	
	@Override
	public boolean isOverrideFreeze() {
		return this.overrideFreeze;
	}
	
	@Override
	public boolean convertToTargetLayer(final ILayer targetLayer) {
		return true;
	}
	
	@Override
	public FreezeSelectionCommand cloneCommand() {
		return this;
	}
	
}