Last change
on this file since 846 was
831,
checked in by sherbold, 12 years ago
|
- code documentation and clean-up
|
-
Property svn:executable set to
*
|
File size:
1.7 KB
|
Line | |
---|
1 |
|
---|
2 | package de.ugoe.cs.quest.eventcore.guimodel;
|
---|
3 |
|
---|
4 | import de.ugoe.cs.quest.eventcore.IEventTarget;
|
---|
5 |
|
---|
6 | /**
|
---|
7 | * <p>
|
---|
8 | * Common interface for all GUI elements.
|
---|
9 | * </p>
|
---|
10 | *
|
---|
11 | * @version 1.0
|
---|
12 | * @author Patrick Harms
|
---|
13 | */
|
---|
14 | public interface IGUIElement extends IEventTarget {
|
---|
15 |
|
---|
16 | /**
|
---|
17 | * <p>
|
---|
18 | * Returns the specification of the GUI element.
|
---|
19 | * </p>
|
---|
20 | *
|
---|
21 | * @return the specification
|
---|
22 | */
|
---|
23 | public IGUIElementSpec getSpecification();
|
---|
24 |
|
---|
25 | /**
|
---|
26 | * <p>
|
---|
27 | * Returns the parent of the GUI element.
|
---|
28 | * </p>
|
---|
29 | *
|
---|
30 | * @return the parent
|
---|
31 | */
|
---|
32 | public IGUIElement getParent();
|
---|
33 |
|
---|
34 | /**
|
---|
35 | * <p>
|
---|
36 | * Defines that {@link IGUIElement} implementations have to define equals.
|
---|
37 | * </p>
|
---|
38 | *
|
---|
39 | * @see Object#equals(Object)
|
---|
40 | */
|
---|
41 | @Override
|
---|
42 | public boolean equals(Object other);
|
---|
43 |
|
---|
44 | /**
|
---|
45 | * <p>
|
---|
46 | * Defines that {@link IGUIElement} implementations have to define hashCode.
|
---|
47 | * </p>
|
---|
48 | *
|
---|
49 | * @see Object#hashCode()
|
---|
50 | */
|
---|
51 | @Override
|
---|
52 | public int hashCode();
|
---|
53 |
|
---|
54 | /**
|
---|
55 | * <p>
|
---|
56 | * Updates the specification of a GUI element with another specification, e.g., to add further
|
---|
57 | * known names of the GUI element.
|
---|
58 | * </p>
|
---|
59 | *
|
---|
60 | * @param furtherSpec
|
---|
61 | * additional specification
|
---|
62 | */
|
---|
63 | public void updateSpecification(IGUIElementSpec furtherSpec);
|
---|
64 |
|
---|
65 | /**
|
---|
66 | * <p>
|
---|
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.
|
---|
69 | * </p>
|
---|
70 | *
|
---|
71 | * @param guiElement
|
---|
72 | * GUI element that is equal
|
---|
73 | */
|
---|
74 | public void addEqualGUIElement(IGUIElement equalElement);
|
---|
75 | }
|
---|
Note: See
TracBrowser
for help on using the repository browser.