controlp5/reference/controlP5/ControlFont.html

591 lines
19 KiB
HTML

<!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 (version 1.7.0_51) on Sun Apr 27 21:39:46 SGT 2014 -->
<title>ControlFont (Javadocs: controlP5)</title>
<meta name="date" content="2014-04-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ControlFont (Javadocs: controlP5)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../controlP5/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../controlP5/ControlEvent.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
<li><a href="../controlP5/ControlGroup.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?controlP5/ControlFont.html" target="_top">Frames</a></li>
<li><a href="ControlFont.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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">controlP5</div>
<h2 title="Class ControlFont" class="title">Class ControlFont</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>controlP5.ControlFont</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ControlFont</span>
extends java.lang.Object</pre>
<div class="block">A ControlFont is a container for a PFont that can be used to customize the font of a label.
(Designing the Font handling gave me a big headache, especially when it comes to calculating the
dimensions of a font which are not available at all times but only at certain times. The current
status I suppose is a good compromise and works for standard font handling cases. For any special
cases it will be difficult to convince me to make any changes.)</div>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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 boolean</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#DEBUG">DEBUG</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#RENDER_2X">RENDER_2X</a></strong></code>
<div class="block">set the RENDER_2X variable to true to double render text, this makes the font look bolder
especially in OpenGL mode.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../controlP5/ControlFont.html#ControlFont(processing.core.PFont)">ControlFont</a></strong>(processing.core.PFont&nbsp;theFont)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../controlP5/ControlFont.html#ControlFont(processing.core.PFont, int)">ControlFont</a></strong>(processing.core.PFont&nbsp;theFont,
int&nbsp;theFontSize)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../controlP5/ControlFont.html#ControlFont(processing.core.PFont, int, int)">ControlFont</a></strong>(processing.core.PFont&nbsp;theFont,
int&nbsp;theFontSize,
int&nbsp;theLineHeight)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#adjust(processing.core.PGraphics, controlP5.Label)">adjust</a></strong>(processing.core.PGraphics&nbsp;theGraphics,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#draw(controlP5.ControlP5, controlP5.Label)">draw</a></strong>(<a href="../controlP5/ControlP5.html" title="class in controlP5">ControlP5</a>&nbsp;c,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#draw(processing.core.PGraphics, controlP5.Label)">draw</a></strong>(processing.core.PGraphics&nbsp;theGraphics,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getBaseline()">getBaseline</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getBottom()">getBottom</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getCenter()">getCenter</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>processing.core.PFont</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getFont()">getFont</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getHeight()">getHeight</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getOffset(int)">getOffset</a></strong>(int&nbsp;theIndex)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getOverflow()">getOverflow</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getSize()">getSize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getTextHeight()">getTextHeight</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getTop()">getTop</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getWidth()">getWidth</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#getWidthFor(java.lang.String, controlP5.Label, processing.core.PGraphics)">getWidthFor</a></strong>(java.lang.String&nbsp;theText,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel,
processing.core.PGraphics&nbsp;theGraphics)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#init(controlP5.Label)">init</a></strong>(<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#normal()">normal</a></strong>()</code>
<div class="block">sets the rendering of a PFont back to normal and single rendering.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#setSize(int)">setSize</a></strong>(int&nbsp;theSize)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlFont.html#sharp()">sharp</a></strong>()</code>
<div class="block">renders a PFont twice for better and sharper readability</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&nbsp;java.lang.Object</h3>
<code>equals, 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEBUG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEBUG</h4>
<pre>public static&nbsp;boolean DEBUG</pre>
</li>
</ul>
<a name="RENDER_2X">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RENDER_2X</h4>
<pre>public static&nbsp;boolean RENDER_2X</pre>
<div class="block">set the RENDER_2X variable to true to double render text, this makes the font look bolder
especially in OpenGL mode. use: ControlFont.RENDER_2X = true;</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ControlFont(processing.core.PFont)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ControlFont</h4>
<pre>public&nbsp;ControlFont(processing.core.PFont&nbsp;theFont)</pre>
</li>
</ul>
<a name="ControlFont(processing.core.PFont, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ControlFont</h4>
<pre>public&nbsp;ControlFont(processing.core.PFont&nbsp;theFont,
int&nbsp;theFontSize)</pre>
</li>
</ul>
<a name="ControlFont(processing.core.PFont, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ControlFont</h4>
<pre>public&nbsp;ControlFont(processing.core.PFont&nbsp;theFont,
int&nbsp;theFontSize,
int&nbsp;theLineHeight)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="adjust(processing.core.PGraphics, controlP5.Label)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>adjust</h4>
<pre>public&nbsp;void&nbsp;adjust(processing.core.PGraphics&nbsp;theGraphics,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</pre>
</li>
</ul>
<a name="draw(controlP5.ControlP5, controlP5.Label)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>draw</h4>
<pre>public&nbsp;void&nbsp;draw(<a href="../controlP5/ControlP5.html" title="class in controlP5">ControlP5</a>&nbsp;c,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</pre>
</li>
</ul>
<a name="draw(processing.core.PGraphics, controlP5.Label)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>draw</h4>
<pre>public&nbsp;void&nbsp;draw(processing.core.PGraphics&nbsp;theGraphics,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</pre>
</li>
</ul>
<a name="getBaseline()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseline</h4>
<pre>public&nbsp;int&nbsp;getBaseline()</pre>
</li>
</ul>
<a name="getBottom()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBottom</h4>
<pre>public&nbsp;int&nbsp;getBottom()</pre>
</li>
</ul>
<a name="getCenter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCenter</h4>
<pre>public&nbsp;int&nbsp;getCenter()</pre>
</li>
</ul>
<a name="getFont()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFont</h4>
<pre>public&nbsp;processing.core.PFont&nbsp;getFont()</pre>
</li>
</ul>
<a name="getHeight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeight</h4>
<pre>public&nbsp;int&nbsp;getHeight()</pre>
</li>
</ul>
<a name="getOffset(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffset</h4>
<pre>public&nbsp;int&nbsp;getOffset(int&nbsp;theIndex)</pre>
</li>
</ul>
<a name="getOverflow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOverflow</h4>
<pre>public&nbsp;int&nbsp;getOverflow()</pre>
</li>
</ul>
<a name="getSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;int&nbsp;getSize()</pre>
</li>
</ul>
<a name="getTextHeight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextHeight</h4>
<pre>public&nbsp;int&nbsp;getTextHeight()</pre>
</li>
</ul>
<a name="getTop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTop</h4>
<pre>public&nbsp;int&nbsp;getTop()</pre>
</li>
</ul>
<a name="getWidth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre>public&nbsp;int&nbsp;getWidth()</pre>
</li>
</ul>
<a name="getWidthFor(java.lang.String, controlP5.Label, processing.core.PGraphics)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidthFor</h4>
<pre>public static&nbsp;int&nbsp;getWidthFor(java.lang.String&nbsp;theText,
<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel,
processing.core.PGraphics&nbsp;theGraphics)</pre>
</li>
</ul>
<a name="init(controlP5.Label)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../controlP5/Label.html" title="class in controlP5">Label</a>&nbsp;theLabel)</pre>
</li>
</ul>
<a name="normal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normal</h4>
<pre>public static&nbsp;void&nbsp;normal()</pre>
<div class="block">sets the rendering of a PFont back to normal and single rendering.</div>
</li>
</ul>
<a name="setSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSize</h4>
<pre>public&nbsp;void&nbsp;setSize(int&nbsp;theSize)</pre>
</li>
</ul>
<a name="sharp()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sharp</h4>
<pre>public static&nbsp;void&nbsp;sharp()</pre>
<div class="block">renders a PFont twice for better and sharper readability</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../controlP5/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../controlP5/ControlEvent.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
<li><a href="../controlP5/ControlGroup.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?controlP5/ControlFont.html" target="_top">Frames</a></li>
<li><a href="ControlFont.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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>processing library controlP5 by Andreas Schlegel. (c) 2006-2014</small></p>
</body>
</html>