TextDisplayObject.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  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-internal) on Thu Mar 24 15:49:01 EDT 2022 -->
  6. <title>TextDisplayObject</title>
  7. <meta name="date" content="2022-03-24">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="TextDisplayObject";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
  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="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="package-tree.html">Tree</a></li>
  44. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  45. <li><a href="../../../../index-all.html">Index</a></li>
  46. <li><a href="../../../../help-doc.html">Help</a></li>
  47. </ul>
  48. </div>
  49. <div class="subNav">
  50. <ul class="navList">
  51. <li><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../../com/cognos/CAM_AAA/authentication/TextNoEchoDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/TextDisplayObject.html" target="_top">Frames</a></li>
  56. <li><a href="TextDisplayObject.html" target="_top">No&nbsp;Frames</a></li>
  57. </ul>
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <div>
  62. <script type="text/javascript"><!--
  63. allClassesLink = document.getElementById("allclasses_navbar_top");
  64. if(window==top) {
  65. allClassesLink.style.display = "block";
  66. }
  67. else {
  68. allClassesLink.style.display = "none";
  69. }
  70. //-->
  71. </script>
  72. </div>
  73. <div>
  74. <ul class="subNavList">
  75. <li>Summary:&nbsp;</li>
  76. <li>Nested&nbsp;|&nbsp;</li>
  77. <li>Field&nbsp;|&nbsp;</li>
  78. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#method.summary">Method</a></li>
  80. </ul>
  81. <ul class="subNavList">
  82. <li>Detail:&nbsp;</li>
  83. <li>Field&nbsp;|&nbsp;</li>
  84. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  85. <li><a href="#method.detail">Method</a></li>
  86. </ul>
  87. </div>
  88. <a name="skip.navbar.top">
  89. <!-- -->
  90. </a></div>
  91. <!-- ========= END OF TOP NAVBAR ========= -->
  92. <!-- ======== START OF CLASS DATA ======== -->
  93. <div role="main" title ="TextDisplayObject" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Class TextDisplayObject" class="title" id="Header1">Class TextDisplayObject</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>com.cognos.CAM_AAA.authentication.TextDisplayObject</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ITextDisplayObject</a></dd>
  113. </dl>
  114. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/ReadOnlyDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication">ReadOnlyDisplayObject</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/TextNoEchoDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication">TextNoEchoDisplayObject</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/VerifyTextNoEchoDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication">VerifyTextNoEchoDisplayObject</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public class <span class="typeNameLabel">TextDisplayObject</span>
  121. extends java.lang.Object
  122. implements <a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ITextDisplayObject</a></pre>
  123. <div class="block">A display object that allows the user to type
  124. in information. The information typed is echoed for the user to see.</div>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/TextDisplayObject.html#TextDisplayObject-java.lang.String-java.lang.String-">TextDisplayObject</a></span>(java.lang.String&nbsp;theCaption,
  144. java.lang.String&nbsp;theName)</code>
  145. <div class="block">Create a text display object.</div>
  146. </td>
  147. </tr>
  148. </table>
  149. </li>
  150. </ul>
  151. <!-- ========== METHOD SUMMARY =========== -->
  152. <ul class="blockList">
  153. <li class="blockList"><a name="method.summary">
  154. <!-- -->
  155. </a>
  156. <h3>Method Summary</h3>
  157. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  158. <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>
  159. <tr>
  160. <th class="colFirst" scope="col">Modifier and Type</th>
  161. <th class="colLast" scope="col">Method and Description</th>
  162. </tr>
  163. <tr id="i0" class="altColor">
  164. <td class="colFirst"><code>java.lang.String</code></td>
  165. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/TextDisplayObject.html#getCaption--">getCaption</a></span>()</code>
  166. <div class="block">Returns the caption for this display object.</div>
  167. </td>
  168. </tr>
  169. <tr id="i1" class="rowColor">
  170. <td class="colFirst"><code>java.lang.String</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/TextDisplayObject.html#getName--">getName</a></span>()</code>
  172. <div class="block">Returns the name of the display object.</div>
  173. </td>
  174. </tr>
  175. <tr id="i2" class="altColor">
  176. <td class="colFirst"><code>java.lang.String</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/TextDisplayObject.html#getValue--">getValue</a></span>()</code>
  178. <div class="block">Returns the value that is currently set.</div>
  179. </td>
  180. </tr>
  181. <tr id="i3" class="rowColor">
  182. <td class="colFirst"><code>void</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/TextDisplayObject.html#setValue-java.lang.String-">setValue</a></span>(java.lang.String&nbsp;theValue)</code>
  184. <div class="block">Sets the value for a display object.</div>
  185. </td>
  186. </tr>
  187. </table>
  188. <ul class="blockList">
  189. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  190. <!-- -->
  191. </a>
  192. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  193. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  194. </ul>
  195. <ul class="blockList">
  196. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IDisplayObject">
  197. <!-- -->
  198. </a>
  199. <h3>Methods inherited from interface&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a></h3>
  200. <code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getName--">getName</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getValue--">getValue</a></code></li>
  201. </ul>
  202. </li>
  203. </ul>
  204. </li>
  205. </ul>
  206. </div>
  207. <div class="details">
  208. <ul class="blockList">
  209. <li class="blockList">
  210. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  211. <ul class="blockList">
  212. <li class="blockList"><a name="constructor.detail">
  213. <!-- -->
  214. </a>
  215. <h3>Constructor Detail</h3>
  216. <a name="TextDisplayObject-java.lang.String-java.lang.String-">
  217. <!-- -->
  218. </a>
  219. <ul class="blockListLast">
  220. <li class="blockList">
  221. <h4>TextDisplayObject</h4>
  222. <pre>public&nbsp;TextDisplayObject(java.lang.String&nbsp;theCaption,
  223. java.lang.String&nbsp;theName)</pre>
  224. <div class="block">Create a text display object.</div>
  225. <dl>
  226. <dt><span class="paramLabel">Parameters:</span></dt>
  227. <dd><code>theCaption</code> - The label for the display object.</dd>
  228. <dd><code>theName</code> - The name of the display object.</dd>
  229. </dl>
  230. </li>
  231. </ul>
  232. </li>
  233. </ul>
  234. <!-- ============ METHOD DETAIL ========== -->
  235. <ul class="blockList">
  236. <li class="blockList"><a name="method.detail">
  237. <!-- -->
  238. </a>
  239. <h3>Method Detail</h3>
  240. <a name="getCaption--">
  241. <!-- -->
  242. </a>
  243. <ul class="blockList">
  244. <li class="blockList">
  245. <h4>getCaption</h4>
  246. <pre>public&nbsp;java.lang.String&nbsp;getCaption()</pre>
  247. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html#getCaption--">ITextDisplayObject</a></code></span></div>
  248. <div class="block">Returns the caption for this display object.</div>
  249. <dl>
  250. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  251. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html#getCaption--">getCaption</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ITextDisplayObject</a></code></dd>
  252. <dt><span class="returnLabel">Returns:</span></dt>
  253. <dd>The caption for this display object.</dd>
  254. </dl>
  255. </li>
  256. </ul>
  257. <a name="getName--">
  258. <!-- -->
  259. </a>
  260. <ul class="blockList">
  261. <li class="blockList">
  262. <h4>getName</h4>
  263. <pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
  264. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getName--">IDisplayObject</a></code></span></div>
  265. <div class="block">Returns the name of the display object.</div>
  266. <dl>
  267. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  268. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getName--">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a></code></dd>
  269. <dt><span class="returnLabel">Returns:</span></dt>
  270. <dd>The name of the display object.</dd>
  271. </dl>
  272. </li>
  273. </ul>
  274. <a name="getValue--">
  275. <!-- -->
  276. </a>
  277. <ul class="blockList">
  278. <li class="blockList">
  279. <h4>getValue</h4>
  280. <pre>public&nbsp;java.lang.String&nbsp;getValue()</pre>
  281. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getValue--">IDisplayObject</a></code></span></div>
  282. <div class="block">Returns the value that is currently set.</div>
  283. <dl>
  284. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  285. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getValue--">getValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a></code></dd>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd>The value that is currently set.</dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. <a name="setValue-java.lang.String-">
  292. <!-- -->
  293. </a>
  294. <ul class="blockListLast">
  295. <li class="blockList">
  296. <h4>setValue</h4>
  297. <pre>public&nbsp;void&nbsp;setValue(java.lang.String&nbsp;theValue)</pre>
  298. <div class="block">Sets the value for a display object.</div>
  299. <dl>
  300. <dt><span class="paramLabel">Parameters:</span></dt>
  301. <dd><code>theValue</code> - The value to set for the display object.</dd>
  302. </dl>
  303. </li>
  304. </ul>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </div>
  310. </div>
  311. <!-- ========= END OF CLASS DATA ========= -->
  312. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  313. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  314. <div class="bottomNav"><a name="navbar.bottom">
  315. <!-- -->
  316. </a>
  317. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  318. <a name="navbar.bottom.firstrow">
  319. <!-- -->
  320. </a>
  321. <ul class="navList" title="Navigation">
  322. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  323. <li class="navBarCell1Rev">Class</li>
  324. <li><a href="package-tree.html">Tree</a></li>
  325. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  326. <li><a href="../../../../index-all.html">Index</a></li>
  327. <li><a href="../../../../help-doc.html">Help</a></li>
  328. </ul>
  329. </div>
  330. <div class="subNav">
  331. <ul class="navList">
  332. <li><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  333. <li><a href="../../../../com/cognos/CAM_AAA/authentication/TextNoEchoDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  334. </ul>
  335. <ul class="navList">
  336. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/TextDisplayObject.html" target="_top">Frames</a></li>
  337. <li><a href="TextDisplayObject.html" target="_top">No&nbsp;Frames</a></li>
  338. </ul>
  339. <ul class="navList" id="allclasses_navbar_bottom">
  340. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  341. </ul>
  342. <div>
  343. <script type="text/javascript"><!--
  344. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  345. if(window==top) {
  346. allClassesLink.style.display = "block";
  347. }
  348. else {
  349. allClassesLink.style.display = "none";
  350. }
  351. //-->
  352. </script>
  353. </div>
  354. <div>
  355. <ul class="subNavList">
  356. <li>Summary:&nbsp;</li>
  357. <li>Nested&nbsp;|&nbsp;</li>
  358. <li>Field&nbsp;|&nbsp;</li>
  359. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  360. <li><a href="#method.summary">Method</a></li>
  361. </ul>
  362. <ul class="subNavList">
  363. <li>Detail:&nbsp;</li>
  364. <li>Field&nbsp;|&nbsp;</li>
  365. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  366. <li><a href="#method.detail">Method</a></li>
  367. </ul>
  368. </div>
  369. <a name="skip.navbar.bottom">
  370. <!-- -->
  371. </a></div>
  372. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  373. </body>
  374. </html>