PageRenderTime 43ms CodeModel.GetById 18ms RepoModel.GetById 0ms app.codeStats 0ms

/as3/trunk/docs/nochump/util/zip/ZipEntry.html

http://papervision3d.googlecode.com/
HTML | 333 lines | 324 code | 0 blank | 9 comment | 0 complexity | 5a5e468997774523bc90a10527bef1f5 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

    2. 

  2. <html>

    3. 

  3. <head>

    4. 

  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">

    5. 

  5. <link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">

    6. 

  6. <link rel="stylesheet" href="../../../print.css" type="text/css" media="print">

    7. 

  7. <meta content="ZipEntry,nochump.util.zip.ZipEntry,comment,compressedSize,crc,extra,method,name,size,time,isDirectory,toString" name="keywords">

    8. 

  8. <title>nochump.util.zip.ZipEntry</title>

    9. 

  9. </head>

    10. 

  10. <body>

    11. 

  11. <script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">

    12. 

  12. <!--

    13. 

  13. 				asdocTitle = 'ZipEntry - Papervision3D Official Documentation';

    14. 

  14. 				var baseRef = '../../../';

    15. 

  15. 				window.onload = configPage;

    16. 

  16. 			--></script>

    17. 

  17. <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">

    18. 

  18. <tr>

    19. 

  19. <td align="left" class="titleTableTitle">Papervision3D Official Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?nochump/util/zip/ZipEntry.html&amp;nochump/util/zip/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>

    20. 

  20. </tr>

    21. 

  21. <tr class="titleTableRow2">

    22. 

  22. <td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;ZipEntry</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>

    23. 

  23. </tr>

    24. 

  24. <tr class="titleTableRow3">

    25. 

  25. <td colspan="2">&nbsp;</td>

    26. 

  26. </tr>

    27. 

  27. </table>

    28. 

  28. <script type="text/javascript" language="javascript">

    29. 

  29. <!--

    30. 

  30. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class ZipEntry"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}

    31. 

  31. --></script>

    32. 

  32. <div class="MainContent">

    33. 

  33. <table cellspacing="0" cellpadding="0" class="classHeaderTable">

    34. 

  34. <tr>

    35. 

  35. <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">nochump.util.zip</a></td>

    36. 

  36. </tr>

    37. 

  37. <tr>

    38. 

  38. <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ZipEntry</td>

    39. 

  39. </tr>

    40. 

  40. </table>

    41. 

  41. <p></p>
    42. 

  42.   This class represents a member of a zip archive.  ZipFile
    43. 

  43.   will give you instances of this class as information
    44. 

  44.   about the members in an archive.  On the other hand ZipOutput
    45. 

  45.   needs an instance of this class to create a new member.
    46. 

  46.     <p></p>

    47. 

  47. <br>

    48. 

  48. <hr>

    49. 

  49. </div>

    50. 

  50. <a name="propertySummary"></a>

    51. 

  51. <div class="summarySection">

    52. 

  52. <div class="summaryTableTitle">Public Properties</div>

    53. 

  53. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">

    54. 

  54. <tr>

    55. 

  55. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>

    56. 

  56. </tr>

    57. 

  57. <tr class="">

    58. 

  58. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#comment">comment</a> : String<div class="summaryTableDescription">
    59. 

  59.    Gets the extra data.</div>

    60. 

  60. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    61. 

  61. </tr>

    62. 

  62. <tr class="">

    63. 

  63. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#compressedSize">compressedSize</a> : int<div class="summaryTableDescription">
    64. 

  64.    Gets the size of the compressed data.</div>

    65. 

  65. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    66. 

  66. </tr>

    67. 

  67. <tr class="">

    68. 

  68. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#crc">crc</a> : uint<div class="summaryTableDescription">
    69. 

  69.    Gets the crc of the uncompressed data.</div>

    70. 

  70. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    71. 

  71. </tr>

    72. 

  72. <tr class="">

    73. 

  73. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#extra">extra</a> : ByteArray<div class="summaryTableDescription">
    74. 

  74.    Gets the extra data.</div>

    75. 

  75. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    76. 

  76. </tr>

    77. 

  77. <tr class="">

    78. 

  78. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#method">method</a> : int<div class="summaryTableDescription">
    79. 

  79.    Gets the compression method.</div>

    80. 

  80. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    81. 

  81. </tr>

    82. 

  82. <tr class="">

    83. 

  83. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#name">name</a> : String<div class="summaryTableDescription">[read-only]
    84. 

  84.    Returns the entry name.</div>

    85. 

  85. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    86. 

  86. </tr>

    87. 

  87. <tr class="">

    88. 

  88. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#size">size</a> : int<div class="summaryTableDescription">
    89. 

  89.    Gets the size of the uncompressed data.</div>

    90. 

  90. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    91. 

  91. </tr>

    92. 

  92. <tr class="">

    93. 

  93. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#time">time</a> : Number<div class="summaryTableDescription">
    94. 

  94.    Gets the time of last modification of the entry.</div>

    95. 

  95. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    96. 

  96. </tr>

    97. 

  97. </table>

    98. 

  98. </div>

    99. 

  99. <a name="methodSummary"></a>

    100. 

  100. <div class="summarySection">

    101. 

  101. <div class="summaryTableTitle">Public Methods</div>

    102. 

  102. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">

    103. 

  103. <tr>

    104. 

  104. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>

    105. 

  105. </tr>

    106. 

  106. <tr class="">

    107. 

  107. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    108. 

  108. <div class="summarySignature">

    109. 

  109. <a class="signatureLink" href="#ZipEntry()">ZipEntry</a>(name:String)</div>

    110. 

  110. <div class="summaryTableDescription">
    111. 

  111.    Creates a zip entry with the given name.</div>

    112. 

  112. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    113. 

  113. </tr>

    114. 

  114. <tr class="">

    115. 

  115. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    116. 

  116. <div class="summarySignature">

    117. 

  117. <a class="signatureLink" href="#isDirectory()">isDirectory</a>():Boolean</div>

    118. 

  118. <div class="summaryTableDescription">
    119. 

  119.    Gets true, if the entry is a directory.</div>

    120. 

  120. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    121. 

  121. </tr>

    122. 

  122. <tr class="">

    123. 

  123. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">

    124. 

  124. <div class="summarySignature">

    125. 

  125. <a class="signatureLink" href="#toString()">toString</a>():String</div>

    126. 

  126. <div class="summaryTableDescription">
    127. 

  127.    Gets the string representation of this ZipEntry.</div>

    128. 

  128. </td><td class="summaryTableOwnerCol">ZipEntry</td>

    129. 

  129. </tr>

    130. 

  130. </table>

    131. 

  131. </div>

    132. 

  132. <script type="text/javascript" language="javascript">

    133. 

  133. <!--

    134. 

  134. showHideInherited();

    135. 

  135. --></script>

    136. 

  136. <div class="MainContent">

    137. 

  137. <a name="propertyDetail"></a>

    138. 

  138. <div class="detailSectionHeader">Property detail</div>

    139. 

  139. <a name="comment"></a>

    140. 

  140. <table cellspacing="0" cellpadding="0" class="detailHeader">

    141. 

  141. <tr>

    142. 

  142. <td class="detailHeaderName">comment</td><td class="detailHeaderType">property</td>

    143. 

  143. </tr>

    144. 

  144. </table>

    145. 

  145. <div class="detailBody">

    146. 

  146. <code>comment:String</code>&nbsp;&nbsp;[read-write]<p>
    147. 

  147.    Gets the extra data.
    148. 

  148.    </p><span class="label">Implementation</span>

    149. 

  149. <br>

    150. 

  150. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get comment():String</code>

    151. 

  151. <br>

    152. 

  152. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set comment(value:String):void</code>

    153. 

  153. <br>

    154. 

  154. </div>

    155. 

  155. <a name="compressedSize"></a>

    156. 

  156. <table cellspacing="0" cellpadding="0" class="detailHeader">

    157. 

  157. <tr>

    158. 

  158. <td class="detailHeaderName">compressedSize</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>

    159. 

  159. </tr>

    160. 

  160. </table>

    161. 

  161. <div class="detailBody">

    162. 

  162. <code>compressedSize:int</code>&nbsp;&nbsp;[read-write]<p>
    163. 

  163.    Gets the size of the compressed data.
    164. 

  164.    </p><span class="label">Implementation</span>

    165. 

  165. <br>

    166. 

  166. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get compressedSize():int</code>

    167. 

  167. <br>

    168. 

  168. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set compressedSize(value:int):void</code>

    169. 

  169. <br>

    170. 

  170. </div>

    171. 

  171. <a name="crc"></a>

    172. 

  172. <table cellspacing="0" cellpadding="0" class="detailHeader">

    173. 

  173. <tr>

    174. 

  174. <td class="detailHeaderName">crc</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>

    175. 

  175. </tr>

    176. 

  176. </table>

    177. 

  177. <div class="detailBody">

    178. 

  178. <code>crc:uint</code>&nbsp;&nbsp;[read-write]<p>
    179. 

  179.    Gets the crc of the uncompressed data.
    180. 

  180.    </p><span class="label">Implementation</span>

    181. 

  181. <br>

    182. 

  182. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get crc():uint</code>

    183. 

  183. <br>

    184. 

  184. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set crc(value:uint):void</code>

    185. 

  185. <br>

    186. 

  186. </div>

    187. 

  187. <a name="extra"></a>

    188. 

  188. <table cellspacing="0" cellpadding="0" class="detailHeader">

    189. 

  189. <tr>

    190. 

  190. <td class="detailHeaderName">extra</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>

    191. 

  191. </tr>

    192. 

  192. </table>

    193. 

  193. <div class="detailBody">

    194. 

  194. <code>extra:ByteArray</code>&nbsp;&nbsp;[read-write]<p>
    195. 

  195.    Gets the extra data.
    196. 

  196.    </p><span class="label">Implementation</span>

    197. 

  197. <br>

    198. 

  198. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get extra():ByteArray</code>

    199. 

  199. <br>

    200. 

  200. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set extra(value:ByteArray):void</code>

    201. 

  201. <br>

    202. 

  202. </div>

    203. 

  203. <a name="method"></a>

    204. 

  204. <table cellspacing="0" cellpadding="0" class="detailHeader">

    205. 

  205. <tr>

    206. 

  206. <td class="detailHeaderName">method</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>

    207. 

  207. </tr>

    208. 

  208. </table>

    209. 

  209. <div class="detailBody">

    210. 

  210. <code>method:int</code>&nbsp;&nbsp;[read-write]<p>
    211. 

  211.    Gets the compression method. 
    212. 

  212.    </p><span class="label">Implementation</span>

    213. 

  213. <br>

    214. 

  214. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get method():int</code>

    215. 

  215. <br>

    216. 

  216. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set method(value:int):void</code>

    217. 

  217. <br>

    218. 

  218. </div>

    219. 

  219. <a name="name"></a>

    220. 

  220. <table cellspacing="0" cellpadding="0" class="detailHeader">

    221. 

  221. <tr>

    222. 

  222. <td class="detailHeaderName">name</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>

    223. 

  223. </tr>

    224. 

  224. </table>

    225. 

  225. <div class="detailBody">

    226. 

  226. <code>name:String</code>&nbsp;&nbsp;[read-only]<p>
    227. 

  227.    Returns the entry name.  The path components in the entry are
    228. 

  228.    always separated by slashes ('/').  
    229. 

  229.    </p><span class="label">Implementation</span>

    230. 

  230. <br>

    231. 

  231. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get name():String</code>

    232. 

  232. <br>

    233. 

  233. </div>

    234. 

  234. <a name="size"></a>

    235. 

  235. <table cellspacing="0" cellpadding="0" class="detailHeader">

    236. 

  236. <tr>

    237. 

  237. <td class="detailHeaderName">size</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>

    238. 

  238. </tr>

    239. 

  239. </table>

    240. 

  240. <div class="detailBody">

    241. 

  241. <code>size:int</code>&nbsp;&nbsp;[read-write]<p>
    242. 

  242.    Gets the size of the uncompressed data.
    243. 

  243.    </p><span class="label">Implementation</span>

    244. 

  244. <br>

    245. 

  245. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get size():int</code>

    246. 

  246. <br>

    247. 

  247. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set size(value:int):void</code>

    248. 

  248. <br>

    249. 

  249. </div>

    250. 

  250. <a name="time"></a>

    251. 

  251. <table cellspacing="0" cellpadding="0" class="detailHeader">

    252. 

  252. <tr>

    253. 

  253. <td class="detailHeaderName">time</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>

    254. 

  254. </tr>

    255. 

  255. </table>

    256. 

  256. <div class="detailBody">

    257. 

  257. <code>time:Number</code>&nbsp;&nbsp;[read-write]<p>
    258. 

  258.    Gets the time of last modification of the entry.
    259. 

  259.    </p><span class="label">Implementation</span>

    260. 

  260. <br>

    261. 

  261. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get time():Number</code>

    262. 

  262. <br>

    263. 

  263. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set time(value:Number):void</code>

    264. 

  264. <br>

    265. 

  265. </div>

    266. 

  266. <a name="constructorDetail"></a>

    267. 

  267. <div class="detailSectionHeader">Constructor detail</div>

    268. 

  268. <a name="ZipEntry()"></a>

    269. 

  269. <table cellspacing="0" cellpadding="0" class="detailHeader">

    270. 

  270. <tr>

    271. 

  271. <td class="detailHeaderName">ZipEntry</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>

    272. 

  272. </tr>

    273. 

  273. </table>

    274. 

  274. <div class="detailBody">

    275. 

  275. <code>public function ZipEntry(name:String)</code><p>
    276. 

  276.    Creates a zip entry with the given name.
    277. 

  277.    </p><span class="label">Parameters</span>

    278. 

  278. <table border="0" cellspacing="0" cellpadding="0">

    279. 

  279. <tr>

    280. 

  280. <td width="20px"></td><td><code><span class="label">name</span>:String</code> &mdash; the name. May include directory components separated
    281. 

  281.    by '/'.
    282. 

  282.    </td>

    283. 

  283. </tr>

    284. 

  284. </table>

    285. 

  285. </div>

    286. 

  286. <a name="methodDetail"></a>

    287. 

  287. <div class="detailSectionHeader">Method detail</div>

    288. 

  288. <a name="isDirectory()"></a>

    289. 

  289. <table cellspacing="0" cellpadding="0" class="detailHeader">

    290. 

  290. <tr>

    291. 

  291. <td class="detailHeaderName">isDirectory</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>

    292. 

  292. </tr>

    293. 

  293. </table>

    294. 

  294. <div class="detailBody">

    295. 

  295. <code>public function isDirectory():Boolean</code><p>
    296. 

  296.    Gets true, if the entry is a directory.  This is solely
    297. 

  297.    determined by the name, a trailing slash '/' marks a directory.  
    298. 

  298.    </p><p></p>

    299. 

  299. <span class="label">Returns</span>

    300. 

  300. <table border="0" cellspacing="0" cellpadding="0">

    301. 

  301. <tr>

    302. 

  302. <td width="20"></td><td><code>Boolean</code></td>

    303. 

  303. </tr>

    304. 

  304. </table>

    305. 

  305. </div>

    306. 

  306. <a name="toString()"></a>

    307. 

  307. <table cellspacing="0" cellpadding="0" class="detailHeader">

    308. 

  308. <tr>

    309. 

  309. <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>

    310. 

  310. </tr>

    311. 

  311. </table>

    312. 

  312. <div class="detailBody">

    313. 

  313. <code>public function toString():String</code><p>
    314. 

  314.    Gets the string representation of this ZipEntry.  This is just
    315. 

  315.    the name as returned by name.
    316. 

  316.    </p><p></p>

    317. 

  317. <span class="label">Returns</span>

    318. 

  318. <table border="0" cellspacing="0" cellpadding="0">

    319. 

  319. <tr>

    320. 

  320. <td width="20"></td><td><code>String</code></td>

    321. 

  321. </tr>

    322. 

  322. </table>

    323. 

  323. </div>

    324. 

  324. <br>

    325. 

  325. <br>

    326. 

  326. <hr>

    327. 

  327. <br>

    328. 

  328. <p></p>

    329. 

  329. <center class="copyright">http://blog.papervision3d.org</center>

    330. 

  330. </div>

    331. 

  331. </body>

    332. 

  332. </html>

    333. 

  333. <!--http://blog.papervision3d.org-->

    334. 

  334.