<!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:01:19 UTC 2018 --> <title>FocusModel (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="FocusModel (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":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"; var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":6,"i8":6,"i9":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/FocusModel.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/control/DialogPane.html" title="class in javafx.scene.control"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/control/Hyperlink.html" title="class in javafx.scene.control"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/control/FocusModel.html" target="_top">Frames</a></li> <li><a href="FocusModel.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>Field | </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>Field | </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.control</div> <h2 title="Class FocusModel" class="title">Class FocusModel<T></h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>javafx.scene.control.FocusModel<T></li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../javafx/scene/control/TableFocusModel.html" title="class in javafx.scene.control">TableFocusModel</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="typeNameLabel">FocusModel<T></span> extends java.lang.Object</pre> <div class="block">The abstract base class for FocusModel implementations.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 2.0</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== PROPERTY SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="property.summary"> <!-- --> </a> <h3>Property Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Property Summary table, listing properties, 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">Type</th> <th class="colLast" scope="col">Property and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/ReadOnlyIntegerProperty.html" title="class in javafx.beans.property">ReadOnlyIntegerProperty</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#focusedIndexProperty">focusedIndex</a></span></code> <div class="block">The index of the current item in the FocusModel which has the focus.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/ReadOnlyObjectProperty.html" title="class in javafx.beans.property">ReadOnlyObjectProperty</a><<a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#focusedItemProperty">focusedItem</a></span></code> <div class="block">The current item in the FocusModel which has the focus.</div> </td> </tr> </table> </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/control/FocusModel.html#FocusModel--">FocusModel</a></span>()</code> <div class="block">Creates a default FocusModel instance.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#focus-int-">focus</a></span>(int index)</code> <div class="block">Causes the item at the given index to receive the focus.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/ReadOnlyIntegerProperty.html" title="class in javafx.beans.property">ReadOnlyIntegerProperty</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#focusedIndexProperty--">focusedIndexProperty</a></span>()</code> <div class="block">The index of the current item in the FocusModel which has the focus.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/ReadOnlyObjectProperty.html" title="class in javafx.beans.property">ReadOnlyObjectProperty</a><<a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#focusedItemProperty--">focusedItemProperty</a></span>()</code> <div class="block">The current item in the FocusModel which has the focus.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#focusNext--">focusNext</a></span>()</code> <div class="block">Attempts to give focus to the row after to the currently focused row.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#focusPrevious--">focusPrevious</a></span>()</code> <div class="block">Attempts to give focus to the row previous to the currently focused row.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#getFocusedIndex--">getFocusedIndex</a></span>()</code> <div class="block">Gets the value of the property focusedIndex.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#getFocusedItem--">getFocusedItem</a></span>()</code> <div class="block">Gets the value of the property focusedItem.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>protected abstract int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#getItemCount--">getItemCount</a></span>()</code> <div class="block">Returns the number of items in the data model that underpins the control.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>protected abstract <a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/FocusModel.html#getModelItem-int-">getModelItem</a></span>(int index)</code> <div class="block">Returns the item at the given index.</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/control/FocusModel.html#isFocused-int-">isFocused</a></span>(int index)</code> <div class="block">Convenience method to inform if the given index is currently focused in this SelectionModel.</div> </td> </tr> </table> <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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ PROPERTY DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="property.detail"> <!-- --> </a> <h3>Property Detail</h3> <a name="focusedIndexProperty"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>focusedIndex</h4> <pre>public final <a href="../../../javafx/beans/property/ReadOnlyIntegerProperty.html" title="class in javafx.beans.property">ReadOnlyIntegerProperty</a> focusedIndexProperty</pre> <div class="block">The index of the current item in the FocusModel which has the focus. It is possible that this will be -1, but only if the control is empty. If the control is not itself focused, this property will still reference the row index that would receive the keyboard focus if the control itself were focused.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/control/FocusModel.html#getFocusedIndex--"><code>getFocusedIndex()</code></a></dd> </dl> </li> </ul> <a name="focusedItemProperty"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>focusedItem</h4> <pre>public final <a href="../../../javafx/beans/property/ReadOnlyObjectProperty.html" title="class in javafx.beans.property">ReadOnlyObjectProperty</a><<a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a>> focusedItemProperty</pre> <div class="block">The current item in the FocusModel which has the focus. It is possible that this will be null, but only if the control is empty. If the control is not itself focused, this property will still reference the item that would receive the keyboard focus if the control itself were focused.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/control/FocusModel.html#getFocusedItem--"><code>getFocusedItem()</code></a></dd> </dl> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="FocusModel--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>FocusModel</h4> <pre>public FocusModel()</pre> <div class="block">Creates a default FocusModel instance.</div> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="focusedIndexProperty--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>focusedIndexProperty</h4> <pre>public final <a href="../../../javafx/beans/property/ReadOnlyIntegerProperty.html" title="class in javafx.beans.property">ReadOnlyIntegerProperty</a> focusedIndexProperty()</pre> <div class="block">The index of the current item in the FocusModel which has the focus. It is possible that this will be -1, but only if the control is empty. If the control is not itself focused, this property will still reference the row index that would receive the keyboard focus if the control itself were focused.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/control/FocusModel.html#getFocusedIndex--"><code>getFocusedIndex()</code></a></dd> </dl> </li> </ul> <a name="getFocusedIndex--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFocusedIndex</h4> <pre>public final int getFocusedIndex()</pre> <div class="block">Gets the value of the property focusedIndex.</div> <dl> <dt><span class="simpleTagLabel">Property description:</span></dt> <dd>The index of the current item in the FocusModel which has the focus. It is possible that this will be -1, but only if the control is empty. If the control is not itself focused, this property will still reference the row index that would receive the keyboard focus if the control itself were focused.</dd> </dl> </li> </ul> <a name="focusedItemProperty--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>focusedItemProperty</h4> <pre>public final <a href="../../../javafx/beans/property/ReadOnlyObjectProperty.html" title="class in javafx.beans.property">ReadOnlyObjectProperty</a><<a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a>> focusedItemProperty()</pre> <div class="block">The current item in the FocusModel which has the focus. It is possible that this will be null, but only if the control is empty. If the control is not itself focused, this property will still reference the item that would receive the keyboard focus if the control itself were focused.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/control/FocusModel.html#getFocusedItem--"><code>getFocusedItem()</code></a></dd> </dl> </li> </ul> <a name="getFocusedItem--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFocusedItem</h4> <pre>public final <a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a> getFocusedItem()</pre> <div class="block">Gets the value of the property focusedItem.</div> <dl> <dt><span class="simpleTagLabel">Property description:</span></dt> <dd>The current item in the FocusModel which has the focus. It is possible that this will be null, but only if the control is empty. If the control is not itself focused, this property will still reference the item that would receive the keyboard focus if the control itself were focused.</dd> </dl> </li> </ul> <a name="getItemCount--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getItemCount</h4> <pre>protected abstract int getItemCount()</pre> <div class="block">Returns the number of items in the data model that underpins the control. An example would be that a ListView focus model would likely return <code>listView.getItems().size()</code>. The valid range of focusable indices is between 0 and whatever is returned by this method.</div> </li> </ul> <a name="getModelItem-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getModelItem</h4> <pre>protected abstract <a href="../../../javafx/scene/control/FocusModel.html" title="type parameter in FocusModel">T</a> getModelItem(int index)</pre> <div class="block">Returns the item at the given index. An example using ListView would be <code>listView.getItems().get(index)</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>index</code> - The index of the item that is requested from the underlying data model.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>Returns null if the index is out of bounds, or an element of type T that is related to the given index.</dd> </dl> </li> </ul> <a name="isFocused-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isFocused</h4> <pre>public boolean isFocused(int index)</pre> <div class="block"><p>Convenience method to inform if the given index is currently focused in this SelectionModel. Is functionally equivalent to calling <pre><code>getFocusedIndex() == index</code></pre>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>index</code> - The index to check as to whether it is currently focused or not.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>True if the given index is focused, false otherwise.</dd> </dl> </li> </ul> <a name="focus-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>focus</h4> <pre>public void focus(int index)</pre> <div class="block">Causes the item at the given index to receive the focus. This does not cause the current selection to change. Updates the focusedItem and focusedIndex properties such that <code>focusedIndex = -1</code> unless <code>0 <= index < model size</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>index</code> - The index of the item to get focus.</dd> </dl> </li> </ul> <a name="focusPrevious--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>focusPrevious</h4> <pre>public void focusPrevious()</pre> <div class="block">Attempts to give focus to the row previous to the currently focused row. If the current focus owner is the first row, or is -1 (representing that there is no current focus owner), calling this method will have no result.</div> </li> </ul> <a name="focusNext--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>focusNext</h4> <pre>public void focusNext()</pre> <div class="block">Attempts to give focus to the row after to the currently focused row. If the current focus owner is the last row, calling this method will have no result.</div> </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/FocusModel.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/control/DialogPane.html" title="class in javafx.scene.control"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/control/Hyperlink.html" title="class in javafx.scene.control"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/control/FocusModel.html" target="_top">Frames</a></li> <li><a href="FocusModel.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>Field | </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>Field | </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>