[544] | 1 | package de.ugoe.cs.quest.eventcore.gui;
|
---|
| 2 |
|
---|
[564] | 3 | import java.io.Serializable;
|
---|
[544] | 4 | import java.util.ArrayList;
|
---|
| 5 | import java.util.Collection;
|
---|
| 6 | import java.util.List;
|
---|
| 7 |
|
---|
| 8 | import de.ugoe.cs.quest.eventcore.Event;
|
---|
| 9 |
|
---|
| 10 | /**
|
---|
| 11 | * TODO comment
|
---|
| 12 | *
|
---|
| 13 | * @version $Revision: $ $Date: $
|
---|
| 14 | * @author 2011, last modified by $Author: $
|
---|
| 15 | */
|
---|
| 16 | public class InteractionEventList extends ArrayList<Event> implements List<Event> {
|
---|
[550] | 17 |
|
---|
[564] | 18 | /** */
|
---|
| 19 | private static final long serialVersionUID = 1L;
|
---|
| 20 |
|
---|
[544] | 21 | /** stores the events to be handled later in the order, they should be processed */
|
---|
[550] | 22 | private List<KeyEventPair> eventPairs = new ArrayList<KeyEventPair>();
|
---|
[544] | 23 |
|
---|
| 24 | /**
|
---|
| 25 | * this method sorts interaction events for pressed keys. The reason is, that sometimes the
|
---|
| 26 | * release of one key comes after the pressing of the succeeding key. This only makes sense for
|
---|
| 27 | * shift, ctrl or alt keys, but not for usual characters. So the events are sorted.<br/>
|
---|
| 28 | * Furthermore, this methods creates key released events in the specific case, where a key is
|
---|
| 29 | * pressed for a long time. Here, many subsequent key pressed events for the same key can be
|
---|
| 30 | * observed, for which there are no key released events.
|
---|
| 31 | */
|
---|
| 32 | @Override
|
---|
| 33 | public boolean add(Event event) {
|
---|
| 34 | if (event.getType() instanceof KeyInteraction) {
|
---|
[550] | 35 | for (int i = 0; i < eventPairs.size(); i++) {
|
---|
| 36 | KeyEventPair eventPair = eventPairs.get(i);
|
---|
[544] | 37 |
|
---|
| 38 | if (eventPair.process(event)) {
|
---|
| 39 | // handle all leading and completed event pairs, if any
|
---|
[550] | 40 | while ((eventPairs.size() > 0) && (eventPairs.get(0).isComplete())) {
|
---|
| 41 | addEventPair(eventPairs.get(0));
|
---|
| 42 | eventPairs.remove(0);
|
---|
[544] | 43 | }
|
---|
| 44 | return true;
|
---|
| 45 | }
|
---|
| 46 | }
|
---|
| 47 |
|
---|
[550] | 48 | eventPairs.add(new KeyEventPair(event));
|
---|
[544] | 49 | return true;
|
---|
| 50 | }
|
---|
| 51 | else {
|
---|
| 52 | // any other event is simply added
|
---|
| 53 | return super.add(event);
|
---|
| 54 | }
|
---|
| 55 | }
|
---|
| 56 |
|
---|
| 57 | /*
|
---|
| 58 | * (non-Javadoc)
|
---|
| 59 | *
|
---|
| 60 | * @see java.util.ArrayList#add(int, java.lang.Object)
|
---|
| 61 | */
|
---|
| 62 | @Override
|
---|
| 63 | public void add(int index, Event event) {
|
---|
| 64 | List<Event> remaining = new ArrayList<Event>();
|
---|
| 65 |
|
---|
| 66 | while (index < super.size()) {
|
---|
| 67 | remaining.add(super.remove(index));
|
---|
| 68 | }
|
---|
| 69 |
|
---|
| 70 | add(event);
|
---|
| 71 | addAll(remaining);
|
---|
| 72 | }
|
---|
| 73 |
|
---|
| 74 | /*
|
---|
| 75 | * (non-Javadoc)
|
---|
| 76 | *
|
---|
| 77 | * @see java.util.ArrayList#addAll(java.util.Collection)
|
---|
| 78 | */
|
---|
| 79 | @Override
|
---|
| 80 | public boolean addAll(Collection<? extends Event> events) {
|
---|
| 81 | int initialSize = super.size();
|
---|
| 82 |
|
---|
| 83 | for (Event event : events) {
|
---|
| 84 | add(event);
|
---|
| 85 | }
|
---|
| 86 |
|
---|
| 87 | return initialSize != super.size();
|
---|
| 88 | }
|
---|
| 89 |
|
---|
| 90 | /*
|
---|
| 91 | * (non-Javadoc)
|
---|
| 92 | *
|
---|
| 93 | * @see java.util.ArrayList#addAll(int, java.util.Collection)
|
---|
| 94 | */
|
---|
| 95 | @Override
|
---|
| 96 | public boolean addAll(int index, Collection<? extends Event> events) {
|
---|
| 97 | int initialSize = super.size();
|
---|
| 98 |
|
---|
| 99 | List<Event> remaining = new ArrayList<Event>();
|
---|
| 100 |
|
---|
| 101 | while (index < super.size()) {
|
---|
| 102 | remaining.add(super.remove(index));
|
---|
| 103 | }
|
---|
| 104 |
|
---|
| 105 | addAll(events);
|
---|
| 106 | addAll(remaining);
|
---|
| 107 |
|
---|
| 108 | return initialSize != super.size();
|
---|
| 109 | }
|
---|
| 110 |
|
---|
| 111 | /**
|
---|
| 112 | *
|
---|
| 113 | */
|
---|
| 114 | private void addEventPair(KeyEventPair eventPair) {
|
---|
[564] | 115 | super.add(eventPair.first);
|
---|
[544] | 116 |
|
---|
[564] | 117 | for (KeyEventPair child : eventPair.children) {
|
---|
[544] | 118 | addEventPair(child);
|
---|
| 119 | }
|
---|
| 120 |
|
---|
[564] | 121 | super.add(eventPair.second);
|
---|
[544] | 122 | }
|
---|
| 123 |
|
---|
| 124 | /**
|
---|
| 125 | *
|
---|
| 126 | */
|
---|
[564] | 127 | private static class KeyEventPair implements Serializable {
|
---|
[544] | 128 |
|
---|
[564] | 129 | /** */
|
---|
| 130 | private static final long serialVersionUID = 1L;
|
---|
| 131 |
|
---|
[544] | 132 | /** the first key interaction event */
|
---|
[564] | 133 | private Event first;
|
---|
[544] | 134 |
|
---|
| 135 | /** the second key interaction event */
|
---|
[564] | 136 | private Event second;
|
---|
[544] | 137 |
|
---|
| 138 | /** the children, this event pair may have */
|
---|
[564] | 139 | private List<KeyEventPair> children = new ArrayList<KeyEventPair>();
|
---|
[544] | 140 |
|
---|
| 141 | /**
|
---|
| 142 | *
|
---|
| 143 | */
|
---|
| 144 | private KeyEventPair(Event first) {
|
---|
| 145 | if (!(first.getType() instanceof KeyPressed)) {
|
---|
| 146 | throw new IllegalArgumentException
|
---|
| 147 | ("can only handle key pressed interaction events as first element of an" +
|
---|
| 148 | "event pair");
|
---|
| 149 | }
|
---|
[564] | 150 | this.first = first;
|
---|
[544] | 151 | }
|
---|
| 152 |
|
---|
| 153 | /**
|
---|
| 154 | * sorts the event as the second of the pair or as the closing of this. Returns true, if
|
---|
| 155 | * this matched, false else
|
---|
| 156 | */
|
---|
| 157 | private boolean process(Event event) {
|
---|
| 158 | if (!(event.getType() instanceof KeyInteraction)) {
|
---|
| 159 | throw new IllegalArgumentException("can only handle key interaction events");
|
---|
| 160 | }
|
---|
| 161 |
|
---|
| 162 | if (this.isComplete()) {
|
---|
| 163 | // do not process events, if there are no more events expected
|
---|
| 164 | return false;
|
---|
| 165 | }
|
---|
| 166 |
|
---|
| 167 | if ((event.getType() instanceof KeyReleased) &&
|
---|
[564] | 168 | (((KeyInteraction) first.getType()).getKey() ==
|
---|
[544] | 169 | ((KeyInteraction) event.getType()).getKey()) &&
|
---|
[564] | 170 | (second == null))
|
---|
[544] | 171 | {
|
---|
| 172 | // this is the release of the represented key. Store it and notify the processing.
|
---|
[564] | 173 | second = event;
|
---|
[544] | 174 | return true;
|
---|
| 175 | }
|
---|
| 176 | else if ((event.getType() instanceof KeyPressed) &&
|
---|
[564] | 177 | (((KeyInteraction) first.getType()).getKey() ==
|
---|
| 178 | ((KeyInteraction) event.getType()).getKey()) &&
|
---|
| 179 | (second == null))
|
---|
[544] | 180 | {
|
---|
| 181 | // the key was pressed before it was released again. This happens, if the key
|
---|
| 182 | // stays pressed for a long time. Generate a key released event but do not mark
|
---|
| 183 | // the new event as processed
|
---|
[564] | 184 | second = new Event
|
---|
[544] | 185 | (new KeyReleased(((KeyInteraction) event.getType()).getKey()),
|
---|
[564] | 186 | first.getTarget());
|
---|
[544] | 187 |
|
---|
| 188 | return false;
|
---|
| 189 | }
|
---|
[564] | 190 | else if (((KeyInteraction) first.getType()).getKey().isCombinationKey() &&
|
---|
| 191 | (((KeyInteraction) first.getType()).getKey() !=
|
---|
[544] | 192 | ((KeyInteraction) event.getType()).getKey()))
|
---|
| 193 | {
|
---|
| 194 | // this pair may have children. Let the event be processed by the children. If this
|
---|
| 195 | // doesn't work, add the event as a new child pair, if it is a new key pressed
|
---|
| 196 |
|
---|
[564] | 197 | for (KeyEventPair child : children) {
|
---|
[544] | 198 | if (child.process(event)) {
|
---|
| 199 | return true;
|
---|
| 200 | }
|
---|
| 201 | }
|
---|
| 202 |
|
---|
| 203 | if (event.getType() instanceof KeyPressed) {
|
---|
[564] | 204 | children.add(new KeyEventPair(event));
|
---|
[544] | 205 | return true;
|
---|
| 206 | }
|
---|
| 207 | else {
|
---|
| 208 | return false;
|
---|
| 209 | }
|
---|
| 210 | }
|
---|
| 211 | else {
|
---|
| 212 | // this pair may not have children
|
---|
| 213 | return false;
|
---|
| 214 | }
|
---|
| 215 | }
|
---|
| 216 |
|
---|
| 217 | /**
|
---|
| 218 | * @return
|
---|
| 219 | */
|
---|
| 220 | private boolean isComplete() {
|
---|
[564] | 221 | if ((first != null) && (second != null)) {
|
---|
| 222 | for (KeyEventPair child : children) {
|
---|
[544] | 223 | if (!child.isComplete()) {
|
---|
| 224 | return false;
|
---|
| 225 | }
|
---|
| 226 | }
|
---|
| 227 |
|
---|
| 228 | return true;
|
---|
| 229 | }
|
---|
| 230 | else {
|
---|
| 231 | return false;
|
---|
| 232 | }
|
---|
| 233 | }
|
---|
| 234 | }
|
---|
| 235 | }
|
---|