<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (1.8.0_191) on Wed Oct 31 14:02:12 UTC 2018 --> <title>KeyEvent (JavaFX 8)</title> <meta name="date" content="2018-10-31"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="KeyEvent (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/KeyEvent.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../javafx/scene/input/KeyCombination.ModifierValue.html" title="enum in javafx.scene.input"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/input/Mnemonic.html" title="class in javafx.scene.input"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/input/KeyEvent.html" target="_top">Frames</a></li> <li><a href="KeyEvent.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">javafx.scene.input</div> <h2 title="Class KeyEvent" class="title">Class KeyEvent</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.util.EventObject</li> <li> <ul class="inheritance"> <li><a href="../../../javafx/event/Event.html" title="class in javafx.event">javafx.event.Event</a></li> <li> <ul class="inheritance"> <li><a href="../../../javafx/scene/input/InputEvent.html" title="class in javafx.scene.input">javafx.scene.input.InputEvent</a></li> <li> <ul class="inheritance"> <li>javafx.scene.input.KeyEvent</li> </ul> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Serializable, java.lang.Cloneable</dd> </dl> <hr> <br> <pre>public final class <span class="typeNameLabel">KeyEvent</span> extends <a href="../../../javafx/scene/input/InputEvent.html" title="class in javafx.scene.input">InputEvent</a></pre> <div class="block">An event which indicates that a keystroke occurred in a <a href="../../../javafx/scene/Node.html" title="class in javafx.scene"><code>Node</code></a>. <p> This event is generated when a key is pressed, released, or typed. Depending on the type of the event it is passed to <a href="../../../javafx/scene/Node.html#onKeyPressedProperty--"><code>onKeyPressed</code></a>, <a href="../../../javafx/scene/Node.html#onKeyTypedProperty--"><code>onKeyTyped</code></a> or <a href="../../../javafx/scene/Node.html#onKeyReleasedProperty--"><code>onKeyReleased</code></a> function. <p> <em>"Key typed" events</em> are higher-level and generally do not depend on the platform or keyboard layout. They are generated when a Unicode character is entered, and are the preferred way to find out about character input. In the simplest case, a key typed event is produced by a single key press (e.g., 'a'). Often, however, characters are produced by series of key presses (e.g., SHIFT + 'a'), and the mapping from key pressed events to key typed events may be many-to-one or many-to-many. Key releases are not usually necessary to generate a key typed event, but there are some cases where the key typed event is not generated until a key is released (e.g., entering ASCII sequences via the Alt-Numpad method in Windows). No key typed events are generated for keys that don't generate Unicode characters (e.g., action keys, modifier keys, etc.). <p> The <code>character</code> variable always contains a valid Unicode character(s) or CHAR_UNDEFINED. Character input is reported by key typed events; key pressed and key released events are not necessarily associated with character input. Therefore, the <code>character</code> variable is guaranteed to be meaningful only for key typed events. <p> For key pressed and key released events, the <code>code</code> variable contains the event's key code. For key typed events, the <code>code</code> variable always contains <code>KeyCode.UNDEFINED</code>. <p> <em>"Key pressed" and "key released" events</em> are lower-level and depend on the platform and keyboard layout. They are generated whenever a key is pressed or released, and are the only way to find out about keys that don't generate character input (e.g., action keys, modifier keys, etc.). The key being pressed or released is indicated by the code variable, which contains a virtual key code. <p> For triggering context menus see the <a href="../../../javafx/scene/input/ContextMenuEvent.html" title="class in javafx.scene.input"><code>ContextMenuEvent</code></a>.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 2.0</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../serialized-form.html#javafx.scene.input.KeyEvent">Serialized Form</a></dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#ANY">ANY</a></span></code> <div class="block">Common supertype for all key event types.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#CHAR_UNDEFINED">CHAR_UNDEFINED</a></span></code> <div class="block">KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character use this for the keyChar value.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#KEY_PRESSED">KEY_PRESSED</a></span></code> <div class="block">This event occurs when a key has been pressed.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#KEY_RELEASED">KEY_RELEASED</a></span></code> <div class="block">This event occurs when a key has been released.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#KEY_TYPED">KEY_TYPED</a></span></code> <div class="block">This event occurs when a character-generating key was typed (pressed and released).</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields.inherited.from.class.javafx.event.Event"> <!-- --> </a> <h3>Fields inherited from class javafx.event.<a href="../../../javafx/event/Event.html" title="class in javafx.event">Event</a></h3> <code><a href="../../../javafx/event/Event.html#consumed">consumed</a>, <a href="../../../javafx/event/Event.html#eventType">eventType</a>, <a href="../../../javafx/event/Event.html#NULL_SOURCE_TARGET">NULL_SOURCE_TARGET</a>, <a href="../../../javafx/event/Event.html#target">target</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="fields.inherited.from.class.java.util.EventObject"> <!-- --> </a> <h3>Fields inherited from class java.util.EventObject</h3> <code>source</code></li> </ul> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#KeyEvent-javafx.event.EventType-java.lang.String-java.lang.String-javafx.scene.input.KeyCode-boolean-boolean-boolean-boolean-">KeyEvent</a></span>(<a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> eventType, java.lang.String character, java.lang.String text, <a href="../../../javafx/scene/input/KeyCode.html" title="enum in javafx.scene.input">KeyCode</a> code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)</code> <div class="block">Constructs new KeyEvent event with null source and target and KeyCode object directly specified.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#KeyEvent-java.lang.Object-javafx.event.EventTarget-javafx.event.EventType-java.lang.String-java.lang.String-javafx.scene.input.KeyCode-boolean-boolean-boolean-boolean-">KeyEvent</a></span>(java.lang.Object source, <a href="../../../javafx/event/EventTarget.html" title="interface in javafx.event">EventTarget</a> target, <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> eventType, java.lang.String character, java.lang.String text, <a href="../../../javafx/scene/input/KeyCode.html" title="enum in javafx.scene.input">KeyCode</a> code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)</code> <div class="block">Constructs new KeyEvent event with null source and target and KeyCode object directly specified.</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#copyFor-java.lang.Object-javafx.event.EventTarget-">copyFor</a></span>(java.lang.Object newSource, <a href="../../../javafx/event/EventTarget.html" title="interface in javafx.event">EventTarget</a> newTarget)</code> <div class="block">Creates and returns a copy of this event with the specified event source and target.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#copyFor-java.lang.Object-javafx.event.EventTarget-javafx.event.EventType-">copyFor</a></span>(java.lang.Object source, <a href="../../../javafx/event/EventTarget.html" title="interface in javafx.event">EventTarget</a> target, <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> type)</code> <div class="block">Creates a copy of the given event with the given fields substituted.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#getCharacter--">getCharacter</a></span>()</code> <div class="block">The Unicode character or sequence of characters associated with the key typed event.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/scene/input/KeyCode.html" title="enum in javafx.scene.input">KeyCode</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#getCode--">getCode</a></span>()</code> <div class="block">The key code associated with the key in this key pressed or key released event.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#getEventType--">getEventType</a></span>()</code> <div class="block">Gets the event type of this event.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#getText--">getText</a></span>()</code> <div class="block">A String describing the key code, such as "HOME", "F1" or "A", for key pressed and key released events.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#isAltDown--">isAltDown</a></span>()</code> <div class="block">Returns whether or not the Alt modifier is down on this event.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#isControlDown--">isControlDown</a></span>()</code> <div class="block">Returns whether or not the Control modifier is down on this event.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#isMetaDown--">isMetaDown</a></span>()</code> <div class="block">Returns whether or not the Meta modifier is down on this event.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#isShiftDown--">isShiftDown</a></span>()</code> <div class="block">Returns whether or not the Shift modifier is down on this event.</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#isShortcutDown--">isShortcutDown</a></span>()</code> <div class="block">Returns whether or not the host platform common shortcut modifier is down on this event.</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/input/KeyEvent.html#toString--">toString</a></span>()</code> <div class="block">Returns a string representation of this <code>KeyEvent</code> object.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.javafx.event.Event"> <!-- --> </a> <h3>Methods inherited from class javafx.event.<a href="../../../javafx/event/Event.html" title="class in javafx.event">Event</a></h3> <code><a href="../../../javafx/event/Event.html#clone--">clone</a>, <a href="../../../javafx/event/Event.html#consume--">consume</a>, <a href="../../../javafx/event/Event.html#fireEvent-javafx.event.EventTarget-javafx.event.Event-">fireEvent</a>, <a href="../../../javafx/event/Event.html#getTarget--">getTarget</a>, <a href="../../../javafx/event/Event.html#isConsumed--">isConsumed</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject"> <!-- --> </a> <h3>Methods inherited from class java.util.EventObject</h3> <code>getSource</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="ANY"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ANY</h4> <pre>public static final <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> ANY</pre> <div class="block">Common supertype for all key event types.</div> </li> </ul> <a name="KEY_PRESSED"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KEY_PRESSED</h4> <pre>public static final <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> KEY_PRESSED</pre> <div class="block">This event occurs when a key has been pressed.</div> </li> </ul> <a name="KEY_RELEASED"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KEY_RELEASED</h4> <pre>public static final <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> KEY_RELEASED</pre> <div class="block">This event occurs when a key has been released.</div> </li> </ul> <a name="KEY_TYPED"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KEY_TYPED</h4> <pre>public static final <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> KEY_TYPED</pre> <div class="block">This event occurs when a character-generating key was typed (pressed and released). The event contains the <code>character</code> field containing the typed string, the <code>code</code> and <code>text</code> fields are not used.</div> </li> </ul> <a name="CHAR_UNDEFINED"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CHAR_UNDEFINED</h4> <pre>public static final java.lang.String CHAR_UNDEFINED</pre> <div class="block">KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character use this for the keyChar value.</div> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="KeyEvent-java.lang.Object-javafx.event.EventTarget-javafx.event.EventType-java.lang.String-java.lang.String-javafx.scene.input.KeyCode-boolean-boolean-boolean-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KeyEvent</h4> <pre>public KeyEvent(java.lang.Object source, <a href="../../../javafx/event/EventTarget.html" title="interface in javafx.event">EventTarget</a> target, <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> eventType, java.lang.String character, java.lang.String text, <a href="../../../javafx/scene/input/KeyCode.html" title="enum in javafx.scene.input">KeyCode</a> code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)</pre> <div class="block">Constructs new KeyEvent event with null source and target and KeyCode object directly specified.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>source</code> - the source of the event. Can be null.</dd> <dd><code>target</code> - the target of the event. Can be null.</dd> <dd><code>eventType</code> - The type of the event.</dd> <dd><code>character</code> - The character or sequence of characters associated with the event</dd> <dd><code>text</code> - A String describing the key code</dd> <dd><code>code</code> - The integer key code</dd> <dd><code>shiftDown</code> - true if shift modifier was pressed.</dd> <dd><code>controlDown</code> - true if control modifier was pressed.</dd> <dd><code>altDown</code> - true if alt modifier was pressed.</dd> <dd><code>metaDown</code> - true if meta modifier was pressed.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8.0</dd> </dl> </li> </ul> <a name="KeyEvent-javafx.event.EventType-java.lang.String-java.lang.String-javafx.scene.input.KeyCode-boolean-boolean-boolean-boolean-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>KeyEvent</h4> <pre>public KeyEvent(<a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> eventType, java.lang.String character, java.lang.String text, <a href="../../../javafx/scene/input/KeyCode.html" title="enum in javafx.scene.input">KeyCode</a> code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)</pre> <div class="block">Constructs new KeyEvent event with null source and target and KeyCode object directly specified.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>eventType</code> - The type of the event.</dd> <dd><code>character</code> - The character or sequence of characters associated with the event</dd> <dd><code>text</code> - A String describing the key code</dd> <dd><code>code</code> - The integer key code</dd> <dd><code>shiftDown</code> - true if shift modifier was pressed.</dd> <dd><code>controlDown</code> - true if control modifier was pressed.</dd> <dd><code>altDown</code> - true if alt modifier was pressed.</dd> <dd><code>metaDown</code> - true if meta modifier was pressed.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8.0</dd> </dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getCharacter--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCharacter</h4> <pre>public final java.lang.String getCharacter()</pre> <div class="block">The Unicode character or sequence of characters associated with the key typed event. Contains multiple elements if the key produced a single Unicode character from outside of the Basic Multilingual Plane which needs to be encoded by the corresponding surrogate pair in Java or if the key produced multiple Unicode characters itself. <p/> For example, <code>character</code> will have the value "A" for a key typed event generated by pressing SHIFT + 'a'. For key pressed and key released events, <code>character</code> is always <code>CHAR_UNDEFINED</code>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The Unicode character(s) associated with the key typed event</dd> </dl> </li> </ul> <a name="getText--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getText</h4> <pre>public final java.lang.String getText()</pre> <div class="block">A String describing the key code, such as "HOME", "F1" or "A", for key pressed and key released events. For key typed events, <code>text</code> is always the empty string.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>A String describing the key code</dd> </dl> </li> </ul> <a name="getCode--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCode</h4> <pre>public final <a href="../../../javafx/scene/input/KeyCode.html" title="enum in javafx.scene.input">KeyCode</a> getCode()</pre> <div class="block">The key code associated with the key in this key pressed or key released event. For key typed events, <code>code</code> is always <code>KeyCode.UNDEFINED</code>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The key code associated with the key in this event, <code>KeyCode.UNDEFINED</code> for key typed event</dd> </dl> </li> </ul> <a name="isShiftDown--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isShiftDown</h4> <pre>public final boolean isShiftDown()</pre> <div class="block">Returns whether or not the Shift modifier is down on this event.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>whether or not the Shift modifier is down on this event.</dd> </dl> </li> </ul> <a name="isControlDown--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isControlDown</h4> <pre>public final boolean isControlDown()</pre> <div class="block">Returns whether or not the Control modifier is down on this event.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>whether or not the Control modifier is down on this event.</dd> </dl> </li> </ul> <a name="isAltDown--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isAltDown</h4> <pre>public final boolean isAltDown()</pre> <div class="block">Returns whether or not the Alt modifier is down on this event.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>whether or not the Alt modifier is down on this event.</dd> </dl> </li> </ul> <a name="isMetaDown--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isMetaDown</h4> <pre>public final boolean isMetaDown()</pre> <div class="block">Returns whether or not the Meta modifier is down on this event.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>whether or not the Meta modifier is down on this event.</dd> </dl> </li> </ul> <a name="isShortcutDown--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isShortcutDown</h4> <pre>public final boolean isShortcutDown()</pre> <div class="block">Returns whether or not the host platform common shortcut modifier is down on this event. This common shortcut modifier is a modifier key which is used commonly in shortcuts on the host platform. It is for example <code>control</code> on Windows and <code>meta</code> (command key) on Mac.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd><code>true</code> if the shortcut modifier is down, <code>false</code> otherwise</dd> </dl> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <div class="block">Returns a string representation of this <code>KeyEvent</code> object.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.util.EventObject</code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a string representation of this <code>KeyEvent</code> object.</dd> </dl> </li> </ul> <a name="copyFor-java.lang.Object-javafx.event.EventTarget-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>copyFor</h4> <pre>public <a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a> copyFor(java.lang.Object newSource, <a href="../../../javafx/event/EventTarget.html" title="interface in javafx.event">EventTarget</a> newTarget)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../javafx/event/Event.html#copyFor-java.lang.Object-javafx.event.EventTarget-">Event</a></code></span></div> <div class="block">Creates and returns a copy of this event with the specified event source and target. If the source or target is set to <code>null</code>, it is replaced by the <code>NULL_SOURCE_TARGET</code> value.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../javafx/event/Event.html#copyFor-java.lang.Object-javafx.event.EventTarget-">copyFor</a></code> in class <code><a href="../../../javafx/event/Event.html" title="class in javafx.event">Event</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>newSource</code> - the new source of the copied event</dd> <dd><code>newTarget</code> - the new target of the copied event</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the event copy with the new source and target</dd> </dl> </li> </ul> <a name="copyFor-java.lang.Object-javafx.event.EventTarget-javafx.event.EventType-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>copyFor</h4> <pre>public <a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a> copyFor(java.lang.Object source, <a href="../../../javafx/event/EventTarget.html" title="interface in javafx.event">EventTarget</a> target, <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> type)</pre> <div class="block">Creates a copy of the given event with the given fields substituted.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>source</code> - the new source of the copied event</dd> <dd><code>target</code> - the new target of the copied event</dd> <dd><code>type</code> - the new event type.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the event copy with the fields substituted</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8.0</dd> </dl> </li> </ul> <a name="getEventType--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getEventType</h4> <pre>public <a href="../../../javafx/event/EventType.html" title="class in javafx.event">EventType</a><<a href="../../../javafx/scene/input/KeyEvent.html" title="class in javafx.scene.input">KeyEvent</a>> getEventType()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../javafx/event/Event.html#getEventType--">Event</a></code></span></div> <div class="block">Gets the event type of this event. Objects of the same <code>Event</code> class can have different event types. These event types further specify what kind of event occurred.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../javafx/scene/input/InputEvent.html#getEventType--">getEventType</a></code> in class <code><a href="../../../javafx/scene/input/InputEvent.html" title="class in javafx.scene.input">InputEvent</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the event type</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/KeyEvent.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../javafx/scene/input/KeyCombination.ModifierValue.html" title="enum in javafx.scene.input"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/input/Mnemonic.html" title="class in javafx.scene.input"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/input/KeyEvent.html" target="_top">Frames</a></li> <li><a href="KeyEvent.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><font size="-1"><a href="http://bugreport.java.com/bugreport/" target="_blank">Submit a bug or feature</a><br>For further API reference and developer documentation, see <a href="https://docs.oracle.com/javase/8/docs/index.html" target="_blank">Java SE Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> <a href="https://docs.oracle.com/javase/8/docs/legal/cpyr.html" target="_blank">Copyright</a> © 2008, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to <a href="http://download.oracle.com/otndocs/jcp/java_se-8-mrel-spec/license.html" target="_blank">license terms</a>. Also see the <a target="_blank" href="http://www.oracle.com/technetwork/java/redist-137594.html" target="_blank">documentation redistribution policy</a>.</font></small></p> </body> </html>