Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/eventcore/JFCEventId.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/eventcore/JFCEventId.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/eventcore/JFCEventId.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.eventcore; @@ -6,30 +7,34 @@ /** - * TODO comment + *

+ * Enumeration to deal with JFC event ids. + *

* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public enum JFCEventId { - - MOUSE_CLICKED(MouseEvent.MOUSE_CLICKED), - MOUSE_PRESSED(MouseEvent.MOUSE_PRESSED), - MOUSE_RELEASED(MouseEvent.MOUSE_RELEASED), - MOUSE_MOVED(MouseEvent.MOUSE_MOVED), - MOUSE_ENTERED(MouseEvent.MOUSE_ENTERED), - MOUSE_EXITED(MouseEvent.MOUSE_EXITED), - MOUSE_DRAGGED(MouseEvent.MOUSE_DRAGGED), - MOUSE_WHEEL(MouseEvent.MOUSE_WHEEL), - FOCUS_GAINED(FocusEvent.FOCUS_GAINED), - FOCUS_LOST(FocusEvent.FOCUS_LOST), - KEY_TYPED(KeyEvent.KEY_TYPED), - KEY_PRESSED(KeyEvent.KEY_PRESSED), - KEY_RELEASED(KeyEvent.KEY_RELEASED); - /** the numerical representation of the event type */ + MOUSE_CLICKED(MouseEvent.MOUSE_CLICKED), MOUSE_PRESSED(MouseEvent.MOUSE_PRESSED), + MOUSE_RELEASED(MouseEvent.MOUSE_RELEASED), MOUSE_MOVED(MouseEvent.MOUSE_MOVED), MOUSE_ENTERED( + MouseEvent.MOUSE_ENTERED), MOUSE_EXITED(MouseEvent.MOUSE_EXITED), MOUSE_DRAGGED( + MouseEvent.MOUSE_DRAGGED), MOUSE_WHEEL(MouseEvent.MOUSE_WHEEL), FOCUS_GAINED( + FocusEvent.FOCUS_GAINED), FOCUS_LOST(FocusEvent.FOCUS_LOST), KEY_TYPED(KeyEvent.KEY_TYPED), + KEY_PRESSED(KeyEvent.KEY_PRESSED), KEY_RELEASED(KeyEvent.KEY_RELEASED); + + /** + *

+ * Numerical representation of the event type. + *

+ */ private int mNumber; /** + *

+ * Constructor. Creates a new JFCEventId. + *

+ * * @param number + * numerical representation of the event type. */ JFCEventId(int number) { @@ -38,5 +43,9 @@ /** - * @return Returns the number. + *

+ * Returns the numerical representation of the event type. + *

+ * + * @return the numerical representation */ public int getNumber() { @@ -45,7 +54,15 @@ /** - * + *

+ * Parses an {@link String} and returns the respective JFCEventId if possible. + *

+ * + * @param numberString + * String representation of the event type + * @return created JFCEventId + * @throws IllegalArgumentException + * thrown if there is no JFCEventId that correlates to numberString */ - public static JFCEventId parseEventId(String numberString) { + public static JFCEventId parseEventId(String numberString) throws IllegalArgumentException { try { int number = Integer.parseInt(numberString); @@ -58,7 +75,15 @@ /** - * + *

+ * Returns the JFCEventId associated with an integer. + *

+ * + * @param number + * integer to which the according JFCEventId is returned + * @return the JFCEventId + * @throws IllegalArgumentException + * thrown if there is no JFCEventId that correlates to number */ - public static JFCEventId valueOf(int number) { + public static JFCEventId valueOf(int number) throws IllegalArgumentException { for (JFCEventId type : JFCEventId.values()) { if (type.mNumber == number) { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCButton.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCButton.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCButton.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents buttons in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCButton extends JFCGUIElement implements IButton { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCButton. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCButton(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCCanvas.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCCanvas.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCCanvas.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents canvas' in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCCanvas extends JFCGUIElement implements ICanvas { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCCanvas. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCCanvas(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCCheckBox.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCCheckBox.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCCheckBox.java (revision 835) @@ -4,4 +4,5 @@ // Creation : 2012 by pharms // Copyright : Patrick Harms, 2012 + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -10,22 +11,29 @@ /** *

- * TODO comment + * Class that represents check boxes in JFC GUIs. *

* - * @version $Revision: $ $Date: 03.09.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ public class JFCCheckBox extends JFCGUIElement implements ICheckBox { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** *

- * TODO: comment + * Constructor. Creates a new JFCCheckBox. *

- * + * * @param specification + * specification of created GUI element * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCCheckBox(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -33,4 +41,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCComboBox.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCComboBox.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCComboBox.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents combo boxes in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCComboBox extends JFCGUIElement implements IComboBox { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCComboBox. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCComboBox(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCDialog.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCDialog.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCDialog.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents dialogs in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCDialog extends JFCGUIElement implements IFrame { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCDialog. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCDialog(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCFrame.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCFrame.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCFrame.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents frames in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCFrame extends JFCGUIElement implements IFrame { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCFrame. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCFrame(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCGUIElement.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCGUIElement.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCGUIElement.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -5,11 +6,13 @@ /** - * TODO comment + *

+ * Base class for all JFC GUI elements. + *

* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @version 1.0 + * @author Patrick Harms */ public class JFCGUIElement extends AbstractDefaultGUIElement { - + /** *

@@ -19,11 +22,21 @@ private static final long serialVersionUID = 1L; - /** the specification of the GUI Element */ + /** + *

+ * Specification of the GUI Element + *

+ */ private JFCGUIElementSpec specification; /** - * @param name - * @param id - * @param isModal + *

+ * Constructor. Creates a new JFCGUIElement. + *

+ * + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCGUIElement(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -32,5 +45,7 @@ } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see de.ugoe.cs.quest.eventcore.IEventTarget#getPlatform() */ @@ -41,7 +56,9 @@ /** - * TODO: comment + *

+ * Returns the type of the GUI element, i.e., the name of its Java class. + *

* - * @return + * @return the Java class name */ public String getJavaType() { @@ -50,5 +67,9 @@ /** - * @return Returns the name. + *

+ * Returns the name of the GUI element. + *

+ * + * @return the name */ String getName() { @@ -57,4 +78,8 @@ /** + *

+ * Returns the icon of the GUI element. + *

+ * * @return the icon */ @@ -64,4 +89,8 @@ /** + *

+ * Returns the index of the GUI element. + *

+ * * @return the index */ @@ -71,5 +100,9 @@ /** - * @return the hashCode + *

+ * Returns the object hash of the GUI element. + *

+ * + * @return the object hash */ int getElementHash() { @@ -77,8 +110,10 @@ } - /** - *

- * TODO comment - *

+ /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.quest.eventcore.guimodel.IGUIElement#updateSpecification(de.ugoe.cs.quest.eventcore + * .guimodel.IGUIElementSpec) */ @Override @@ -88,5 +123,5 @@ } } - + /* * (non-Javadoc) @@ -97,10 +132,10 @@ public String getStringIdentifier() { String str = this.toString(); - if( getParent()!=null ) { + if (getParent() != null) { return getParent().getStringIdentifier() + "->" + str; } return str; } - + /* * (non-Javadoc) @@ -110,9 +145,17 @@ @Override public String toString() { - String str = getElementDescriptor() + "(" + getName() + "," + getElementHash() + "," + - getIcon() + "," + getIndex() +")"; + String str = + getElementDescriptor() + "(" + getName() + "," + getElementHash() + "," + getIcon() + + "," + getIndex() + ")"; return str; } - + + /** + *

+ * A short string describing the GUI element, e.g., Button, Canvas, or ScrollBar. + *

+ * + * @return short element descriptor + */ protected String getElementDescriptor() { return "Default"; Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCGUIElementSpec.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCGUIElementSpec.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCGUIElementSpec.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -6,22 +7,27 @@ import org.apache.commons.collections15.CollectionUtils; +import de.ugoe.cs.quest.eventcore.guimodel.IGUIElement; import de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec; /** *

- * TODO comment + * Implements the specification of {@link IGUIElement} for {@link JFCGUIElement}s. *

* - * @version $Revision: $ $Date: 17.08.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ public class JFCGUIElementSpec implements IGUIElementSpec { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** *

- * current name of the GUI element + * Current name of the GUI element *

*/ @@ -30,21 +36,33 @@ /** *

- * previous names of the GUI element as it may have changed over time. + * Previous names of the GUI element as it may have changed over time. *

*/ private List formerNames = new ArrayList(); - /** */ + /** + *

+ * Type of the GUI element, i.e., its Java class. + *

+ */ private String type = null; - - /** */ + + /** + *

+ * Icon associated with the GUI element. + *

+ */ private String icon = null; - - /** */ + + /** + *

+ * Index of the GUI element in its parent element. + *

+ */ private int index = -1; - - /** - *

- * hash code of the window element. Used as unique identifier during its existence. + + /** + *

+ * Hash code of the window element. Used as unique identifier during its existence. *

*/ @@ -53,26 +71,28 @@ /** *

- * previous handles of the window as the window may have been destroyed and recreated + * Previous hashes of the window as the window may have been destroyed and recreated. *

*/ private List formerElementHashes = new ArrayList(); - /* (non-Javadoc) - * @see de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec#getSecificationSimilarity(IGUIElementSpec) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec#getSecificationSimilarity(IGUIElementSpec + * ) */ @Override public boolean getSimilarity(IGUIElementSpec other) { - if (this == other) - { - return true; - } - - if (!(other instanceof JFCGUIElementSpec)) - { + if (this == other) { + return true; + } + + if (!(other instanceof JFCGUIElementSpec)) { return false; } - + JFCGUIElementSpec otherSpec = (JFCGUIElementSpec) other; - + if ((type != otherSpec.type) && ((type != null) && (!type.equals(otherSpec.type)))) { return false; @@ -89,20 +109,21 @@ // a new element is added or another one is removed. If the element hash or the name stay // the same, then similarity is given. Therefore these are the first two comparisons - + if (elementHash == otherSpec.elementHash) { return true; } - + if ((name != null) && (name.equals(otherSpec.name))) { return true; } - - if ((((name == null) && (otherSpec.name == null)) || - (("".equals(name)) && ("".equals(otherSpec.name)))) && - (formerNames.size() == 0) && (otherSpec.formerNames.size() == 0)) + + if ((((name == null) && (otherSpec.name == null)) || (("".equals(name)) && ("" + .equals(otherSpec.name)))) && + (formerNames.size() == 0) && + (otherSpec.formerNames.size() == 0)) { return true; } - + // if the id and the name did not stay the same, then the name should be checked first. // One of all known names of one of the specs must be equal to one of the known names of the @@ -117,9 +138,9 @@ return index == otherSpec.index; } - + if (CollectionUtils.containsAny(formerNames, otherSpec.formerNames)) { return index == otherSpec.index; } - + // ok. Even the names do not match. This is usually a clear indication, that the elements // are distinct. However, we check, if the former ids matched. This is very unlikely @@ -135,33 +156,32 @@ return index == otherSpec.index; } - + if (CollectionUtils.containsAny(formerElementHashes, otherSpec.formerElementHashes)) { return index == otherSpec.index; } - + // now we can be really sure, that the GUI elements differ - + return false; } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec#equals(IGUIElementSpec) */ @Override public boolean equals(Object other) { - if (this == other) - { - return true; - } - - if (!(other instanceof JFCGUIElementSpec)) - { + if (this == other) { + return true; + } + + if (!(other instanceof JFCGUIElementSpec)) { return false; } - + JFCGUIElementSpec otherSpec = (JFCGUIElementSpec) other; - - return - ((name == otherSpec.name) || ((name != null) && (name.equals(otherSpec.name)))) && + + return ((name == otherSpec.name) || ((name != null) && (name.equals(otherSpec.name)))) && ((type == otherSpec.type) || ((type != null) && (type.equals(otherSpec.type)))) && ((icon == otherSpec.icon) || ((icon != null) && (icon.equals(otherSpec.icon)))) && @@ -169,5 +189,7 @@ } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see java.lang.Object#hashCode() */ @@ -178,9 +200,13 @@ /** + *

+ * Returns the name of the specified GUI element. + *

+ * * @return the name */ public String getName() { StringBuffer names = new StringBuffer(); - + if (name != null) { names.append('"'); @@ -191,9 +217,9 @@ names.append("NOT_SET"); } - + if (formerNames.size() > 0) { - + names.append(" (aka "); - + for (int i = 0; i < formerNames.size(); i++) { if (i > 0) { @@ -205,12 +231,16 @@ names.append('"'); } - + names.append(")"); } - + return names.toString(); } /** + *

+ * Returns the title of the specified GUI element. + *

+ * * @return the title */ @@ -220,4 +250,8 @@ /** + *

+ * Returns the icon associated with the specified GUI element. + *

+ * * @return the icon */ @@ -227,4 +261,8 @@ /** + *

+ * Returns the index of the specified GUI element in its parent element. + *

+ * * @return the index */ @@ -234,4 +272,8 @@ /** + *

+ * Returns the object hash of the specified GUI element. + *

+ * * @return the elementHash */ @@ -241,19 +283,28 @@ /** - * @param name the name to set + *

+ * Sets the name of the specified GUI element. + *

+ * + * @param name + * the name */ public void setName(String newName) { - if ((this.name != null) && - (!this.name.equals(newName)) && + if ((this.name != null) && (!this.name.equals(newName)) && (!this.formerNames.contains(this.name))) { this.formerNames.add(this.name); } - + this.name = newName; } /** - * @param title the title to set + *

+ * Sets the type of the specified GUI element. + *

+ * + * @param title + * the title */ public void setType(String type) { @@ -262,5 +313,10 @@ /** - * @param icon the icon to set + *

+ * Sets the icon associated with the specified GUI element. + *

+ * + * @param icon + * the icon */ public void setIcon(String icon) { @@ -269,5 +325,10 @@ /** - * @param index the index to set + *

+ * Sets the index in its parent element of the specified GUI element. + *

+ * + * @param index + * the index */ public void setIndex(int index) { @@ -276,22 +337,26 @@ /** - * @param elementHash the elementHash to set + *

+ * Sets the object hash of the specified GUI element. + *

+ * + * @param elementHash + * the elementHash */ public void setElementHash(int newElementHash) { - if ((this.elementHash > -1) && - !this.formerElementHashes.contains(this.elementHash)) - { + if ((this.elementHash > -1) && !this.formerElementHashes.contains(this.elementHash)) { this.formerElementHashes.add(this.elementHash); } - + this.elementHash = newElementHash; } - - /** - *

- * TODO: comment - *

- * + + /** + *

+ * Updates the specification with another specification. + *

+ * * @param furtherSpec + * specification used to update the current specification */ void update(JFCGUIElementSpec other) { @@ -309,6 +374,5 @@ } - if ((name != other.name) && (name != null) && (!name.equals(other.name))) - { + if ((name != other.name) && (name != null) && (!name.equals(other.name))) { setName(other.name); } @@ -316,7 +380,12 @@ } + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ public String toString() { - return "[" + getName() + ";\"" + type + "\";\"" + icon + "\";" + index + ";" + - elementHash + "]"; + return "[" + getName() + ";\"" + type + "\";\"" + icon + "\";" + index + ";" + elementHash + + "]"; } Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCListBox.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCListBox.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCListBox.java (revision 835) @@ -4,4 +4,5 @@ // Creation : 2012 by pharms // Copyright : Patrick Harms, 2012 + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -10,22 +11,29 @@ /** *

- * TODO comment + * Class that represents list boxes in JFC GUIs. *

* - * @version $Revision: $ $Date: 03.09.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ public class JFCListBox extends JFCGUIElement implements IListBox { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** *

- * TODO: comment + * Constructor. Creates a new JFCListBox. *

- * + * * @param specification + * specification of created GUI element * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCListBox(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -33,4 +41,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenu.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenu.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenu.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents menus in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCMenu extends JFCGUIElement implements IMenu { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCMenu. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCMenu(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenuBar.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenuBar.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenuBar.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that menu bar buttons in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCMenuBar extends JFCMenu implements IMenuBar { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCMenuBar. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCMenuBar(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCMenu#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenuButton.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenuButton.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCMenuButton.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents menu buttons in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCMenuButton extends JFCButton implements IMenuButton { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCMenuButton. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCMenuButton(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCButton#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCPanel.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCPanel.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCPanel.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents panels in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCPanel extends JFCGUIElement implements IPanel { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCPanel. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCPanel(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCRadioButton.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCRadioButton.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCRadioButton.java (revision 835) @@ -4,4 +4,5 @@ // Creation : 2012 by pharms // Copyright : Patrick Harms, 2012 + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -10,22 +11,29 @@ /** *

- * TODO comment + * Class that represents radio buttons in JFC GUIs. *

* - * @version $Revision: $ $Date: 03.09.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ public class JFCRadioButton extends JFCGUIElement implements IRadioButton { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** *

- * TODO: comment + * Constructor. Creates a new JFCRadioButton. *

- * + * * @param specification + * specification of created GUI element * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCRadioButton(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -33,4 +41,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCScrollBar.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCScrollBar.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCScrollBar.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents scroll bars in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCScrollBar extends JFCGUIElement implements IScrollBar { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCScrollBar. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCScrollBar(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCScrollPane.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCScrollPane.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCScrollPane.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents scroll panes in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCScrollPane extends JFCGUIElement implements IScrollPane { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCScrollPane. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCScrollPane(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCShape.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCShape.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCShape.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents shapes in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCShape extends JFCGUIElement implements IShape { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCShape. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCShape(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCSplitPane.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCSplitPane.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCSplitPane.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents split panes in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCSplitPane extends JFCGUIElement implements ISplitPane { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCSplitPane. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCSplitPane(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTabbedPane.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTabbedPane.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTabbedPane.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents tabbed panes in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCTabbedPane extends JFCGUIElement implements ITabbedPane { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCTabbedPane. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCTabbedPane(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTable.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTable.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTable.java (revision 835) @@ -4,4 +4,5 @@ // Creation : 2012 by pharms // Copyright : Patrick Harms, 2012 + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -10,22 +11,29 @@ /** *

- * TODO comment + * Class that represents tables in JFC GUIs. *

* - * @version $Revision: $ $Date: 03.09.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ public class JFCTable extends JFCGUIElement implements ITable { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** *

- * TODO: comment + * Constructor. Creates a new JFCTable. *

- * + * * @param specification + * specification of created GUI element * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCTable(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -33,4 +41,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTextArea.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTextArea.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTextArea.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents text areas in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCTextArea extends JFCGUIElement implements ITextField { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCTextArea. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCTextArea(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTextField.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTextField.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTextField.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents text fields in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCTextField extends JFCGUIElement implements ITextField { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCTextField. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCTextField(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCToolBar.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCToolBar.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCToolBar.java (revision 835) @@ -1,2 +1,3 @@ + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -4,22 +5,30 @@ /** - * TODO comment + *

+ * Class that represents toolbars in JFC GUIs. + *

* - * @version $Revision: $ $Date: 13.05.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class JFCToolBar extends JFCGUIElement implements IToolBar { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** - * TODO: comment + *

+ * Constructor. Creates a new JFCToolBar. + *

* - * @param name - * @param type - * @param icon - * @param index - * @param hashCode + * @param specification + * specification of created GUI element + * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCToolBar(JFCGUIElementSpec specification, JFCGUIElement parent) { @@ -27,4 +36,9 @@ } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() { Index: trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTree.java =================================================================== --- trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTree.java (revision 834) +++ trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/guimodel/JFCTree.java (revision 835) @@ -4,4 +4,5 @@ // Creation : 2012 by pharms // Copyright : Patrick Harms, 2012 + package de.ugoe.cs.quest.plugin.jfc.guimodel; @@ -10,28 +11,39 @@ /** *

- * TODO comment + * Class that represents trees in JFC GUIs. *

* - * @version $Revision: $ $Date: 03.09.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ public class JFCTree extends JFCGUIElement implements ITree { - /** */ + /** + *

+ * Id for object serialization. + *

+ */ private static final long serialVersionUID = 1L; /** *

- * TODO: comment + * Constructor. Creates a new JFCTree. *

- * + * * @param specification + * specification of created GUI element * @param parent + * parent of the created GUI element; null means that the element is a top-level + * window */ public JFCTree(JFCGUIElementSpec specification, JFCGUIElement parent) { super(specification, parent); - // TODO Auto-generated constructor stub } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.quest.plugin.jfc.guimodel.JFCGUIElement#getElementDescriptor() + */ @Override protected String getElementDescriptor() {