Ignore:
Timestamp:
12/14/12 16:16:16 (12 years ago)
Author:
pharms
Message:
  • removed todos
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlPageElement.java

    r1019 r1022  
    2020/** 
    2121 * <p> 
    22  * TODO comment 
     22 * represents an element of an HTML GUI. This can be a server, which is usually the root of a 
     23 * GUI structure, a web page, or a tag within a web page. 
    2324 * </p> 
    2425 *  
    … …  
    2829 
    2930    /** 
    30      *  
     31     * path to the parent of this page element or null, if this is the root element 
    3132     */ 
    3233    private String parentPath; 
    3334     
    3435    /** 
    35      *  
     36     * the name of the tag represented by this page element. May also be the name of the server 
     37     * or the page. 
    3638     */ 
    3739    private String tagName; 
    3840     
    3941    /** 
    40      *  
     42     * the id of the page element. May also be the name of the server including port number or the 
     43     * URL of the page 
    4144     */ 
    4245    private String id; 
    4346     
    4447    /** 
    45      *  
     48     * the title of the page if a page is represented through this element 
    4649     */ 
    4750    private String title; 
    4851     
    4952    /** 
    50      *  
     53     * the index of this element regarding all elements with the same tag name in the list of  
     54     * children of the parent element 
    5155     */ 
    5256    private Integer index; 
    5357     
    5458    /** 
    55      *  
     59     * the children of this element 
    5660     */ 
    5761    private List<HtmlPageElement> children; 
    … …  
    5963    /** 
    6064     * <p> 
    61      * TODO: comment 
    62      * </p> 
    63      * 
    64      * @param tagName 
    65      * @param index 
    66      * @param id 
    67      * @param children 
     65     * instantiates a new element representing a tag in an HTML page 
     66     * </p> 
     67     * 
     68     * @param parentPath the path through the DOM to the parent node of the represented tag  
     69     * @param tagName    the name of the represented tag 
     70     * @param id         the id of the tag in the DOM 
     71     * @param index      the index of the represented tag regarding all tags with the same tag name 
     72     *                   in the list of children of the parent tag 
    6873     */ 
    6974    HtmlPageElement(String parentPath, String tagName, String id, Integer index) { 
    … …  
    7681    /** 
    7782     * <p> 
    78      * TODO: comment 
    79      * </p> 
    80      * 
    81      * @param tagName 
    82      * @param index 
    83      * @param id 
    84      * @param children 
     83     * instantiates a new element representing an HTML page 
     84     * </p> 
     85     * 
     86     * @param parentPath the path through the DOM to the parent node of the represented tag which is 
     87     *                   usually a server 
     88     * @param tagName    the name of the represented tag which is the path of the web page 
     89     * @param title      the title of the web page 
     90     * @param id         the id of the web page which is its path 
     91     * @param index      usually 0 
    8592     */ 
    8693    HtmlPageElement(String parentPath, String tagName, String id, String title, Integer index) { 
    … …  
    9097 
    9198    /** 
     99     * <p> 
     100     * returns the name of the tag represented by this page element. May also be the name of the 
     101     * server or the page. 
     102     * </p> 
     103     *  
    92104     * @return the tagName 
    93105     */ 
    … …  
    97109 
    98110    /** 
     111     * <p> 
     112     * returns the id of the page element. May also be the name of the server including port 
     113     * number or the URL of the page 
     114     * </p> 
     115     *  
    99116     * @return the id 
    100117     */ 
    … …  
    104121 
    105122    /** 
     123     * <p> 
     124     * returns the title of the page if a page is represented through this element 
     125     * </p> 
     126     *  
    106127     * @return the title 
    107128     */ 
    … …  
    111132 
    112133    /** 
     134     * <p> 
     135     * returns the index of this element regarding all elements with the same tag name in the list 
     136     * of children of the parent element 
     137     * </p> 
     138     *  
    113139     * @return the index 
    114140     */ 
    … …  
    118144 
    119145    /** 
     146     * <p> 
     147     * returns the children of this element if any, null else 
     148     * </p> 
     149     *  
    120150     * @return the children 
    121151     */ 
    … …  
    126156 
    127157    /** 
    128      *  
     158     * adds a child to this element 
     159     *  
     160     * @param child the child to be added 
    129161     */ 
    130162    void addChild(HtmlPageElement child) { 
    … …  
    140172    /** 
    141173     * <p> 
    142      * TODO: comment 
    143      * </p> 
    144      * 
    145      * @return 
     174     * returns the path to the parent of this page element or null, if this is the root element 
     175     * </p> 
     176     * 
     177     * @return as described 
    146178     */ 
    147179    String getParentPath() { 
    … …  
    151183    /** 
    152184     * <p> 
    153      * TODO: comment 
    154      * </p> 
    155      * 
    156      * @return 
     185     * calculates and returns the path to the represented page element through the DOM. Includes 
     186     * the parent path if any. The represented element is included in the path with its tag name 
     187     * and its id if it has one, or its index. 
     188     * </p> 
     189     * 
     190     * @return as described 
    157191     */ 
    158192    String getPath() { 
Note: See TracChangeset for help on using the changeset viewer.