/*******************************************************************************
* CogTool Copyright Notice and Distribution Terms
* CogTool 1.3, Copyright (c) 2005-2013 Carnegie Mellon University
* This software is distributed under the terms of the FSF Lesser
* Gnu Public License (see LGPL.txt).
*
* CogTool is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* CogTool is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with CogTool; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* CogTool makes use of several third-party components, with the
* following notices:
*
* Eclipse SWT version 3.448
* Eclipse GEF Draw2D version 3.2.1
*
* Unless otherwise indicated, all Content made available by the Eclipse
* Foundation is provided to you under the terms and conditions of the Eclipse
* Public License Version 1.0 ("EPL"). A copy of the EPL is provided with this
* Content and is also available at http://www.eclipse.org/legal/epl-v10.html.
*
* CLISP version 2.38
*
* Copyright (c) Sam Steingold, Bruno Haible 2001-2006
* This software is distributed under the terms of the FSF Gnu Public License.
* See COPYRIGHT file in clisp installation folder for more information.
*
* ACT-R 6.0
*
* Copyright (c) 1998-2007 Dan Bothell, Mike Byrne, Christian Lebiere &
* John R Anderson.
* This software is distributed under the terms of the FSF Lesser
* Gnu Public License (see LGPL.txt).
*
* Apache Jakarta Commons-Lang 2.1
*
* This product contains software developed by the Apache Software Foundation
* (http://www.apache.org/)
*
* jopt-simple version 1.0
*
* Copyright (c) 2004-2013 Paul R. Holser, Jr.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Mozilla XULRunner 1.9.0.5
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/.
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations
* under the License.
*
* The J2SE(TM) Java Runtime Environment version 5.0
*
* Copyright 2009 Sun Microsystems, Inc., 4150
* Network Circle, Santa Clara, California 95054, U.S.A. All
* rights reserved. U.S.
* See the LICENSE file in the jre folder for more information.
******************************************************************************/
package edu.cmu.cs.hcii.cogtool.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import edu.cmu.cs.hcii.cogtool.util.EnumeratedInt;
import edu.cmu.cs.hcii.cogtool.util.ObjectLoader;
import edu.cmu.cs.hcii.cogtool.util.ObjectSaver;
/**
* An action type represents a class of possible actions a user may
* perform on a user interface, such as keystrokes, mouse button clicks
* and double-clicks, voice commands, etc.
* <p>
* This subclass presents an enumeration of possible action type values.
*
* @author mlh
*/
public class ActionType extends EnumeratedInt
{
public static final int edu_cmu_cs_hcii_cogtool_model_ActionType_version = 0;
private static ObjectSaver.IDataSaver<ActionType> SAVER =
new ObjectSaver.ADataSaver<ActionType>() {
@Override
public int getVersion()
{
return edu_cmu_cs_hcii_cogtool_model_ActionType_version;
}
@Override
public boolean isEnum()
{
return true;
}
};
public static void registerSaver()
{
ObjectSaver.registerSaver(ActionType.class.getName(), SAVER);
}
private static ObjectLoader.IEnumLoader LOADER =
new ObjectLoader.AEnumLoader() {
@Override
public Object createEnum(String persistentValue)
{
switch (Integer.parseInt(persistentValue)) {
case 0: return ActionType.Voice;
case 1: return ActionType.ButtonPress;
case 2: return ActionType.KeyPress;
case 3: return ActionType.MouseOver;
case 4: return ActionType.GraffitiStroke;
case 5: return ActionType.MoveMouse;
case 6: return ActionType.Tap;
case 7: return ActionType.Home; // used to be HomeKeyboard
case 8: return ActionType.Home; // used to be HomeMouse
}
return null;
}
};
public static void registerLoader()
{
ObjectLoader.registerEnumLoader(ActionType.class.getName(),
edu_cmu_cs_hcii_cogtool_model_ActionType_version,
LOADER);
}
protected ActionType(String lbl, int persistentValue)
{
super(lbl, persistentValue);
}
/**
* The action of commanding the application by voice;
* value should be the command itself.
*/
public static final ActionType Voice =
new ActionType("Voice", 0);
/**
* The action corresponding to a mouse button press;
* value should be which button was pressed.
*/
public static final ActionType ButtonPress =
new ActionType("ButtonPress", 1);
/**
* The action corresponding to a keystroke;
* value should be the key(s) pressed.
*/
public static final ActionType KeyPress =
new ActionType("KeyPress", 2);
/**
* Mouse over action
*/
public static final ActionType MouseOver =
new ActionType("MouseOver", 3);
/**
* The action corresponding to a Graffiti entry;
* value should be text reflecting the strokes.
*/
public static final ActionType GraffitiStroke =
new ActionType("Graffiti\u00AE Stroke", 4);
/**
* Action that corresponds to a MoveMouse action
*/
public static final ActionType MoveMouse =
new ActionType("Move Mouse", 5);
/**
* Action that corresponds to a tap action on a touch sensitive device
*/
public static final ActionType Tap =
new ActionType("Tap", 6);
/**
* Move hand from the mouse to the Keyboard action.
*/
public static final ActionType Home =
new ActionType("Home", 7);
/**
* The set of all values to support their iteration in a specific order.
*/
protected static final ActionType[] ITERATOR_ORDERING =
{ Voice, ButtonPress, KeyPress, GraffitiStroke,
MoveMouse, Tap, Home, MouseOver };
public static final List<ActionType> VALUES =
Collections.unmodifiableList(Arrays.asList(ITERATOR_ORDERING));
}