[927] | 1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany
|
---|
| 2 | //
|
---|
| 3 | // Licensed under the Apache License, Version 2.0 (the "License");
|
---|
| 4 | // you may not use this file except in compliance with the License.
|
---|
| 5 | // You may obtain a copy of the License at
|
---|
| 6 | //
|
---|
| 7 | // http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 8 | //
|
---|
| 9 | // Unless required by applicable law or agreed to in writing, software
|
---|
| 10 | // distributed under the License is distributed on an "AS IS" BASIS,
|
---|
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
| 12 | // See the License for the specific language governing permissions and
|
---|
| 13 | // limitations under the License.
|
---|
[831] | 14 |
|
---|
[922] | 15 | package de.ugoe.cs.autoquest.eventcore.guimodel;
|
---|
[545] | 16 |
|
---|
[922] | 17 | import de.ugoe.cs.autoquest.eventcore.IEventTarget;
|
---|
[545] | 18 |
|
---|
| 19 | /**
|
---|
[595] | 20 | * <p>
|
---|
[831] | 21 | * Common interface for all GUI elements.
|
---|
[595] | 22 | * </p>
|
---|
[545] | 23 | *
|
---|
[831] | 24 | * @version 1.0
|
---|
| 25 | * @author Patrick Harms
|
---|
[545] | 26 | */
|
---|
| 27 | public interface IGUIElement extends IEventTarget {
|
---|
[1051] | 28 |
|
---|
[545] | 29 | /**
|
---|
[595] | 30 | * <p>
|
---|
[831] | 31 | * Returns the specification of the GUI element.
|
---|
[595] | 32 | * </p>
|
---|
[831] | 33 | *
|
---|
| 34 | * @return the specification
|
---|
[545] | 35 | */
|
---|
[576] | 36 | public IGUIElementSpec getSpecification();
|
---|
[545] | 37 |
|
---|
| 38 | /**
|
---|
[595] | 39 | * <p>
|
---|
[831] | 40 | * Returns the parent of the GUI element.
|
---|
[595] | 41 | * </p>
|
---|
[831] | 42 | *
|
---|
| 43 | * @return the parent
|
---|
[603] | 44 | */
|
---|
| 45 | public IGUIElement getParent();
|
---|
| 46 |
|
---|
| 47 | /**
|
---|
| 48 | * <p>
|
---|
[1051] | 49 | * returns true, if a usage of this GUI element in a trace was observed
|
---|
| 50 | * </p>
|
---|
| 51 | *
|
---|
| 52 | * @return as described
|
---|
| 53 | */
|
---|
| 54 | public boolean isUsed();
|
---|
| 55 |
|
---|
| 56 | /**
|
---|
| 57 | * <p>
|
---|
| 58 | * Marks a GUI element as used.
|
---|
| 59 | * </p>
|
---|
| 60 | */
|
---|
| 61 | public void markUsed();
|
---|
| 62 |
|
---|
| 63 | /**
|
---|
| 64 | * <p>
|
---|
[831] | 65 | * Defines that {@link IGUIElement} implementations have to define equals.
|
---|
[603] | 66 | * </p>
|
---|
[831] | 67 | *
|
---|
| 68 | * @see Object#equals(Object)
|
---|
[545] | 69 | */
|
---|
[831] | 70 | @Override
|
---|
[603] | 71 | public boolean equals(Object other);
|
---|
[545] | 72 |
|
---|
[576] | 73 | /**
|
---|
[595] | 74 | * <p>
|
---|
[831] | 75 | * Defines that {@link IGUIElement} implementations have to define hashCode.
|
---|
[595] | 76 | * </p>
|
---|
[831] | 77 | *
|
---|
| 78 | * @see Object#hashCode()
|
---|
[576] | 79 | */
|
---|
[831] | 80 | @Override
|
---|
[576] | 81 | public int hashCode();
|
---|
[589] | 82 |
|
---|
[595] | 83 | /**
|
---|
| 84 | * <p>
|
---|
[831] | 85 | * Updates the specification of a GUI element with another specification, e.g., to add further
|
---|
| 86 | * known names of the GUI element.
|
---|
[595] | 87 | * </p>
|
---|
[831] | 88 | *
|
---|
| 89 | * @param furtherSpec
|
---|
| 90 | * additional specification
|
---|
[595] | 91 | */
|
---|
| 92 | public void updateSpecification(IGUIElementSpec furtherSpec);
|
---|
[613] | 93 |
|
---|
| 94 | /**
|
---|
| 95 | * <p>
|
---|
[831] | 96 | * The {@link IGUIElement} that is passed by this function is equal to the current GUI element
|
---|
| 97 | * and will hereafter be treated as such.
|
---|
[613] | 98 | * </p>
|
---|
[831] | 99 | *
|
---|
[613] | 100 | * @param guiElement
|
---|
[831] | 101 | * GUI element that is equal
|
---|
[613] | 102 | */
|
---|
| 103 | public void addEqualGUIElement(IGUIElement equalElement);
|
---|
[545] | 104 | }
|
---|