Ignore:
Timestamp:
09/06/12 16:47:00 (12 years ago)
Author:
sherbold
Message:
  • code documentation
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseButtonInteraction.java

    r681 r786  
     1 
    12package de.ugoe.cs.quest.eventcore.gui; 
    23 
    34/** 
    4  * TODO comment 
     5 * <p> 
     6 * Base class for all mouse interaction event types. 
     7 * </p> 
    58 *  
    6  * @version $Revision: $ $Date: $ 
    7  * @author 2011, last modified by $Author: $ 
     9 * @version 1.0 
     10 * @author Patrick Harms 
    811 */ 
    912public abstract class MouseButtonInteraction extends MouseInteraction { 
    1013 
    11     /**  */ 
     14    /** 
     15     * <p> 
     16     * Id for object serialization. 
     17     * </p> 
     18     */ 
    1219    private static final long serialVersionUID = 1L; 
    1320 
    14     /** */ 
     21    /** 
     22     * <p> 
     23     * Describes the pressed mouse button. 
     24     * </p> 
     25     *  
     26     * @version 1.0 
     27     * @author Patrick Harms 
     28     */ 
    1529    public static enum Button { 
    1630        LEFT, MIDDLE, RIGHT, X; 
    1731    } 
    1832 
    19     /** the button used for mouse interaction */ 
     33    /** 
     34     * <p> 
     35     * The button used for mouse interaction 
     36     * </p> 
     37     */ 
    2038    private Button button; 
    2139 
    2240    /** 
     41     * <p> 
     42     * Constructor. Creates a new {@link MouseButtonInteraction} 
     43     * </p> 
    2344     *  
     45     * @param button 
     46     *            the button associated with the interaction 
    2447     */ 
    2548    public MouseButtonInteraction(Button button) { 
    … …  
    2851 
    2952    /** 
    30      * @return Returns the button. 
     53     * <p> 
     54     * Returns the button associated with the interaction. 
     55     * </p> 
     56     *  
     57     * @return the button 
    3158     */ 
    3259    public Button getButton() { 
    3360        return button; 
    3461    } 
    35      
     62 
    3663    /* 
    3764     * (non-Javadoc) 
Note: See TracChangeset for help on using the changeset viewer.