KeyModifiers.java

/*
 * Scriptographer
 *
 * This file is part of Scriptographer, a Scripting Plugin for Adobe Illustrator
 * http://scriptographer.org/
 *
 * Copyright (c) 2002-2010, Juerg Lehni
 * http://scratchdisk.com/
 *
 * All rights reserved. See LICENSE file for details.
 * 
 * File created on Feb 9, 2010.
 */

package com.scriptographer.ui;

/**
 * @author lehni
 */
public class KeyModifiers {
	// Bit flags based on Mac modifiers that are also used by AI / ADM
	// See AIEvent.h AIEventModifersValue
	protected final static int SHIFT = 1 << 9;
	protected final static int CONTROL = 1 << 12;
	protected final static int OPTION = 1 << 11;
	protected final static int COMMAND = 1 << 8;
	// Match both Mac and ADM Caps Lock
	protected final static int CAPS_LOCK = (1 << 10) | (1 << 3);

	private int modifiers;

	/**
	 * @jshide
	 */
	public KeyModifiers(int modifiers) {
		this.modifiers = modifiers;
	}

	/**
	 * Specifies whether the shift key is pressed.
	 * 
	 * @return {@true if the shift key is pressed}
	 */
	public boolean getShift() {
		return (modifiers & SHIFT) != 0;
	}

	/**
	 * Specifies whether the control key is pressed.
	 * 
	 * @return {@true if the control key is pressed}
	 */
	public boolean getControl() {
		return (modifiers & CONTROL) != 0;
	}

	/**
	 * Specifies whether the option key is pressed, often also refered to as alt
	 * key.
	 * 
	 * @return {@true if the option key is pressed}
	 */
	public boolean getOption() {
		return (modifiers & OPTION) != 0;
	}

	/**
	 * Specifies whether the command key is pressed. This is the same as the
	 * control key on Windows.
	 * 
	 * @return {@true if the command key is pressed}
	 */
	public boolean getCommand() {
		return (modifiers & COMMAND) != 0;
	}

	/**
	 * Specifies whether caps lock key is activated.
	 * 
	 * @return {@true if the caps lock is activated}
	 */
	public boolean getCapsLock() {
		return (modifiers & CAPS_LOCK) != 0;
	}

	public String toString() {
		StringBuffer buf = new StringBuffer();
		buf.append("{ shift: ").append(getShift());
		buf.append(", control: ").append(getControl());
		buf.append(", option: ").append(getOption());
		buf.append(", command: ").append(getCommand());
		buf.append(", capsLock: ").append(getCapsLock());
		buf.append(" }");
		return buf.toString();
	}
}