001 /* 002 * Created on Sep 21, 2007 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 005 * in compliance with the License. You may obtain a copy of the License at 006 * 007 * http://www.apache.org/licenses/LICENSE-2.0 008 * 009 * Unless required by applicable law or agreed to in writing, software distributed under the License 010 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 011 * or implied. See the License for the specific language governing permissions and limitations under 012 * the License. 013 * 014 * Copyright @2007-2010 the original author or authors. 015 */ 016 package org.fest.swing.core; 017 018 import static java.awt.event.InputEvent.*; 019 import static org.fest.util.Strings.concat; 020 021 import java.awt.event.InputEvent; 022 023 /** 024 * Understands mouse buttons. 025 * 026 * @author Alex Ruiz 027 */ 028 public enum MouseButton { 029 030 LEFT_BUTTON(BUTTON1_MASK), MIDDLE_BUTTON(BUTTON2_MASK), RIGHT_BUTTON(BUTTON3_MASK); 031 032 /** 033 * The mouse button modifier. 034 * @see InputEvent 035 */ 036 public final int mask; 037 038 private MouseButton(int mask) { 039 this.mask = mask; 040 } 041 042 /** 043 * Returns the mouse button whose mask matches the given mask. Valid values are 044 * <code>{@link InputEvent#BUTTON1_MASK}</code>, <code>{@link InputEvent#BUTTON2_MASK}</code>, and 045 * <code>{@link InputEvent#BUTTON3_MASK}</code> 046 * @param mask the mask of the button we are looking for. 047 * @return the found button. 048 * @throws IllegalArgumentException if the given mask is not a valid one. 049 */ 050 public static MouseButton lookup(int mask) { 051 for (MouseButton button : values()) 052 if (button.mask == mask) return button; 053 throw new IllegalArgumentException(concat(String.valueOf(mask), " is not a valid button mask")); 054 } 055 }