You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

406 lines
17 KiB

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_131) on Sun Jun 04 20:12:53 MST 2017 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>Settings (LibrarySystem 1.0 API)</title>
  8. <meta name="date" content="2017-06-04">
  9. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  10. <script type="text/javascript" src="../script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="Settings (LibrarySystem 1.0 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../libsys/package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/Settings.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../index-all.html">Index</a></li>
  47. <li><a href="../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../libsys/ReturnDialog.html" title="class in libsys"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../libsys/SettingsDialog.html" title="class in libsys"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../index.html?libsys/Settings.html" target="_top">Frames</a></li>
  57. <li><a href="Settings.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">libsys</div>
  96. <h2 title="Class Settings" class="title">Class Settings</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>libsys.Settings</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public class <span class="typeNameLabel">Settings</span>
  113. extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
  114. </li>
  115. </ul>
  116. </div>
  117. <div class="summary">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  121. <ul class="blockList">
  122. <li class="blockList"><a name="constructor.summary">
  123. <!-- -->
  124. </a>
  125. <h3>Constructor Summary</h3>
  126. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  127. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  128. <tr>
  129. <th class="colOne" scope="col">Constructor and Description</th>
  130. </tr>
  131. <tr class="altColor">
  132. <td class="colOne"><code><span class="memberNameLink"><a href="../libsys/Settings.html#Settings-java.lang.String-">Settings</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;settingsFileName)</code>
  133. <div class="block">Creates new Settings importing information from the given file name</div>
  134. </td>
  135. </tr>
  136. </table>
  137. </li>
  138. </ul>
  139. <!-- ========== METHOD SUMMARY =========== -->
  140. <ul class="blockList">
  141. <li class="blockList"><a name="method.summary">
  142. <!-- -->
  143. </a>
  144. <h3>Method Summary</h3>
  145. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  146. <caption><span id="t0" class="activeTableTab"><span>All Methods</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>
  147. <tr>
  148. <th class="colFirst" scope="col">Modifier and Type</th>
  149. <th class="colLast" scope="col">Method and Description</th>
  150. </tr>
  151. <tr id="i0" class="altColor">
  152. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Settings.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</code>
  154. <div class="block">Get the value associated to the field name</div>
  155. </td>
  156. </tr>
  157. <tr id="i1" class="rowColor">
  158. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Settings.html#getKey-int-">getKey</a></span>(int&nbsp;location)</code>
  160. <div class="block">Get the field name from that specific location in the array list</div>
  161. </td>
  162. </tr>
  163. <tr id="i2" class="altColor">
  164. <td class="colFirst"><code>void</code></td>
  165. <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Settings.html#setBooksFilename-java.lang.String-">setBooksFilename</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newBooksFilename)</code>
  166. <div class="block">Change the file name for the Books</div>
  167. </td>
  168. </tr>
  169. <tr id="i3" class="rowColor">
  170. <td class="colFirst"><code>void</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Settings.html#setTitle-java.lang.String-">setTitle</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newTitle)</code>
  172. <div class="block">Change the title of the application</div>
  173. </td>
  174. </tr>
  175. <tr id="i4" class="altColor">
  176. <td class="colFirst"><code>void</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Settings.html#setUsersFilename-java.lang.String-">setUsersFilename</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newUsersFilename)</code>
  178. <div class="block">Change the file name for the Users</div>
  179. </td>
  180. </tr>
  181. <tr id="i5" class="rowColor">
  182. <td class="colFirst"><code>int</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Settings.html#size--">size</a></span>()</code>
  184. <div class="block">Amount of fields in the settings</div>
  185. </td>
  186. </tr>
  187. <tr id="i6" class="altColor">
  188. <td class="colFirst"><code>void</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/Settings.html#toFile--">toFile</a></span>()</code>
  190. <div class="block">Save the settings to the given input file</div>
  191. </td>
  192. </tr>
  193. </table>
  194. <ul class="blockList">
  195. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  196. <!-- -->
  197. </a>
  198. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  199. <code><a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  200. </ul>
  201. </li>
  202. </ul>
  203. </li>
  204. </ul>
  205. </div>
  206. <div class="details">
  207. <ul class="blockList">
  208. <li class="blockList">
  209. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  210. <ul class="blockList">
  211. <li class="blockList"><a name="constructor.detail">
  212. <!-- -->
  213. </a>
  214. <h3>Constructor Detail</h3>
  215. <a name="Settings-java.lang.String-">
  216. <!-- -->
  217. </a>
  218. <ul class="blockListLast">
  219. <li class="blockList">
  220. <h4>Settings</h4>
  221. <pre>public&nbsp;Settings(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;settingsFileName)</pre>
  222. <div class="block">Creates new Settings importing information from the given file name</div>
  223. <dl>
  224. <dt><span class="paramLabel">Parameters:</span></dt>
  225. <dd><code>settingsFileName</code> - File name of existing settings stored</dd>
  226. </dl>
  227. </li>
  228. </ul>
  229. </li>
  230. </ul>
  231. <!-- ============ METHOD DETAIL ========== -->
  232. <ul class="blockList">
  233. <li class="blockList"><a name="method.detail">
  234. <!-- -->
  235. </a>
  236. <h3>Method Detail</h3>
  237. <a name="toFile--">
  238. <!-- -->
  239. </a>
  240. <ul class="blockList">
  241. <li class="blockList">
  242. <h4>toFile</h4>
  243. <pre>public&nbsp;void&nbsp;toFile()</pre>
  244. <div class="block">Save the settings to the given input file</div>
  245. </li>
  246. </ul>
  247. <a name="size--">
  248. <!-- -->
  249. </a>
  250. <ul class="blockList">
  251. <li class="blockList">
  252. <h4>size</h4>
  253. <pre>public&nbsp;int&nbsp;size()</pre>
  254. <div class="block">Amount of fields in the settings</div>
  255. <dl>
  256. <dt><span class="returnLabel">Returns:</span></dt>
  257. <dd>Amount of keys</dd>
  258. </dl>
  259. </li>
  260. </ul>
  261. <a name="getKey-int-">
  262. <!-- -->
  263. </a>
  264. <ul class="blockList">
  265. <li class="blockList">
  266. <h4>getKey</h4>
  267. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getKey(int&nbsp;location)</pre>
  268. <div class="block">Get the field name from that specific location in the array list</div>
  269. <dl>
  270. <dt><span class="paramLabel">Parameters:</span></dt>
  271. <dd><code>location</code> - Location of the field in the array list</dd>
  272. <dt><span class="returnLabel">Returns:</span></dt>
  273. <dd>The field name</dd>
  274. </dl>
  275. </li>
  276. </ul>
  277. <a name="get-java.lang.String-">
  278. <!-- -->
  279. </a>
  280. <ul class="blockList">
  281. <li class="blockList">
  282. <h4>get</h4>
  283. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;get(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
  284. <div class="block">Get the value associated to the field name</div>
  285. <dl>
  286. <dt><span class="paramLabel">Parameters:</span></dt>
  287. <dd><code>key</code> - Field name</dd>
  288. <dt><span class="returnLabel">Returns:</span></dt>
  289. <dd>Field value</dd>
  290. </dl>
  291. </li>
  292. </ul>
  293. <a name="setTitle-java.lang.String-">
  294. <!-- -->
  295. </a>
  296. <ul class="blockList">
  297. <li class="blockList">
  298. <h4>setTitle</h4>
  299. <pre>public&nbsp;void&nbsp;setTitle(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newTitle)</pre>
  300. <div class="block">Change the title of the application</div>
  301. <dl>
  302. <dt><span class="paramLabel">Parameters:</span></dt>
  303. <dd><code>newTitle</code> - New Title</dd>
  304. </dl>
  305. </li>
  306. </ul>
  307. <a name="setUsersFilename-java.lang.String-">
  308. <!-- -->
  309. </a>
  310. <ul class="blockList">
  311. <li class="blockList">
  312. <h4>setUsersFilename</h4>
  313. <pre>public&nbsp;void&nbsp;setUsersFilename(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newUsersFilename)</pre>
  314. <div class="block">Change the file name for the Users</div>
  315. <dl>
  316. <dt><span class="paramLabel">Parameters:</span></dt>
  317. <dd><code>newUsersFilename</code> - New file name for Users</dd>
  318. </dl>
  319. </li>
  320. </ul>
  321. <a name="setBooksFilename-java.lang.String-">
  322. <!-- -->
  323. </a>
  324. <ul class="blockListLast">
  325. <li class="blockList">
  326. <h4>setBooksFilename</h4>
  327. <pre>public&nbsp;void&nbsp;setBooksFilename(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newBooksFilename)</pre>
  328. <div class="block">Change the file name for the Books</div>
  329. <dl>
  330. <dt><span class="paramLabel">Parameters:</span></dt>
  331. <dd><code>newBooksFilename</code> - New file name for Books</dd>
  332. </dl>
  333. </li>
  334. </ul>
  335. </li>
  336. </ul>
  337. </li>
  338. </ul>
  339. </div>
  340. </div>
  341. <!-- ========= END OF CLASS DATA ========= -->
  342. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  343. <div class="bottomNav"><a name="navbar.bottom">
  344. <!-- -->
  345. </a>
  346. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  347. <a name="navbar.bottom.firstrow">
  348. <!-- -->
  349. </a>
  350. <ul class="navList" title="Navigation">
  351. <li><a href="../libsys/package-summary.html">Package</a></li>
  352. <li class="navBarCell1Rev">Class</li>
  353. <li><a href="class-use/Settings.html">Use</a></li>
  354. <li><a href="package-tree.html">Tree</a></li>
  355. <li><a href="../deprecated-list.html">Deprecated</a></li>
  356. <li><a href="../index-all.html">Index</a></li>
  357. <li><a href="../help-doc.html">Help</a></li>
  358. </ul>
  359. </div>
  360. <div class="subNav">
  361. <ul class="navList">
  362. <li><a href="../libsys/ReturnDialog.html" title="class in libsys"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  363. <li><a href="../libsys/SettingsDialog.html" title="class in libsys"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  364. </ul>
  365. <ul class="navList">
  366. <li><a href="../index.html?libsys/Settings.html" target="_top">Frames</a></li>
  367. <li><a href="Settings.html" target="_top">No&nbsp;Frames</a></li>
  368. </ul>
  369. <ul class="navList" id="allclasses_navbar_bottom">
  370. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  371. </ul>
  372. <div>
  373. <script type="text/javascript"><!--
  374. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  375. if(window==top) {
  376. allClassesLink.style.display = "block";
  377. }
  378. else {
  379. allClassesLink.style.display = "none";
  380. }
  381. //-->
  382. </script>
  383. </div>
  384. <div>
  385. <ul class="subNavList">
  386. <li>Summary:&nbsp;</li>
  387. <li>Nested&nbsp;|&nbsp;</li>
  388. <li>Field&nbsp;|&nbsp;</li>
  389. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  390. <li><a href="#method.summary">Method</a></li>
  391. </ul>
  392. <ul class="subNavList">
  393. <li>Detail:&nbsp;</li>
  394. <li>Field&nbsp;|&nbsp;</li>
  395. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  396. <li><a href="#method.detail">Method</a></li>
  397. </ul>
  398. </div>
  399. <a name="skip.navbar.bottom">
  400. <!-- -->
  401. </a></div>
  402. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  403. <p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
  404. </body>
  405. </html>