UNPKG

cordova-plugin-pdf417

Version:

A small and powerful PDF417 barcode scanning library

537 lines (535 loc) 18.2 kB
<!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 --> <title>Rectangle (LibPdf417Mobi API)</title> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Rectangle (LibPdf417Mobi API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/microblink/geometry/Quadrilateral.html" title="class in com.microblink.geometry"><span class="typeNameLink">Prev&nbsp;Class</span></a></li> <li>Next&nbsp;Class</li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/microblink/geometry/Rectangle.html" target="_top">Frames</a></li> <li><a href="Rectangle.html" target="_top">No&nbsp;Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses-noframe.html">All&nbsp;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">com.microblink.geometry</div> <h2 title="Class Rectangle" class="title">Class Rectangle</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.microblink.geometry.Rectangle</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>android.os.Parcelable</dd> </dl> <hr> <br> <pre>public class <span class="typeNameLabel">Rectangle</span> extends java.lang.Object implements android.os.Parcelable</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="nested.class.summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <ul class="blockList"> <li class="blockList"><a name="nested.classes.inherited.from.class.android.os.Parcelable"> <!-- --> </a> <h3>Nested classes/interfaces inherited from interface&nbsp;android.os.Parcelable</h3> <code>android.os.Parcelable.ClassLoaderCreator&lt;T&gt;, android.os.Parcelable.Creator&lt;T&gt;</code></li> </ul> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" 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 android.os.Parcelable.Creator&lt;<a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a>&gt;</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#CREATOR">CREATOR</a></span></code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields.inherited.from.class.android.os.Parcelable"> <!-- --> </a> <h3>Fields inherited from interface&nbsp;android.os.Parcelable</h3> <code>CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE</code></li> </ul> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#Rectangle-float-float-float-float-">Rectangle</a></span>(float&nbsp;x, float&nbsp;y, float&nbsp;width, float&nbsp;height)</code> <div class="block">Rectangle constructor.</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#describeContents--">describeContents</a></span>()</code>&nbsp;</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#getDefaultROI--">getDefaultROI</a></span>()</code> <div class="block">Returns the default rectangle that defines the whole image or view</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>float</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#getHeight--">getHeight</a></span>()</code>&nbsp;</td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>float</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#getWidth--">getWidth</a></span>()</code>&nbsp;</td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>float</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#getX--">getX</a></span>()</code>&nbsp;</td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>float</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#getY--">getY</a></span>()</code>&nbsp;</td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#isRelative--">isRelative</a></span>()</code> <div class="block">Return true if rectangle is given in relative coordinates.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#log--">log</a></span>()</code>&nbsp;</td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#normalizeToUnitRectangle--">normalizeToUnitRectangle</a></span>()</code>&nbsp;</td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>android.graphics.RectF</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#toRectF--">toRectF</a></span>()</code>&nbsp;</td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#toString--">toString</a></span>()</code>&nbsp;</td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/geometry/Rectangle.html#writeToParcel-android.os.Parcel-int-">writeToParcel</a></span>(android.os.Parcel&nbsp;dest, int&nbsp;flags)</code>&nbsp;</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="CREATOR"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CREATOR</h4> <pre>public static&nbsp;android.os.Parcelable.Creator&lt;<a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a>&gt; CREATOR</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Rectangle-float-float-float-float-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Rectangle</h4> <pre>public&nbsp;Rectangle(float&nbsp;x, float&nbsp;y, float&nbsp;width, float&nbsp;height)</pre> <div class="block">Rectangle constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>x</code> - top left x coordinate</dd> <dd><code>y</code> - top left y coordinate</dd> <dd><code>width</code> - rectangle width</dd> <dd><code>height</code> - rectangle height</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="isRelative--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isRelative</h4> <pre>public&nbsp;boolean&nbsp;isRelative()</pre> <div class="block">Return true if rectangle is given in relative coordinates. Relative coordinates mean that each coordinate is given as percentage.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if rectangle is given in relative coordinates</dd> </dl> </li> </ul> <a name="getDefaultROI--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDefaultROI</h4> <pre>public static&nbsp;<a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a>&nbsp;getDefaultROI()</pre> <div class="block">Returns the default rectangle that defines the whole image or view</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the default rectangle that defines the whole image or view</dd> </dl> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="log--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>log</h4> <pre>public&nbsp;void&nbsp;log()</pre> </li> </ul> <a name="normalizeToUnitRectangle--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>normalizeToUnitRectangle</h4> <pre>public&nbsp;void&nbsp;normalizeToUnitRectangle()</pre> </li> </ul> <a name="toRectF--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toRectF</h4> <pre>public&nbsp;android.graphics.RectF&nbsp;toRectF()</pre> </li> </ul> <a name="getX--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getX</h4> <pre>public&nbsp;float&nbsp;getX()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the x</dd> </dl> </li> </ul> <a name="getY--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getY</h4> <pre>public&nbsp;float&nbsp;getY()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the y</dd> </dl> </li> </ul> <a name="getWidth--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getWidth</h4> <pre>public&nbsp;float&nbsp;getWidth()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the width</dd> </dl> </li> </ul> <a name="getHeight--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getHeight</h4> <pre>public&nbsp;float&nbsp;getHeight()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the height</dd> </dl> </li> </ul> <a name="describeContents--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>describeContents</h4> <pre>public&nbsp;int&nbsp;describeContents()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>describeContents</code>&nbsp;in interface&nbsp;<code>android.os.Parcelable</code></dd> </dl> </li> </ul> <a name="writeToParcel-android.os.Parcel-int-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>writeToParcel</h4> <pre>public&nbsp;void&nbsp;writeToParcel(android.os.Parcel&nbsp;dest, int&nbsp;flags)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>writeToParcel</code>&nbsp;in interface&nbsp;<code>android.os.Parcelable</code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/microblink/geometry/Quadrilateral.html" title="class in com.microblink.geometry"><span class="typeNameLink">Prev&nbsp;Class</span></a></li> <li>Next&nbsp;Class</li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/microblink/geometry/Rectangle.html" target="_top">Frames</a></li> <li><a href="Rectangle.html" target="_top">No&nbsp;Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All&nbsp;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 ======= --> </body> </html>