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

Legend:

Unmodified
Added
Removed

  • trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCGUIElement.java

    r778 r835  
     1 
    12package de.ugoe.cs.quest.plugin.jfc.guimodel; 
    23 
    … …  
    56 
    67/** 
    7  * TODO comment 
     8 * <p> 
     9 * Base class for all JFC GUI elements. 
     10 * </p> 
    811 *  
    9  * @version $Revision: $ $Date: $ 
    10  * @author 2011, last modified by $Author: $ 
     12 * @version 1.0 
     13 * @author Patrick Harms 
    1114 */ 
    1215public class JFCGUIElement extends AbstractDefaultGUIElement { 
    13      
     16 
    1417    /** 
    1518     * <p> 
    … …  
    1922    private static final long serialVersionUID = 1L; 
    2023 
    21     /** the specification of the GUI Element */ 
     24    /** 
     25     * <p> 
     26     * Specification of the GUI Element 
     27     * </p> 
     28     */ 
    2229    private JFCGUIElementSpec specification; 
    2330 
    2431    /** 
    25      * @param name 
    26      * @param id 
    27      * @param isModal 
     32     * <p> 
     33     * Constructor. Creates a new JFCGUIElement. 
     34     * </p> 
     35     *  
     36     * @param specification 
     37     *            specification of created GUI element 
     38     * @param parent 
     39     *            parent of the created GUI element; null means that the element is a top-level 
     40     *            window 
    2841     */ 
    2942    public JFCGUIElement(JFCGUIElementSpec specification, JFCGUIElement parent) { 
    … …  
    3245    } 
    3346 
    34     /* (non-Javadoc) 
     47    /* 
     48     * (non-Javadoc) 
     49     *  
    3550     * @see de.ugoe.cs.quest.eventcore.IEventTarget#getPlatform() 
    3651     */ 
    … …  
    4156 
    4257    /** 
    43      * TODO: comment 
     58     * <p> 
     59     * Returns the type of the GUI element, i.e., the name of its Java class. 
     60     * </p> 
    4461     *  
    45      * @return 
     62     * @return the Java class name 
    4663     */ 
    4764    public String getJavaType() { 
    … …  
    5067 
    5168    /** 
    52      * @return Returns the name. 
     69     * <p> 
     70     * Returns the name of the GUI element. 
     71     * </p> 
     72     *  
     73     * @return the name 
    5374     */ 
    5475    String getName() { 
    … …  
    5778 
    5879    /** 
     80     * <p> 
     81     * Returns the icon of the GUI element. 
     82     * </p> 
     83     *  
    5984     * @return the icon 
    6085     */ 
    … …  
    6489 
    6590    /** 
     91     * <p> 
     92     * Returns the index of the GUI element. 
     93     * </p> 
     94     *  
    6695     * @return the index 
    6796     */ 
    … …  
    71100 
    72101    /** 
    73      * @return the hashCode 
     102     * <p> 
     103     * Returns the object hash of the GUI element. 
     104     * </p> 
     105     *  
     106     * @return the object hash 
    74107     */ 
    75108    int getElementHash() { 
    … …  
    77110    } 
    78111 
    79     /** 
    80      * <p> 
    81      * TODO comment 
    82      * </p> 
     112    /* 
     113     * (non-Javadoc) 
     114     *  
     115     * @see 
     116     * de.ugoe.cs.quest.eventcore.guimodel.IGUIElement#updateSpecification(de.ugoe.cs.quest.eventcore 
     117     * .guimodel.IGUIElementSpec) 
    83118     */ 
    84119    @Override 
    … …  
    88123        } 
    89124    } 
    90      
     125 
    91126    /* 
    92127     * (non-Javadoc) 
    … …  
    97132    public String getStringIdentifier() { 
    98133        String str = this.toString(); 
    99         if( getParent()!=null ) { 
     134        if (getParent() != null) { 
    100135            return getParent().getStringIdentifier() + "->" + str; 
    101136        } 
    102137        return str; 
    103138    } 
    104      
     139 
    105140    /* 
    106141     * (non-Javadoc) 
    … …  
    110145    @Override 
    111146    public String toString() { 
    112         String str = getElementDescriptor() + "(" + getName() + "," + getElementHash() + "," + 
    113             getIcon() + "," + getIndex() +")"; 
     147        String str = 
     148            getElementDescriptor() + "(" + getName() + "," + getElementHash() + "," + getIcon() + 
     149                "," + getIndex() + ")"; 
    114150        return str; 
    115151    } 
    116      
     152 
     153    /** 
     154     * <p> 
     155     * A short string describing the GUI element, e.g., Button, Canvas, or ScrollBar. 
     156     * </p> 
     157     *  
     158     * @return short element descriptor 
     159     */ 
    117160    protected String getElementDescriptor() { 
    118161        return "Default"; 
Note: See TracChangeset for help on using the changeset viewer.