maxGraph/java/docs/com/mxgraph/util/mxPoint.html

514 lines
18 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2014-04-01 11:30:48 +00:00
<!-- NewPage -->
<html lang="en">
<head>
2014-11-10 09:02:21 +00:00
<!-- Generated by javadoc (version 1.7.0_51) on Mon Nov 10 04:00:04 EST 2014 -->
<title>mxPoint (mxGraph 3.1.1.1 API Specification)</title>
<meta name="date" content="2014-11-10">
2014-04-01 11:30:48 +00:00
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
2012-05-21 20:32:26 +00:00
if (location.href.indexOf('is-external=true') == -1) {
2014-11-10 09:02:21 +00:00
parent.document.title="mxPoint (mxGraph 3.1.1.1 API Specification)";
2012-05-21 20:32:26 +00:00
}
2014-04-01 11:30:48 +00:00
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2012-05-21 20:32:26 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2014-04-01 11:30:48 +00:00
<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/mxPoint.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>
2014-11-10 09:02:21 +00:00
<div class="aboutLanguage"><em><p><b>mxGraph 3.1.1.1</b></p></em></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/mxgraph/util/mxLine.html" title="class in com.mxgraph.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/mxgraph/util/mxRectangle.html" title="class in com.mxgraph.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/util/mxPoint.html" target="_top">Frames</a></li>
<li><a href="mxPoint.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");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</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>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
2014-04-01 11:30:48 +00:00
<div class="header">
<div class="subTitle">com.mxgraph.util</div>
<h2 title="Class mxPoint" class="title">Class mxPoint</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
2014-11-10 09:02:21 +00:00
<li>java.lang.Object</li>
2014-04-01 11:30:48 +00:00
<li>
<ul class="inheritance">
<li>com.mxgraph.util.mxPoint</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
2014-11-10 09:02:21 +00:00
<dd>java.io.Serializable, java.lang.Cloneable</dd>
2014-04-01 11:30:48 +00:00
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/mxgraph/util/mxLine.html" title="class in com.mxgraph.util">mxLine</a>, <a href="../../../com/mxgraph/util/mxRectangle.html" title="class in com.mxgraph.util">mxRectangle</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">mxPoint</span>
2014-11-10 09:02:21 +00:00
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Implements a 2-dimensional point with double precision coordinates.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#com.mxgraph.util.mxPoint">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- =========== FIELD SUMMARY =========== -->
2014-04-01 11:30:48 +00:00
<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>protected double</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#x">x</a></strong></code>
<div class="block">Holds the x- and y-coordinates of the point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected double</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#y">y</a></strong></code>
<div class="block">Holds the x- and y-coordinates of the point.</div>
</td>
</tr>
</table>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
2014-04-01 11:30:48 +00:00
<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="../../../com/mxgraph/util/mxPoint.html#mxPoint()">mxPoint</a></strong>()</code>
<div class="block">Constructs a new point at (0, 0).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#mxPoint(double, double)">mxPoint</a></strong>(double&nbsp;x,
double&nbsp;y)</code>
<div class="block">Constructs a new point at (x, y).</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#mxPoint(com.mxgraph.util.mxPoint)">mxPoint</a></strong>(<a href="../../../com/mxgraph/util/mxPoint.html" title="class in com.mxgraph.util">mxPoint</a>&nbsp;point)</code>
<div class="block">Constructs a new point at the location of the given point.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colOne"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#mxPoint(java.awt.geom.Point2D)">mxPoint</a></strong>(java.awt.geom.Point2D&nbsp;point)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Constructs a new point at the location of the given point.</div>
</td>
</tr>
</table>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ========== METHOD SUMMARY =========== -->
2014-04-01 11:30:48 +00:00
<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">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
2014-04-01 11:30:48 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#clone()">clone</a></strong>()</code>
<div class="block">Returns a new instance of the same point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given object equals this rectangle.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.awt.Point</code></td>
2014-04-01 11:30:48 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#getPoint()">getPoint</a></strong>()</code>
<div class="block">Returns the coordinates as a new point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#getX()">getX</a></strong>()</code>
<div class="block">Returns the x-coordinate of the point.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#getY()">getY</a></strong>()</code>
<div class="block">Returns the x-coordinate of the point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#setX(double)">setX</a></strong>(double&nbsp;value)</code>
<div class="block">Sets the x-coordinate of the point.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#setY(double)">setY</a></strong>(double&nbsp;value)</code>
<div class="block">Sets the y-coordinate of the point.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.String</code></td>
2014-04-01 11:30:48 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxPoint.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a <code>String</code> that represents the value
of this <code>mxPoint</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
2014-11-10 09:02:21 +00:00
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
2014-04-01 11:30:48 +00:00
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- ============ FIELD DETAIL =========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="x">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>x</h4>
<pre>protected&nbsp;double x</pre>
<div class="block">Holds the x- and y-coordinates of the point. Default is 0.</div>
</li>
</ul>
<a name="y">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>y</h4>
<pre>protected&nbsp;double y</pre>
<div class="block">Holds the x- and y-coordinates of the point. Default is 0.</div>
</li>
</ul>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="mxPoint()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mxPoint</h4>
<pre>public&nbsp;mxPoint()</pre>
<div class="block">Constructs a new point at (0, 0).</div>
</li>
</ul>
<a name="mxPoint(java.awt.geom.Point2D)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mxPoint</h4>
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;mxPoint(java.awt.geom.Point2D&nbsp;point)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Constructs a new point at the location of the given point.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - Point that specifies the location.</dd></dl>
</li>
</ul>
<a name="mxPoint(com.mxgraph.util.mxPoint)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mxPoint</h4>
<pre>public&nbsp;mxPoint(<a href="../../../com/mxgraph/util/mxPoint.html" title="class in com.mxgraph.util">mxPoint</a>&nbsp;point)</pre>
<div class="block">Constructs a new point at the location of the given point.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - Point that specifies the location.</dd></dl>
</li>
</ul>
<a name="mxPoint(double, double)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mxPoint</h4>
<pre>public&nbsp;mxPoint(double&nbsp;x,
double&nbsp;y)</pre>
<div class="block">Constructs a new point at (x, y).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - X-coordinate of the point to be created.</dd><dd><code>y</code> - Y-coordinate of the point to be created.</dd></dl>
</li>
</ul>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ============ METHOD DETAIL ========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getX()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getX</h4>
<pre>public&nbsp;double&nbsp;getX()</pre>
<div class="block">Returns the x-coordinate of the point.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the x-coordinate.</dd></dl>
</li>
</ul>
<a name="setX(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setX</h4>
<pre>public&nbsp;void&nbsp;setX(double&nbsp;value)</pre>
<div class="block">Sets the x-coordinate of the point.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Double that specifies the new x-coordinate.</dd></dl>
</li>
</ul>
<a name="getY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getY</h4>
<pre>public&nbsp;double&nbsp;getY()</pre>
<div class="block">Returns the x-coordinate of the point.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the x-coordinate.</dd></dl>
</li>
</ul>
<a name="setY(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setY</h4>
<pre>public&nbsp;void&nbsp;setY(double&nbsp;value)</pre>
<div class="block">Sets the y-coordinate of the point.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Double that specifies the new x-coordinate.</dd></dl>
</li>
</ul>
<a name="getPoint()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPoint</h4>
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;java.awt.Point&nbsp;getPoint()</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the coordinates as a new point.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns a new point for the location.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given object equals this rectangle.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
2014-11-10 09:02:21 +00:00
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
2014-04-01 11:30:48 +00:00
</dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;java.lang.Object&nbsp;clone()</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns a new instance of the same point.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
2014-11-10 09:02:21 +00:00
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
2014-04-01 11:30:48 +00:00
</dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns a <code>String</code> that represents the value
of this <code>mxPoint</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
2014-11-10 09:02:21 +00:00
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
2014-04-01 11:30:48 +00:00
<dt><span class="strong">Returns:</span></dt><dd>a string representation of this <code>mxPoint</code>.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2014-04-01 11:30:48 +00:00
<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/mxPoint.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>
2014-11-10 09:02:21 +00:00
<div class="aboutLanguage"><em><p><b>mxGraph 3.1.1.1</b></p></em></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/mxgraph/util/mxLine.html" title="class in com.mxgraph.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/mxgraph/util/mxRectangle.html" title="class in com.mxgraph.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/util/mxPoint.html" target="_top">Frames</a></li>
<li><a href="mxPoint.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");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</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>
2012-05-21 20:32:26 +00:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2014-04-01 11:30:48 +00:00
<p class="legalCopy"><small><font size=1>Copyright (c) 2010 <a href="http://www.mxgraph.com/"
target="_blank">Gaudenz Alder, David Benson</a>. All rights reserved.</font></small></p>
</body>
</html>