inputmodifiers.java

FuncPlotter is a combined Java application and applet for displaying two-dimensional plots of explic

/*====================================================================*\

InputModifiers.java

Input modifiers enumeration.

------------------------------------------------------------------------

This file is part of FuncPlotter, a combined Java application and applet
for plotting explicit functions in one variable.
Copyright 2005-2007 Andy Morgan-Richards.

FuncPlotter is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

This program 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
General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.

\*====================================================================*/


// PACKAGE


package util;

//----------------------------------------------------------------------


// IMPORTS


import java.awt.event.InputEvent;

//----------------------------------------------------------------------


// INPUT MODIFIERS


public enum InputModifiers
{

////////////////////////////////////////////////////////////////////////
//  Constants
////////////////////////////////////////////////////////////////////////

    NONE            ( 0 ),
    SHIFT           ( InputEvent.SHIFT_DOWN_MASK ),
    CTRL            ( InputEvent.CTRL_DOWN_MASK ),
    ALT             ( InputEvent.ALT_DOWN_MASK ),
    CTRL_SHIFT      ( InputEvent.CTRL_DOWN_MASK | InputEvent.SHIFT_DOWN_MASK ),
    ALT_SHIFT       ( InputEvent.ALT_DOWN_MASK | InputEvent.SHIFT_DOWN_MASK ),
    ALT_CTRL        ( InputEvent.ALT_DOWN_MASK | InputEvent.CTRL_DOWN_MASK ),
    ALT_CTRL_SHIFT  ( InputEvent.ALT_DOWN_MASK | InputEvent.CTRL_DOWN_MASK | InputEvent.SHIFT_DOWN_MASK ),
    UNRECOGNISED    ( 0 );

    public static final int MASK    = InputEvent.ALT_DOWN_MASK | InputEvent.ALT_GRAPH_DOWN_MASK |
                                                    InputEvent.CTRL_DOWN_MASK | InputEvent.META_DOWN_MASK |
                                                    InputEvent.SHIFT_DOWN_MASK;

////////////////////////////////////////////////////////////////////////
//  Constructors
////////////////////////////////////////////////////////////////////////

    private InputModifiers( int mask )
    {
        this.mask = mask;
    }

    //------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////
//  Class methods
////////////////////////////////////////////////////////////////////////

    public static InputModifiers get( int modifiers )
    {
        int value = modifiers & MASK;
        for ( InputModifiers mod : values( ) )
        {
            if ( mod.mask == value )
                return mod;
        }
        return UNRECOGNISED;
    }

    //------------------------------------------------------------------

    public static InputModifiers get( InputEvent event )
    {
        return get( event.getModifiersEx( ) );
    }

    //------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////
//  Instance methods
////////////////////////////////////////////////////////////////////////

    public boolean isShift( )
    {
        return ( (mask & InputEvent.SHIFT_DOWN_MASK) != 0 );
    }

    //------------------------------------------------------------------

    public boolean isControl( )
    {
        return ( (mask & InputEvent.CTRL_DOWN_MASK) != 0 );
    }

    //------------------------------------------------------------------

    public boolean isAlt( )
    {
        return ( (mask & InputEvent.ALT_DOWN_MASK) != 0 );
    }

    //------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////
//  Instance variables
////////////////////////////////////////////////////////////////////////

    private int mask;

}

//----------------------------------------------------------------------