1112 lines
56 KiB
HTML
1112 lines
56 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 Wed Apr 06 13:11:04 EDT 2016 -->
|
|
<title>Label (Parallel Java 2 Library Documentation)</title>
|
|
<meta name="date" content="2016-04-06">
|
|
<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="Label (Parallel Java 2 Library Documentation)";
|
|
}
|
|
//-->
|
|
</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="../../../../../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/Label.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/Grid.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?edu/rit/numeric/plot/impl/Label.html" target="_top">Frames</a></li>
|
|
<li><a href="Label.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">edu.rit.numeric.plot.impl</div>
|
|
<h2 title="Class Label" class="title">Class Label</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/7/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>edu.rit.numeric.plot.impl.Label</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="../../../../../edu/rit/swing/Drawable.html" title="interface in edu.rit.swing">Drawable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Externalizable.html?is-external=true" title="class or interface in java.io">Externalizable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">Label</span>
|
|
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
|
|
implements <a href="../../../../../edu/rit/swing/Drawable.html" title="interface in edu.rit.swing">Drawable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Externalizable.html?is-external=true" title="class or interface in java.io">Externalizable</a></pre>
|
|
<div class="block">Class Label provides an object for drawing arbitrary text on a plot. A label
|
|
has a <I>location,</I> a certain pair of coordinates (<I>x,y</I>) on the
|
|
plot. A label can be drawn at any one of nine positions relative to its
|
|
location: above left, above, above right, left, center, right, below left,
|
|
below, or below right. A label can be offset a certain distance from its
|
|
location. A label can be not rotated, rotated 90 degrees left, rotated 90
|
|
degrees right, or rotated 180 degrees. A label's location can be specified
|
|
either in plot coordinates or in pixel coordinates.
|
|
<P>
|
|
Class Label supports a subset of HTML for specifying attributes of
|
|
characters. The following HTML tags may be embedded in a label's text:
|
|
<UL>
|
|
<LI><TT><B>Bold</B></TT>
|
|
<LI><TT><I>Italic</I></TT>
|
|
<LI><TT><SUP>Superscript</SUP></TT>
|
|
<LI><TT><SUB>Subscript</SUB></TT>
|
|
</UL>
|
|
<P>
|
|
To get literal less-than, greater-than, and ampersand characters in the text,
|
|
use the following HTML character entities:
|
|
<UL>
|
|
<LI><TT>&lt;</TT> -- Less-than (<)
|
|
<LI><TT>&gt;</TT> -- Greater-than (>)
|
|
<LI><TT>&amp;</TT> -- Ampersand (&)
|
|
</UL></div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#edu.rit.numeric.plot.impl.Label">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="overviewSummary" 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 int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#ABOVE">ABOVE</a></strong></code>
|
|
<div class="block">The label is positioned above its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#ABOVE_LEFT">ABOVE_LEFT</a></strong></code>
|
|
<div class="block">The label is positioned above and to the left of its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#ABOVE_RIGHT">ABOVE_RIGHT</a></strong></code>
|
|
<div class="block">The label is positioned above and to the right of its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#BELOW">BELOW</a></strong></code>
|
|
<div class="block">The label is positioned below its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#BELOW_LEFT">BELOW_LEFT</a></strong></code>
|
|
<div class="block">The label is positioned below and to the left of its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#BELOW_RIGHT">BELOW_RIGHT</a></strong></code>
|
|
<div class="block">The label is positioned below and to the right of its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#CENTER">CENTER</a></strong></code>
|
|
<div class="block">The label is centered on its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#DEFAULT_FONT">DEFAULT_FONT</a></strong></code>
|
|
<div class="block">The default label font (sanserif, plain, 12 point).</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#DEFAULT_PAINT">DEFAULT_PAINT</a></strong></code>
|
|
<div class="block">The default label color (black).</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#LEFT">LEFT</a></strong></code>
|
|
<div class="block">The label is positioned to the left of its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myBackground">myBackground</a></strong></code>
|
|
<div class="block">The color for drawing this label's background on the display.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myColor">myColor</a></strong></code>
|
|
<div class="block">The color for drawing this label on the display.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myFont">myFont</a></strong></code>
|
|
<div class="block">This label's font.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myLocationX">myLocationX</a></strong></code>
|
|
<div class="block">X coordinate of this label's location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myLocationY">myLocationY</a></strong></code>
|
|
<div class="block">Y coordinate of this label's location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myOffset">myOffset</a></strong></code>
|
|
<div class="block">This label's offset from its location on the display.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myPositioning">myPositioning</a></strong></code>
|
|
<div class="block">This label's positioning, ABOVE_LEFT through BELOW_RIGHT.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#myText">myText</a></strong></code>
|
|
<div class="block">This label's text.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#PIXEL_COORDINATES">PIXEL_COORDINATES</a></strong></code>
|
|
<div class="block">The label's location is specified in pixel coordinates relative to the
|
|
lower left corner of the plot area, rather than in plot coordinates.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#RIGHT">RIGHT</a></strong></code>
|
|
<div class="block">The label is positioned to the right of its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#ROTATE_AROUND">ROTATE_AROUND</a></strong></code>
|
|
<div class="block">The label is rotated 180 degrees around.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#ROTATE_LEFT">ROTATE_LEFT</a></strong></code>
|
|
<div class="block">The label is rotated 90 degrees left (counterclockwise).</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#ROTATE_RIGHT">ROTATE_RIGHT</a></strong></code>
|
|
<div class="block">The label is rotated 90 degrees right (clockwise).</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"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#Label()">Label</a></strong>()</code>
|
|
<div class="block">Construct a new label.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#Label(java.lang.String, double, double)">Label</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y)</code>
|
|
<div class="block">Construct a new label with the given text and location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#Label(java.lang.String, double, double, int)">Label</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position)</code>
|
|
<div class="block">Construct a new label with the given text, location, and positioning.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#Label(java.lang.String, double, double, int, double)">Label</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset)</code>
|
|
<div class="block">Construct a new label with the given text, location, positioning, and
|
|
offset from its location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#Label(java.lang.String, double, double, int, double, java.awt.Font)">Label</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> font)</code>
|
|
<div class="block">Construct a new label with the given text, location, positioning, offset
|
|
from its location, and font.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#Label(java.lang.String, double, double, int, double, java.awt.Font, java.awt.Color)">Label</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> font,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> color)</code>
|
|
<div class="block">Construct a new label with the given text, location, positioning, offset
|
|
from its location, font, and color.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#Label(java.lang.String, double, double, int, double, java.awt.Font, java.awt.Color, java.awt.Color)">Label</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> font,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> color,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> bg)</code>
|
|
<div class="block">Construct a new label with the given text, location, positioning, offset
|
|
from its location, font, color, and background.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </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="../../../../../edu/rit/numeric/plot/impl/Label.html#draw(java.awt.Graphics2D)">draw</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Graphics2D.html?is-external=true" title="class or interface in java.awt">Graphics2D</a> g2d)</code>
|
|
<div class="block">Draw this drawable object in the given graphics context.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getBackground()">getBackground</a></strong>()</code>
|
|
<div class="block">Returns the color for drawing this label's background on the display.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getColor()">getColor</a></strong>()</code>
|
|
<div class="block">Returns the color for drawing this label on the display.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getFont()">getFont</a></strong>()</code>
|
|
<div class="block">Returns this label's font.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getLocationX()">getLocationX</a></strong>()</code>
|
|
<div class="block">Returns the X coordinate of this label's location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getLocationY()">getLocationY</a></strong>()</code>
|
|
<div class="block">Returns the Y coordinate of this label's location.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getOffset()">getOffset</a></strong>()</code>
|
|
<div class="block">Returns this label's offset from its location on the display (in display
|
|
units).</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getPositioning()">getPositioning</a></strong>()</code>
|
|
<div class="block">Returns this label's positioning.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#getText()">getText</a></strong>()</code>
|
|
<div class="block">Returns this label's text.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#readExternal(java.io.ObjectInput)">readExternal</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/ObjectInput.html?is-external=true" title="class or interface in java.io">ObjectInput</a> in)</code>
|
|
<div class="block">Read this label from the given object input stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/Label.html#writeExternal(java.io.ObjectOutput)">writeExternal</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/ObjectOutput.html?is-external=true" title="class or interface in java.io">ObjectOutput</a> out)</code>
|
|
<div class="block">Write this label to the given object output stream.</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a name="ABOVE_LEFT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ABOVE_LEFT</h4>
|
|
<pre>public static final int ABOVE_LEFT</pre>
|
|
<div class="block">The label is positioned above and to the left of its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.ABOVE_LEFT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ABOVE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ABOVE</h4>
|
|
<pre>public static final int ABOVE</pre>
|
|
<div class="block">The label is positioned above its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.ABOVE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ABOVE_RIGHT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ABOVE_RIGHT</h4>
|
|
<pre>public static final int ABOVE_RIGHT</pre>
|
|
<div class="block">The label is positioned above and to the right of its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.ABOVE_RIGHT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="LEFT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LEFT</h4>
|
|
<pre>public static final int LEFT</pre>
|
|
<div class="block">The label is positioned to the left of its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.LEFT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="CENTER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CENTER</h4>
|
|
<pre>public static final int CENTER</pre>
|
|
<div class="block">The label is centered on its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.CENTER">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="RIGHT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>RIGHT</h4>
|
|
<pre>public static final int RIGHT</pre>
|
|
<div class="block">The label is positioned to the right of its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.RIGHT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="BELOW_LEFT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>BELOW_LEFT</h4>
|
|
<pre>public static final int BELOW_LEFT</pre>
|
|
<div class="block">The label is positioned below and to the left of its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.BELOW_LEFT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="BELOW">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>BELOW</h4>
|
|
<pre>public static final int BELOW</pre>
|
|
<div class="block">The label is positioned below its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.BELOW">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="BELOW_RIGHT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>BELOW_RIGHT</h4>
|
|
<pre>public static final int BELOW_RIGHT</pre>
|
|
<div class="block">The label is positioned below and to the right of its location.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.BELOW_RIGHT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ROTATE_LEFT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ROTATE_LEFT</h4>
|
|
<pre>public static final int ROTATE_LEFT</pre>
|
|
<div class="block">The label is rotated 90 degrees left (counterclockwise).</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.ROTATE_LEFT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ROTATE_RIGHT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ROTATE_RIGHT</h4>
|
|
<pre>public static final int ROTATE_RIGHT</pre>
|
|
<div class="block">The label is rotated 90 degrees right (clockwise).</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.ROTATE_RIGHT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="ROTATE_AROUND">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ROTATE_AROUND</h4>
|
|
<pre>public static final int ROTATE_AROUND</pre>
|
|
<div class="block">The label is rotated 180 degrees around.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.ROTATE_AROUND">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="PIXEL_COORDINATES">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>PIXEL_COORDINATES</h4>
|
|
<pre>public static final int PIXEL_COORDINATES</pre>
|
|
<div class="block">The label's location is specified in pixel coordinates relative to the
|
|
lower left corner of the plot area, rather than in plot coordinates.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#edu.rit.numeric.plot.impl.Label.PIXEL_COORDINATES">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="DEFAULT_FONT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>DEFAULT_FONT</h4>
|
|
<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> DEFAULT_FONT</pre>
|
|
<div class="block">The default label font (sanserif, plain, 12 point).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="DEFAULT_PAINT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>DEFAULT_PAINT</h4>
|
|
<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> DEFAULT_PAINT</pre>
|
|
<div class="block">The default label color (black).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myText">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>myText</h4>
|
|
<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> myText</pre>
|
|
<div class="block">This label's text.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myLocationX">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>myLocationX</h4>
|
|
<pre>protected double myLocationX</pre>
|
|
<div class="block">X coordinate of this label's location.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myLocationY">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>myLocationY</h4>
|
|
<pre>protected double myLocationY</pre>
|
|
<div class="block">Y coordinate of this label's location.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myPositioning">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>myPositioning</h4>
|
|
<pre>protected int myPositioning</pre>
|
|
<div class="block">This label's positioning, ABOVE_LEFT through BELOW_RIGHT.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myOffset">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>myOffset</h4>
|
|
<pre>protected double myOffset</pre>
|
|
<div class="block">This label's offset from its location on the display.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myFont">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>myFont</h4>
|
|
<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> myFont</pre>
|
|
<div class="block">This label's font.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myColor">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>myColor</h4>
|
|
<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> myColor</pre>
|
|
<div class="block">The color for drawing this label on the display.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="myBackground">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>myBackground</h4>
|
|
<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> myBackground</pre>
|
|
<div class="block">The color for drawing this label's background on the display.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="Label()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Label</h4>
|
|
<pre>public Label()</pre>
|
|
<div class="block">Construct a new label. This constructor is intended for use only by
|
|
object deserialization.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="Label(java.lang.String, double, double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Label</h4>
|
|
<pre>public Label(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y)</pre>
|
|
<div class="block">Construct a new label with the given text and location. The label is
|
|
centered on its location and is not rotated. The default font and color
|
|
are used. The label has no background.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - Label text.</dd><dd><code>x</code> - X coordinate of this label's location.</dd><dd><code>y</code> - Y coordinate of this label's location.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>text</TT> is null.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Label(java.lang.String, double, double, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Label</h4>
|
|
<pre>public Label(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position)</pre>
|
|
<div class="block">Construct a new label with the given text, location, and positioning. The
|
|
default font and color are used. The label has no background.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - Label text.</dd><dd><code>x</code> - X coordinate of this label's location.</dd><dd><code>y</code> - Y coordinate of this label's location.</dd><dd><code>position</code> - This label's positioning, <TT>ABOVE_LEFT</TT> through
|
|
<TT>BELOW_RIGHT</TT>. Optionally, <TT>ROTATE_LEFT</TT>
|
|
through <TT>ROTATE_AROUND</TT> may be added; e.g.,
|
|
<TT>LEFT+ROTATE_LEFT</TT>. Optionally,
|
|
<TT>PIXEL_COORDINATES</TT> may be added.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>text</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>position</TT> is invalid.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Label(java.lang.String, double, double, int, double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Label</h4>
|
|
<pre>public Label(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset)</pre>
|
|
<div class="block">Construct a new label with the given text, location, positioning, and
|
|
offset from its location. The default font and color are used. The label
|
|
has no background. If the label's positioning is <TT>CENTER</TT>, the
|
|
offset is not used.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - Label text.</dd><dd><code>x</code> - X coordinate of this label's location.</dd><dd><code>y</code> - Y coordinate of this label's location.</dd><dd><code>position</code> - This label's positioning, <TT>ABOVE_LEFT</TT> through
|
|
<TT>BELOW_RIGHT</TT>. Optionally, <TT>ROTATE_LEFT</TT>
|
|
through <TT>ROTATE_AROUND</TT> may be added; e.g.,
|
|
<TT>LEFT+ROTATE_LEFT</TT>. Optionally,
|
|
<TT>PIXEL_COORDINATES</TT> may be added.</dd><dd><code>offset</code> - Offset from this label's location on the display (in
|
|
display units).</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>text</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>position</TT> is invalid. Thrown
|
|
if <TT>offset</TT> is less than 0.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Label(java.lang.String, double, double, int, double, java.awt.Font)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Label</h4>
|
|
<pre>public Label(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> font)</pre>
|
|
<div class="block">Construct a new label with the given text, location, positioning, offset
|
|
from its location, and font. The default color is used. The label has no
|
|
background. If the label's positioning is <TT>CENTER</TT>, the offset is
|
|
not used.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - Label text.</dd><dd><code>x</code> - X coordinate of this label's location.</dd><dd><code>y</code> - Y coordinate of this label's location.</dd><dd><code>position</code> - This label's positioning, <TT>ABOVE_LEFT</TT> through
|
|
<TT>BELOW_RIGHT</TT>. Optionally, <TT>ROTATE_LEFT</TT>
|
|
through <TT>ROTATE_AROUND</TT> may be added; e.g.,
|
|
<TT>LEFT+ROTATE_LEFT</TT>. Optionally,
|
|
<TT>PIXEL_COORDINATES</TT> may be added.</dd><dd><code>offset</code> - Offset from this label's location on the display (in
|
|
display units).</dd><dd><code>font</code> - Font for drawing this label.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>text</TT> is null or
|
|
<TT>font</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>position</TT> is invalid. Thrown
|
|
if <TT>offset</TT> is less than 0.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Label(java.lang.String, double, double, int, double, java.awt.Font, java.awt.Color)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Label</h4>
|
|
<pre>public Label(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> font,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> color)</pre>
|
|
<div class="block">Construct a new label with the given text, location, positioning, offset
|
|
from its location, font, and color. The label has no background. If the
|
|
label's positioning is <TT>CENTER</TT>, the offset is not used.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - Label text.</dd><dd><code>x</code> - X coordinate of this label's location.</dd><dd><code>y</code> - Y coordinate of this label's location.</dd><dd><code>position</code> - This label's positioning, <TT>ABOVE_LEFT</TT> through
|
|
<TT>BELOW_RIGHT</TT>. Optionally, <TT>ROTATE_LEFT</TT>
|
|
through <TT>ROTATE_AROUND</TT> may be added; e.g.,
|
|
<TT>LEFT+ROTATE_LEFT</TT>. Optionally,
|
|
<TT>PIXEL_COORDINATES</TT> may be added.</dd><dd><code>offset</code> - Offset from this label's location on the display (in
|
|
display units).</dd><dd><code>font</code> - Font for drawing this label.</dd><dd><code>color</code> - Color for drawing this label.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>text</TT> is null, <TT>font</TT>
|
|
is null, or <TT>color</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>position</TT> is invalid. Thrown
|
|
if <TT>offset</TT> is less than 0.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Label(java.lang.String, double, double, int, double, java.awt.Font, java.awt.Color, java.awt.Color)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Label</h4>
|
|
<pre>public Label(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text,
|
|
double x,
|
|
double y,
|
|
int position,
|
|
double offset,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> font,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> color,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> bg)</pre>
|
|
<div class="block">Construct a new label with the given text, location, positioning, offset
|
|
from its location, font, color, and background. If <TT>bg</TT> is null,
|
|
the label has no background. If the label's positioning is
|
|
<TT>CENTER</TT>, the offset is not used.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - Label text.</dd><dd><code>x</code> - X coordinate of this label's location.</dd><dd><code>y</code> - Y coordinate of this label's location.</dd><dd><code>position</code> - This label's positioning, <TT>ABOVE_LEFT</TT> through
|
|
<TT>BELOW_RIGHT</TT>. Optionally, <TT>ROTATE_LEFT</TT>
|
|
through <TT>ROTATE_AROUND</TT> may be added; e.g.,
|
|
<TT>LEFT+ROTATE_LEFT</TT>. Optionally,
|
|
<TT>PIXEL_COORDINATES</TT> may be added.</dd><dd><code>offset</code> - Offset from this label's location on the display (in
|
|
display units).</dd><dd><code>font</code> - Font for drawing this label.</dd><dd><code>color</code> - Color for drawing this label.</dd><dd><code>bg</code> - Color for drawing this label's background.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>text</TT> is null, <TT>font</TT>
|
|
is null, or <TT>color</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>position</TT> is invalid. Thrown
|
|
if <TT>offset</TT> is less than 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="getText()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getText</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getText()</pre>
|
|
<div class="block">Returns this label's text.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getLocationX()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLocationX</h4>
|
|
<pre>public double getLocationX()</pre>
|
|
<div class="block">Returns the X coordinate of this label's location.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getLocationY()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLocationY</h4>
|
|
<pre>public double getLocationY()</pre>
|
|
<div class="block">Returns the Y coordinate of this label's location.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getPositioning()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPositioning</h4>
|
|
<pre>public int getPositioning()</pre>
|
|
<div class="block">Returns this label's positioning. The return value is <TT>ABOVE_LEFT</TT>
|
|
through <TT>BELOW_RIGHT</TT>. If the label is rotated, one of the values
|
|
<TT>ROTATE_LEFT</TT> through <TT>ROTATE_AROUND</TT> is added. If the
|
|
pixel's location is specified in pixel coordinates rather than plot
|
|
coordinates, <TT>PIXEL_COORDINATES</TT> is added.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getOffset()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOffset</h4>
|
|
<pre>public double getOffset()</pre>
|
|
<div class="block">Returns this label's offset from its location on the display (in display
|
|
units).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getFont()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFont</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Font.html?is-external=true" title="class or interface in java.awt">Font</a> getFont()</pre>
|
|
<div class="block">Returns this label's font.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getColor()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getColor</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> getColor()</pre>
|
|
<div class="block">Returns the color for drawing this label on the display.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getBackground()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBackground</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Color.html?is-external=true" title="class or interface in java.awt">Color</a> getBackground()</pre>
|
|
<div class="block">Returns the color for drawing this label's background on the display. If
|
|
this label has no background, null is returned.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="draw(java.awt.Graphics2D)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>draw</h4>
|
|
<pre>public void draw(<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Graphics2D.html?is-external=true" title="class or interface in java.awt">Graphics2D</a> g2d)</pre>
|
|
<div class="block">Draw this drawable object in the given graphics context. Upon return from
|
|
this method, the given graphics context's state (color, font, transform,
|
|
clip, and so on) is the same as it was upon entry to this method.
|
|
<P>
|
|
The label is drawn at position (0,0). It is the caller's responsibility
|
|
to transform the graphics context so the label ends up at the correct
|
|
(<I>x,y</I>) coordinates.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/swing/Drawable.html#draw(java.awt.Graphics2D)">draw</a></code> in interface <code><a href="../../../../../edu/rit/swing/Drawable.html" title="interface in edu.rit.swing">Drawable</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>g2d</code> - 2-D graphics context.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="writeExternal(java.io.ObjectOutput)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>writeExternal</h4>
|
|
<pre>public void writeExternal(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/ObjectOutput.html?is-external=true" title="class or interface in java.io">ObjectOutput</a> out)
|
|
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block">Write this label to the given object output stream.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Externalizable.html?is-external=true#writeExternal(java.io.ObjectOutput)" title="class or interface in java.io">writeExternal</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Externalizable.html?is-external=true" title="class or interface in java.io">Externalizable</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - Object output stream.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown if an I/O error occurred.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readExternal(java.io.ObjectInput)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>readExternal</h4>
|
|
<pre>public void readExternal(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/ObjectInput.html?is-external=true" title="class or interface in java.io">ObjectInput</a> in)
|
|
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
|
|
<div class="block">Read this label from the given object input stream.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Externalizable.html?is-external=true#readExternal(java.io.ObjectInput)" title="class or interface in java.io">readExternal</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Externalizable.html?is-external=true" title="class or interface in java.io">Externalizable</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - Object input stream.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown if an I/O error occurred.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code> - Thrown if a class needed to deserialize this label could not be
|
|
found.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Label.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/Grid.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?edu/rit/numeric/plot/impl/Label.html" target="_top">Frames</a></li>
|
|
<li><a href="Label.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="-2">Copyright © 2013–2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">@</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
|
|
</body>
|
|
</html>
|