UNPKG

cordova-plugin-pdf417

Version:

A small and powerful PDF417 barcode scanning library

445 lines (444 loc) 17.3 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>CameraAspectMode (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="CameraAspectMode (LibPdf417Mobi API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":9,"i2":9,"i3":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/view/BaseCameraView.CameraViewState.html" title="enum in com.microblink.view"><span class="typeNameLink">Prev&nbsp;Class</span></a></li> <li><a href="../../../com/microblink/view/CameraEventsListener.html" title="interface in com.microblink.view"><span class="typeNameLink">Next&nbsp;Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/microblink/view/CameraAspectMode.html" target="_top">Frames</a></li> <li><a href="CameraAspectMode.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="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li> <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li> <li><a href="#field.detail">Field</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.view</div> <h2 title="Enum CameraAspectMode" class="title">Enum CameraAspectMode</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.lang.Enum&lt;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>&gt;</li> <li> <ul class="inheritance"> <li>com.microblink.view.CameraAspectMode</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>android.os.Parcelable, java.io.Serializable, java.lang.Comparable&lt;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>&gt;</dd> </dl> <hr> <br> <pre>public enum <span class="typeNameLabel">CameraAspectMode</span> extends java.lang.Enum&lt;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>&gt; implements android.os.Parcelable</pre> <div class="block">Created by dodo on 22/10/14.</div> </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> <!-- =========== ENUM CONSTANT SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="enum.constant.summary"> <!-- --> </a> <h3>Enum Constant Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colOne" scope="col">Enum Constant and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/microblink/view/CameraAspectMode.html#ASPECT_FILL">ASPECT_FILL</a></span></code> <div class="block">Aspect ratio of the camera preview will be kept by zooming and cropping the camera preview so that it will fill the given view.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/microblink/view/CameraAspectMode.html#ASPECT_FIT">ASPECT_FIT</a></span></code> <div class="block">Aspect ratio of the camera preview will be kept by letterboxing the camera preview into the given view.</div> </td> </tr> </table> </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/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>&gt;</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/view/CameraAspectMode.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> <!-- ========== 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/view/CameraAspectMode.html#describeContents--">describeContents</a></span>()</code>&nbsp;</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/view/CameraAspectMode.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code> <div class="block">Returns the enum constant of this type with the specified name.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/view/CameraAspectMode.html#values--">values</a></span>()</code> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/view/CameraAspectMode.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.Enum"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Enum</h3> <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> </ul> <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>getClass, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ ENUM CONSTANT DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="enum.constant.detail"> <!-- --> </a> <h3>Enum Constant Detail</h3> <a name="ASPECT_FIT"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ASPECT_FIT</h4> <pre>public static final&nbsp;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a> ASPECT_FIT</pre> <div class="block">Aspect ratio of the camera preview will be kept by letterboxing the camera preview into the given view. This camera mode will use full camera frames for processing.</div> </li> </ul> <a name="ASPECT_FILL"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ASPECT_FILL</h4> <pre>public static final&nbsp;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a> ASPECT_FILL</pre> <div class="block">Aspect ratio of the camera preview will be kept by zooming and cropping the camera preview so that it will fill the given view. Only visible part of camera frame will be used for processing.</div> </li> </ul> </li> </ul> <!-- ============ 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 final&nbsp;android.os.Parcelable.Creator&lt;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>&gt; CREATOR</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="values--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>values</h4> <pre>public static&nbsp;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>[]&nbsp;values()</pre> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: <pre> for (CameraAspectMode c : CameraAspectMode.values()) &nbsp; System.out.println(c); </pre></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>an array containing the constants of this enum type, in the order they are declared</dd> </dl> </li> </ul> <a name="valueOf-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>valueOf</h4> <pre>public static&nbsp;<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view">CameraAspectMode</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>name</code> - the name of the enum constant to be returned.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the enum constant with the specified name</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> <dd><code>java.lang.NullPointerException</code> - if the argument is null</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/view/BaseCameraView.CameraViewState.html" title="enum in com.microblink.view"><span class="typeNameLink">Prev&nbsp;Class</span></a></li> <li><a href="../../../com/microblink/view/CameraEventsListener.html" title="interface in com.microblink.view"><span class="typeNameLink">Next&nbsp;Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/microblink/view/CameraAspectMode.html" target="_top">Frames</a></li> <li><a href="CameraAspectMode.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="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li> <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li> <li><a href="#field.detail">Field</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>