Ignore:
Timestamp:
09/20/12 09:40:26 (12 years ago)
Author:
sherbold
Message:
  • code documentation and clean-up
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/IGUIElement.java

    r655 r831  
     1 
    12package de.ugoe.cs.quest.eventcore.guimodel; 
    23 
    … …  
    56/** 
    67 * <p> 
    7  * TODO comment 
     8 * Common interface for all GUI elements. 
    89 * </p> 
    910 *  
    10  * @version $Revision: $ $Date: $ 
    11  * @author 2011, last modified by $Author: $ 
     11 * @version 1.0 
     12 * @author Patrick Harms 
    1213 */ 
    1314public interface IGUIElement extends IEventTarget { 
    14      
     15 
    1516    /** 
    1617     * <p> 
    17      * TODO comment 
     18     * Returns the specification of the GUI element. 
    1819     * </p> 
     20     *  
     21     * @return the specification 
    1922     */ 
    2023    public IGUIElementSpec getSpecification(); 
    … …  
    2225    /** 
    2326     * <p> 
    24      * TODO comment 
     27     * Returns the parent of the GUI element. 
    2528     * </p> 
     29     *  
     30     * @return the parent 
    2631     */ 
    2732    public IGUIElement getParent(); 
    … …  
    2934    /** 
    3035     * <p> 
    31      * TODO comment 
     36     * Defines that {@link IGUIElement} implementations have to define equals. 
    3237     * </p> 
    33      *   
    34      * @param other 
    35      * @return 
     38     *  
     39     * @see Object#equals(Object) 
    3640     */ 
     41    @Override 
    3742    public boolean equals(Object other); 
    3843 
    3944    /** 
    4045     * <p> 
    41      * TODO comment 
     46     * Defines that {@link IGUIElement} implementations have to define hashCode. 
    4247     * </p> 
     48     *  
     49     * @see Object#hashCode() 
    4350     */ 
     51    @Override 
    4452    public int hashCode(); 
    4553 
    4654    /** 
    4755     * <p> 
    48      * TODO comment 
     56     * Updates the specification of a GUI element with another specification, e.g., to add further 
     57     * known names of the GUI element. 
    4958     * </p> 
     59     *  
     60     * @param furtherSpec 
     61     *            additional specification 
    5062     */ 
    5163    public void updateSpecification(IGUIElementSpec furtherSpec); 
    … …  
    5365    /** 
    5466     * <p> 
    55      * TODO: comment 
     67     * The {@link IGUIElement} that is passed by this function is equal to the current GUI element 
     68     * and will hereafter be treated as such. 
    5669     * </p> 
    57      * 
     70     *  
    5871     * @param guiElement 
     72     *            GUI element that is equal 
    5973     */ 
    6074    public void addEqualGUIElement(IGUIElement equalElement); 
Note: See TracChangeset for help on using the changeset viewer.