1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
/* * @(#)ActionEvent.java 1.31 06/04/13 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.awt.event; import java.awt.AWTEvent; import java.awt.Event; /** * A semantic event which indicates that a component-defined action occurred. * This high-level event is generated by a component (such as a * <code>Button</code>) when * the component-specific action occurs (such as being pressed). * The event is passed to every every <code>ActionListener</code> object * that registered to receive such events using the component's * <code>addActionListener</code> method. * <p> * <b>Note:</b> To invoke an <code>ActionEvent</code> on a * <code>Button</code> using the keyboard, use the Space bar. * <P> * The object that implements the <code>ActionListener</code> interface * gets this <code>ActionEvent</code> when the event occurs. The listener * is therefore spared the details of processing individual mouse movements * and mouse clicks, and can instead process a "meaningful" (semantic) * event like "button pressed". * * @see ActionListener * @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/eventmodel.html">Tutorial: Java 1.1 Event Model</a> * * @author Carl Quinn * @version 1.31 04/13/06 * @since 1.1 */ public class ActionEvent extends AWTEvent { /** * The shift modifier. An indicator that the shift key was held * down during the event. */ public static final int SHIFT_MASK = Event.SHIFT_MASK; /** * The control modifier. An indicator that the control key was held * down during the event. */ public static final int CTRL_MASK = Event.CTRL_MASK; /** * The meta modifier. An indicator that the meta key was held * down during the event. */ public static final int META_MASK = Event.META_MASK; /** * The alt modifier. An indicator that the alt key was held * down during the event. */ public static final int ALT_MASK = Event.ALT_MASK; /** * The first number in the range of ids used for action events. */ public static final int ACTION_FIRST = 1001; /** * The last number in the range of ids used for action events. */ public static final int ACTION_LAST = 1001; /** * This event id indicates that a meaningful action occured. */ public static final int ACTION_PERFORMED = ACTION_FIRST; //Event.ACTION_EVENT /** * The nonlocalized string that gives more details * of what actually caused the event. * This information is very specific to the component * that fired it. * @serial * @see #getActionCommand */ String actionCommand; /** * Timestamp of when this event occurred. Because an ActionEvent is a high- * level, semantic event, the timestamp is typically the same as an * underlying InputEvent. * * @serial * @see #getWhen */ long when; /** * This represents the key modifier that was selected, * and is used to determine the state of the selected key. * If no modifier has been selected it will default to * zero. * * @serial * @see #getModifiers */ int modifiers; /* * JDK 1.1 serialVersionUID */ private static final long serialVersionUID = -7671078796273832149L; /** * Constructs an <code>ActionEvent</code> object. * <p> * Note that passing in an invalid <code>id</code> results in * unspecified behavior. This method throws an * <code>IllegalArgumentException</code> if <code>source</code> * is <code>null</code>. * A <code>null</code> <code>command</code> string is legal, * but not recommended. * * @param source the object that originated the event * @param id an integer that identifies the event * @param command a string that may specify a command (possibly one * of several) associated with the event * @throws IllegalArgumentException if <code>source</code> is null */ public ActionEvent(Object source, int id, String command) { this(source, id, command, 0); } /** * Constructs an <code>ActionEvent</code> object with modifier keys. * <p> * Note that passing in an invalid <code>id</code> results in * unspecified behavior. This method throws an * <code>IllegalArgumentException</code> if <code>source</code> * is <code>null</code>. * A <code>null</code> <code>command</code> string is legal, * but not recommended. * * @param source the object that originated the event * @param id an integer that identifies the event * @param command a string that may specify a command (possibly one * of several) associated with the event * @param modifiers the modifier keys held down during this action * @throws IllegalArgumentException if <code>source</code> is null */ public ActionEvent(Object source, int id, String command, int modifiers) { this(source, id, command, 0, modifiers); } /** * Constructs an <code>ActionEvent</code> object with the specified * modifier keys and timestamp. * <p> * Note that passing in an invalid <code>id</code> results in * unspecified behavior. This method throws an * <code>IllegalArgumentException</code> if <code>source</code> * is <code>null</code>. * A <code>null</code> <code>command</code> string is legal, * but not recommended. * * @param source the object that originated the event * @param id an integer that identifies the event * @param command a string that may specify a command (possibly one * of several) associated with the event * @param when the time the event occurred * @param modifiers the modifier keys held down during this action * @throws IllegalArgumentException if <code>source</code> is null * * @since 1.4 */ public ActionEvent(Object source, int id, String command, long when, int modifiers) { super(source, id); this.actionCommand = command; this.when = when; this.modifiers = modifiers; } /** * Returns the command string associated with this action. * This string allows a "modal" component to specify one of several * commands, depending on its state. For example, a single button might * toggle between "show details" and "hide details". The source object * and the event would be the same in each case, but the command string * would identify the intended action. * <p> * Note that if a <code>null</code> command string was passed * to the constructor for this <code>ActionEvent</code>, this * this method returns <code>null</code>. * * @return the string identifying the command for this event */ public String getActionCommand() { return actionCommand; } /** * Returns the timestamp of when this event occurred. Because an * ActionEvent is a high-level, semantic event, the timestamp is typically * the same as an underlying InputEvent. * * @return this event's timestamp * @since 1.4 */ public long getWhen() { return when; } /** * Returns the modifier keys held down during this action event. * * @return the bitwise-or of the modifier constants */ public int getModifiers() { return modifiers; } /** * Returns a parameter string identifying this action event. * This method is useful for event-logging and for debugging. * * @return a string identifying the event and its associated command */ public String paramString() { String typeStr; switch(id) { case ACTION_PERFORMED: typeStr = "ACTION_PERFORMED"; break; default: typeStr = "unknown type"; } return typeStr + ",cmd="+actionCommand+",when="+when+",modifiers="+ KeyEvent.getKeyModifiersText(modifiers); } }