<!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:26 UTC 2016 --> <title>BackgroundImage (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="BackgroundImage (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/BackgroundImage.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/layout/BackgroundFill.html" title="class in javafx.scene.layout"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/layout/BackgroundPosition.html" title="class in javafx.scene.layout"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/layout/BackgroundImage.html" target="_top">Frames</a></li> <li><a href="BackgroundImage.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.layout</div> <h2 title="Class BackgroundImage" class="title">Class BackgroundImage</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.layout.BackgroundImage</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public final class <span class="typeNameLabel">BackgroundImage</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">Defines properties describing how to render an image as the background to some <a href="../../../javafx/scene/layout/Region.html" title="class in javafx.scene.layout"><code>Region</code></a>. A BackgroundImage must have an Image specified (it cannot be null). The <a href="../../../javafx/scene/layout/BackgroundImage.html#getRepeatX--"><code>repeatX</code></a> and <a href="../../../javafx/scene/layout/BackgroundImage.html#getRepeatY--"><code>repeatY</code></a> properties define how the image is to be repeated in each direction. The <a href="../../../javafx/scene/layout/BackgroundImage.html#getPosition--"><code>position</code></a> property defines how to position the image on the Region while the <a href="../../../javafx/scene/layout/BackgroundImage.html#getSize--"><code>size</code></a> property defines the size of the image on the Region. For example, the <code>size</code> might be defined with <a href="../../../javafx/scene/layout/BackgroundSize.html#isCover--"><code>cover = true</code></a>, meaning the image should be stretched to cover the entire rendering surface of the Region. <p/> Because the BackgroundImage is immutable, it can safely be used in any cache, and can safely be reused among multiple Regions.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8.0</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== 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/layout/BackgroundImage.html#BackgroundImage-javafx.scene.image.Image-javafx.scene.layout.BackgroundRepeat-javafx.scene.layout.BackgroundRepeat-javafx.scene.layout.BackgroundPosition-javafx.scene.layout.BackgroundSize-">BackgroundImage</a></span>(<a href="../../../javafx/scene/image/Image.html" title="class in javafx.scene.image">Image</a> image, <a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a> repeatX, <a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a> repeatY, <a href="../../../javafx/scene/layout/BackgroundPosition.html" title="class in javafx.scene.layout">BackgroundPosition</a> position, <a href="../../../javafx/scene/layout/BackgroundSize.html" title="class in javafx.scene.layout">BackgroundSize</a> size)</code> <div class="block">Creates a new BackgroundImage.</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>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/layout/BackgroundImage.html#equals-java.lang.Object-">equals</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> o)</code> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/scene/image/Image.html" title="class in javafx.scene.image">Image</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/layout/BackgroundImage.html#getImage--">getImage</a></span>()</code> <div class="block">The image to be used.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/scene/layout/BackgroundPosition.html" title="class in javafx.scene.layout">BackgroundPosition</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/layout/BackgroundImage.html#getPosition--">getPosition</a></span>()</code> <div class="block">The position of this BackgroundImage relative to the Region.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/layout/BackgroundImage.html#getRepeatX--">getRepeatX</a></span>()</code> <div class="block">Indicates in what manner (if at all) the background image is to be repeated along the x-axis of the region.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/layout/BackgroundImage.html#getRepeatY--">getRepeatY</a></span>()</code> <div class="block">Indicates in what manner (if at all) the background image is to be repeated along the y-axis of the region.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/scene/layout/BackgroundSize.html" title="class in javafx.scene.layout">BackgroundSize</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/layout/BackgroundImage.html#getSize--">getSize</a></span>()</code> <div class="block">The size of this image relative to the Region.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/layout/BackgroundImage.html#hashCode--">hashCode</a></span>()</code> </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#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#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"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="BackgroundImage-javafx.scene.image.Image-javafx.scene.layout.BackgroundRepeat-javafx.scene.layout.BackgroundRepeat-javafx.scene.layout.BackgroundPosition-javafx.scene.layout.BackgroundSize-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>BackgroundImage</h4> <pre>public BackgroundImage(<a href="../../../javafx/scene/image/Image.html" title="class in javafx.scene.image">Image</a> image, <a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a> repeatX, <a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a> repeatY, <a href="../../../javafx/scene/layout/BackgroundPosition.html" title="class in javafx.scene.layout">BackgroundPosition</a> position, <a href="../../../javafx/scene/layout/BackgroundSize.html" title="class in javafx.scene.layout">BackgroundSize</a> size)</pre> <div class="block">Creates a new BackgroundImage. The <code>image</code> must be specified.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - The image to use. This cannot be null.</dd> <dd><code>repeatX</code> - The BackgroundRepeat for the x axis. If null, this value defaults to REPEAT.</dd> <dd><code>repeatY</code> - The BackgroundRepeat for the y axis. If null, this value defaults to REPEAT.</dd> <dd><code>position</code> - The BackgroundPosition to use. If null, defaults to BackgroundPosition.DEFAULT.</dd> <dd><code>size</code> - The BackgroundSize. If null, defaults to BackgroundSize.DEFAULT.</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="getImage--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getImage</h4> <pre>public final <a href="../../../javafx/scene/image/Image.html" title="class in javafx.scene.image">Image</a> getImage()</pre> <div class="block">The image to be used. This will never be null. If this image fails to load, then the entire BackgroundImage will be skipped at rendering time.</div> </li> </ul> <a name="getRepeatX--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRepeatX</h4> <pre>public final <a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a> getRepeatX()</pre> <div class="block">Indicates in what manner (if at all) the background image is to be repeated along the x-axis of the region. This will never be null.</div> </li> </ul> <a name="getRepeatY--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRepeatY</h4> <pre>public final <a href="../../../javafx/scene/layout/BackgroundRepeat.html" title="enum in javafx.scene.layout">BackgroundRepeat</a> getRepeatY()</pre> <div class="block">Indicates in what manner (if at all) the background image is to be repeated along the y-axis of the region. This will never be null.</div> </li> </ul> <a name="getPosition--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPosition</h4> <pre>public final <a href="../../../javafx/scene/layout/BackgroundPosition.html" title="class in javafx.scene.layout">BackgroundPosition</a> getPosition()</pre> <div class="block">The position of this BackgroundImage relative to the Region. Note that any position outside the background area of the region will be clipped.</div> </li> </ul> <a name="getSize--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSize</h4> <pre>public final <a href="../../../javafx/scene/layout/BackgroundSize.html" title="class in javafx.scene.layout">BackgroundSize</a> getSize()</pre> <div class="block">The size of this image relative to the Region.</div> </li> </ul> <a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(<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> o)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><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></code> in class <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></dd> </dl> </li> </ul> <a name="hashCode--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><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></code> in class <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></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/BackgroundImage.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/layout/BackgroundFill.html" title="class in javafx.scene.layout"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/layout/BackgroundPosition.html" title="class in javafx.scene.layout"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/layout/BackgroundImage.html" target="_top">Frames</a></li> <li><a href="BackgroundImage.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>