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

Legend:

Unmodified
Added
Removed

  • trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/guimodel/MFCGUIElement.java

    r681 r837  
     1 
    12package de.ugoe.cs.quest.plugin.mfc.guimodel; 
    23 
    … …  
    56 
    67/** 
    7  * TODO comment 
     8 * <p> 
     9 * Base class that represents GUI element in MFC GUIs. 
     10 * </p> 
    811 *  
    9  * @version $Revision: $ $Date: $ 
    10  * @author 2011, last modified by $Author: $ 
     12 * @version 1.0 
     13 * @author Patrick Harms 
    1114 */ 
    1215public abstract class MFCGUIElement extends AbstractDefaultGUIElement { 
    13      
    14     /**  */ 
     16 
     17    /** 
     18     * <p> 
     19     * Id for object serialization. 
     20     * </p> 
     21     */ 
    1522    private static final long serialVersionUID = 1L; 
    1623 
    1724    /** 
    18      * @param name 
    19      * @param id 
    20      * @param isModal 
     25     * <p> 
     26     * Constructor. Creates a new MFCGUIElement. 
     27     * </p> 
     28     *  
     29     * @param specification 
     30     *            specification of created GUI element 
     31     * @param parent 
     32     *            parent of the created GUI element; null means that the element is a top-level 
     33     *            window 
    2134     */ 
    2235    public MFCGUIElement(MFCGUIElementSpec specification, MFCGUIElement parent) { 
    … …  
    2437    } 
    2538 
    26     /* (non-Javadoc) 
     39    /* 
     40     * (non-Javadoc) 
     41     *  
    2742     * @see de.ugoe.cs.quest.eventcore.IEventTarget#getPlatform() 
    2843     */ 
    … …  
    3348 
    3449    /** 
    35      * @return Returns the id. 
     50     * <p> 
     51     * Returns the HWND (Id) of the GUI element. 
     52     * </p> 
     53     *  
     54     * @return the HWND (Id) 
    3655     */ 
    3756    public String getId() { 
    … …  
    4059 
    4160    /** 
    42      * @return Returns the name. 
     61     * <p> 
     62     * Returns the type of the GUI element. 
     63     * </p> 
     64     *  
     65     * @return the type 
    4366     */ 
    4467    public String getType() { 
    … …  
    4770 
    4871    /** 
    49      * @return Returns the name. 
     72     * <p> 
     73     * Returns the name of the GUI element. 
     74     * </p> 
     75     *  
     76     * @return the name 
    5077     */ 
    5178    public String getName() { 
    … …  
    5481 
    5582    /** 
    56      * @return Returns the isModal. 
     83     * <p> 
     84     * Returns the modality of the GUI element. 
     85     * </p> 
     86     *  
     87     * @return the modality 
    5788     */ 
    5889    public boolean isModal() { 
    … …  
    6293    /** 
    6394     * <p> 
    64      * TODO: comment 
     95     * Returns the resource Id of the GUI element. 
    6596     * </p> 
    66      * 
    67      * @return 
     97     *  
     98     * @return the resource Id 
    6899     */ 
    69100    public int getResourceId() { 
    … …  
    71102    } 
    72103 
    73     /* (non-Javadoc) 
    74      * @see de.ugoe.cs.quest.eventcore.guimodel.IGUIElement#updateSpecification(de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec) 
     104    /* 
     105     * (non-Javadoc) 
     106     *  
     107     * @see 
     108     * de.ugoe.cs.quest.eventcore.guimodel.IGUIElement#updateSpecification(de.ugoe.cs.quest.eventcore 
     109     * .guimodel.IGUIElementSpec) 
    75110     */ 
    76111    @Override 
    … …  
    78113        ((MFCGUIElementSpec) super.getSpecification()).update(furtherSpec); 
    79114    } 
    80      
     115 
     116    /* 
     117     * (non-Javadoc) 
     118     *  
     119     * @see de.ugoe.cs.quest.eventcore.IEventTarget#getStringIdentifier() 
     120     */ 
    81121    @Override 
    82122    public String getStringIdentifier() { 
    83123        String str = this.toString(); 
    84         if( getParent()!=null ) { 
     124        if (getParent() != null) { 
    85125            return getParent().getStringIdentifier() + "->" + str; 
    86126        } 
    … …  
    88128    } 
    89129 
    90     /* (non-Javadoc) 
     130    /* 
     131     * (non-Javadoc) 
     132     *  
    91133     * @see java.lang.Object#toString() 
    92134     */ 
    … …  
    98140    /** 
    99141     * <p> 
    100      * TODO: comment 
     142     * Returns the XML representation of the GUI element. 
    101143     * </p> 
     144     *  
     145     * @return the XML representation 
    102146     */ 
    103147    public String toXML() { 
    104148        if (getParent() != null) { 
    105             return 
    106                 ((MFCGUIElement) getParent()).toXML() + 
     149            return ((MFCGUIElement) getParent()).toXML() + 
    107150                ((MFCGUIElementSpec) super.getSpecification()).toXML(); 
    108151        } 
Note: See TracChangeset for help on using the changeset viewer.