<!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_77) on Fri Apr 22 13:46:44 UTC 2016 --> <title>ToggleGroup (JavaFX 8)</title> <meta name="date" content="2016-04-22"> <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="ToggleGroup (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":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":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/ToggleGroup.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/ToggleButton.html" title="class in javafx.scene.control"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/control/ToolBar.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/ToggleGroup.html" target="_top">Frames</a></li> <li><a href="ToggleGroup.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 ToggleGroup" class="title">Class ToggleGroup</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> <li> <ul class="inheritance"> <li>javafx.scene.control.ToggleGroup</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">ToggleGroup</span> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> <div class="block">A class which contains a reference to all <code>Toggles</code> whose <code>selected</code> variables should be managed such that only a single <code><a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control"><code>Toggle</code></a></code> within the <code>ToggleGroup</code> may be selected at any one time. <p> Generally <code>ToggleGroups</code> are managed automatically simply by specifying the name of a <code>ToggleGroup</code> on the <code><a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control"><code>Toggle</code></a></code>, but in some situations it is desirable to explicitly manage which <code>ToggleGroup</code> is used by <code><a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control"><code>Toggles</code></a></code>. </p></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/ReadOnlyObjectProperty.html" title="class in javafx.beans.property">ReadOnlyObjectProperty</a><<a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#selectedToggleProperty">selectedToggle</a></span></code> <div class="block">The selected toggle.</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/ToggleGroup.html#ToggleGroup--">ToggleGroup</a></span>()</code> <div class="block">Creates a default ToggleGroup 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="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/collections/ObservableMap.html" title="interface in javafx.collections">ObservableMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#getProperties--">getProperties</a></span>()</code> <div class="block">Returns an observable map of properties on this node for use primarily by application developers.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#getSelectedToggle--">getSelectedToggle</a></span>()</code> <div class="block">Gets the selected <code>Toggle</code>.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/collections/ObservableList.html" title="interface in javafx.collections">ObservableList</a><<a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#getToggles--">getToggles</a></span>()</code> <div class="block">The list of toggles within the ToggleGroup.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#getUserData--">getUserData</a></span>()</code> <div class="block">Returns a previously set Object property, or null if no such property has been set using the <a href="../../../javafx/scene/control/ToggleGroup.html#setUserData-java.lang.Object-"><code>setUserData(java.lang.Object)</code></a> method.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#hasProperties--">hasProperties</a></span>()</code> <div class="block">Tests if ToggleGroup has properties.</div> </td> </tr> <tr id="i5" 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/Toggle.html" title="interface in javafx.scene.control">Toggle</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#selectedToggleProperty--">selectedToggleProperty</a></span>()</code> <div class="block">The selected toggle.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#selectToggle-javafx.scene.control.Toggle-">selectToggle</a></span>(<a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a> value)</code> <div class="block">Selects the toggle.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/control/ToggleGroup.html#setUserData-java.lang.Object-">setUserData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> <div class="block">Convenience method for setting a single Object property that can be retrieved at a later date.</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="selectedToggleProperty"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>selectedToggle</h4> <pre>public final <a href="../../../javafx/beans/property/ReadOnlyObjectProperty.html" title="class in javafx.beans.property">ReadOnlyObjectProperty</a><<a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a>> selectedToggleProperty</pre> <div class="block">The selected toggle.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/control/ToggleGroup.html#getSelectedToggle--"><code>getSelectedToggle()</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="ToggleGroup--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ToggleGroup</h4> <pre>public ToggleGroup()</pre> <div class="block">Creates a default ToggleGroup 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="getToggles--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getToggles</h4> <pre>public final <a href="../../../javafx/collections/ObservableList.html" title="interface in javafx.collections">ObservableList</a><<a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a>> getToggles()</pre> <div class="block">The list of toggles within the ToggleGroup.</div> </li> </ul> <a name="selectToggle-javafx.scene.control.Toggle-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>selectToggle</h4> <pre>public final void selectToggle(<a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a> value)</pre> <div class="block">Selects the toggle.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>value</code> - The <code>Toggle</code> that is to be selected.</dd> </dl> </li> </ul> <a name="getSelectedToggle--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSelectedToggle</h4> <pre>public final <a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a> getSelectedToggle()</pre> <div class="block">Gets the selected <code>Toggle</code>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Toggle The selected toggle.</dd> </dl> </li> </ul> <a name="selectedToggleProperty--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>selectedToggleProperty</h4> <pre>public final <a href="../../../javafx/beans/property/ReadOnlyObjectProperty.html" title="class in javafx.beans.property">ReadOnlyObjectProperty</a><<a href="../../../javafx/scene/control/Toggle.html" title="interface in javafx.scene.control">Toggle</a>> selectedToggleProperty()</pre> <div class="block">The selected toggle.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/control/ToggleGroup.html#getSelectedToggle--"><code>getSelectedToggle()</code></a></dd> </dl> </li> </ul> <a name="getProperties--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getProperties</h4> <pre>public final <a href="../../../javafx/collections/ObservableMap.html" title="interface in javafx.collections">ObservableMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getProperties()</pre> <div class="block">Returns an observable map of properties on this node for use primarily by application developers.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>an observable map of properties on this node for use primarily by application developers</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8u40</dd> </dl> </li> </ul> <a name="hasProperties--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasProperties</h4> <pre>public boolean hasProperties()</pre> <div class="block">Tests if ToggleGroup has properties.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if node has properties.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8u40</dd> </dl> </li> </ul> <a name="setUserData-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setUserData</h4> <pre>public void setUserData(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> <div class="block">Convenience method for setting a single Object property that can be retrieved at a later date. This is functionally equivalent to calling the getProperties().put(Object key, Object value) method. This can later be retrieved by calling <a href="../../../javafx/scene/control/ToggleGroup.html#getUserData--"><code>getUserData()</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>value</code> - The value to be stored - this can later be retrieved by calling <a href="../../../javafx/scene/control/ToggleGroup.html#getUserData--"><code>getUserData()</code></a>.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8u40</dd> </dl> </li> </ul> <a name="getUserData--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getUserData</h4> <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getUserData()</pre> <div class="block">Returns a previously set Object property, or null if no such property has been set using the <a href="../../../javafx/scene/control/ToggleGroup.html#setUserData-java.lang.Object-"><code>setUserData(java.lang.Object)</code></a> method.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The Object that was previously set, or null if no property has been set or if null was set.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8u40</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/ToggleGroup.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/ToggleButton.html" title="class in javafx.scene.control"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/control/ToolBar.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/ToggleGroup.html" target="_top">Frames</a></li> <li><a href="ToggleGroup.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><small><a href="https://docs.oracle.com/javase/8/docs/legal/cpyr.html">Copyright</a> (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved.</small></small></p> </body> </html>