home *** CD-ROM | disk | FTP | other *** search
/ The Best of Windows 95.com 1996 September / WIN95_09961.iso / java / mojo1-2e.exe / MOJODISK / DATA.4 / lib / packages / java2.def < prev    next >
Encoding:
Text File  |  1996-07-01  |  167.3 KB  |  6,993 lines

  1. DEF_COMPONENTNAME
  2. Dialog
  3. DEF_SUPERCLASS
  4. Window
  5. DEF_SUPERCOMPONENT
  6.  
  7. DEF_PACKAGE
  8. java
  9. awt
  10. DEF_ENDLIST
  11. DEF_SUBCOMPONENTLIST
  12. DEF_ENDLIST
  13. DEF_SUBCOMPONENTCLASSLIST
  14. DEF_ENDLIST
  15. DEF_CATEGORY
  16.  
  17. DEF_BITMAP
  18.  
  19. DEF_THUMBNAIL_UP
  20.  
  21. DEF_THUMBNAIL_DOWN
  22.  
  23. DEF_BASE
  24. DEF_IMPORTS
  25. DEF_ENDLIST
  26. DEF_REQUIRES
  27. DEF_ENDLIST
  28. DEF_IMPLEMENTS
  29. DEF_ENDLIST
  30. DEF_DECLARATION
  31. // A class that produces a dialog - a window that takes input from the user.
  32. // The default layout for a dialog is BorderLayout.
  33. DEF_ENDLIST
  34. DEF_METHOD
  35. public Dialog(Frame parent,
  36.               boolean modal)
  37. //    Constructs an initially invisible Dialog. A modal
  38. // Dialog grabs all the input from the user.
  39. //   
  40. //      Parameters:
  41. //      parent - the owner of the dialog
  42. //      modal - if true, dialog blocks input to other windows when shown
  43. //      See Also:
  44. //      resize, show
  45. //   
  46. // 
  47. DEF_ENDLIST
  48. DEF_METHOD
  49. public Dialog(Frame parent,
  50.               String title,
  51.               boolean modal)
  52. //    Constructs an initially invisible Dialog with a title. 
  53. // A modal Dialog grabs all the input from the user.
  54. //   
  55. //      Parameters:
  56. //      parent - the owner of the dialog
  57. //      title - the title of the dialog
  58. //      modal - if true, dialog blocks input to other windows when shown
  59. //      See Also:
  60. //      resize, show
  61. //   
  62. // 
  63. DEF_ENDLIST
  64. DEF_METHOD
  65. public synchronized void addNotify()
  66. //    Creates the frame's peer.  The peer allows us to change the appearance
  67. // of the frame without changing its functionality.
  68. //   
  69. //      Overrides:
  70. //      addNotify in class Window
  71. //   
  72. // 
  73. DEF_ENDLIST
  74. DEF_METHOD
  75. public boolean isModal()
  76. //    Returns true if the Dialog is modal.  A modal
  77. // Dialog grabs all the input from the user.
  78. // 
  79. DEF_ENDLIST
  80. DEF_METHOD
  81. public String getTitle()
  82. //    Gets the title of the Dialog.
  83. //   
  84. //      See Also:
  85. //      setTitle
  86. //   
  87. // 
  88. DEF_ENDLIST
  89. DEF_METHOD
  90. public void setTitle(String title)
  91. //    Sets the title of the Dialog.
  92. //   
  93. //      Parameters:
  94. //      title - the new title being given to the Dialog
  95. //      See Also:
  96. //      getTitle
  97. //   
  98. // 
  99. DEF_ENDLIST
  100. DEF_METHOD
  101. public boolean isResizable()
  102. //    Returns true if the user can resize the frame.
  103. // 
  104. DEF_ENDLIST
  105. DEF_METHOD
  106. public void setResizable(boolean resizable)
  107. //    Sets the resizable flag.
  108. //   
  109. //      Parameters:
  110. //      resizable - true if resizable; false otherwise
  111. //   
  112. // 
  113. DEF_ENDLIST
  114. DEF_METHOD
  115. protected String paramString()
  116. //    Returns the parameter String of this Dialog.
  117. //   
  118. //      Overrides:
  119. //      paramString in class Container
  120. //   
  121. // 
  122. DEF_ENDLIST
  123. DEF_PROPERTY
  124. Title
  125. String
  126. setTitle(AVALUE);
  127. AVALUE = getTitle();
  128. ""
  129. DEF_ENDLIST
  130. DEF_PROPERTY
  131. Resizable
  132. boolean
  133. setResizable(AVALUE);
  134. AVALUE = getResizable();
  135. false
  136. DEF_ENDLIST
  137. DEF_ENDCOMPONENT
  138. DEF_COMPONENTNAME
  139. Dimension
  140. DEF_SUPERCLASS
  141. Object
  142. DEF_SUPERCOMPONENT
  143.  
  144. DEF_PACKAGE
  145. java
  146. awt
  147. DEF_ENDLIST
  148. DEF_SUBCOMPONENTLIST
  149. DEF_ENDLIST
  150. DEF_SUBCOMPONENTCLASSLIST
  151. DEF_ENDLIST
  152. DEF_CATEGORY
  153.  
  154. DEF_BITMAP
  155.  
  156. DEF_THUMBNAIL_UP
  157.  
  158. DEF_THUMBNAIL_DOWN
  159.  
  160. DEF_BASE
  161. DEF_IMPORTS
  162. DEF_ENDLIST
  163. DEF_REQUIRES
  164. DEF_ENDLIST
  165. DEF_IMPLEMENTS
  166. DEF_ENDLIST
  167. DEF_DECLARATION
  168. // A class to encapsulate a width and a height Dimension.
  169. DEF_ENDLIST
  170. DEF_METHOD
  171. public Dimension()
  172. //    Constructs a Dimension with a 0 width and 0 height.
  173. // 
  174. DEF_ENDLIST
  175. DEF_METHOD
  176. public Dimension(Dimension d)
  177. //    Constructs a Dimension and initializes it to the specified value.
  178. //   
  179. //      Parameters:
  180. //      d - the specified dimension for the width and height values
  181. //   
  182. // 
  183. DEF_ENDLIST
  184. DEF_METHOD
  185. public Dimension(int width,
  186.                  int height)
  187. //    Constructs a Dimension and initializes it to the specified width and
  188. // specified height.
  189. //   
  190. //      Parameters:
  191. //      width - the specified width dimension
  192. //      height - the specified height dimension
  193. //   
  194. // 
  195. DEF_ENDLIST
  196. DEF_METHOD
  197. public String toString()
  198. //    Returns the String representation of this Dimension's values.
  199. //   
  200. //      Overrides:
  201. //      toString in class Object
  202. //   
  203. // 
  204. DEF_ENDLIST
  205. DEF_ENDCOMPONENT
  206. DEF_COMPONENTNAME
  207. Event
  208. DEF_SUPERCLASS
  209. Object
  210. DEF_SUPERCOMPONENT
  211.  
  212. DEF_PACKAGE
  213. java
  214. awt
  215. DEF_ENDLIST
  216. DEF_SUBCOMPONENTLIST
  217. DEF_ENDLIST
  218. DEF_SUBCOMPONENTCLASSLIST
  219. DEF_ENDLIST
  220. DEF_CATEGORY
  221.  
  222. DEF_BITMAP
  223.  
  224. DEF_THUMBNAIL_UP
  225.  
  226. DEF_THUMBNAIL_DOWN
  227.  
  228. DEF_BASE
  229. DEF_IMPORTS
  230. DEF_ENDLIST
  231. DEF_REQUIRES
  232. DEF_ENDLIST
  233. DEF_IMPLEMENTS
  234. DEF_ENDLIST
  235. DEF_DECLARATION
  236. // Event is a platform-independent class that encapsulates events from
  237. // the local Graphical User Interface(GUI) platform.
  238. DEF_ENDLIST
  239. DEF_EVENT
  240. public Event(Object target,
  241.              long when,
  242.              int id,
  243.              int x,
  244.              int y,
  245.              int key,
  246.              int modifiers,
  247.              Object arg)
  248. //    Constructs an event with the specified target component, time stamp,
  249. // event type, x and y coordinates, keyboard key, state of the modifier
  250. // keys and argument.
  251. //   
  252. //      Parameters:
  253. //      target - the target component
  254. //      when - the time stamp
  255. //      id - the event type
  256. //      x - the x coordinate
  257. //      y - the y coordinate
  258. //      key - the key pressed in a keyboard event
  259. //      modifiers - the state of the modifier keys
  260. //      arg - the specified argument
  261. //   
  262. // 
  263. DEF_ENDLIST
  264. DEF_EVENT
  265. public Event(Object target,
  266.              long when,
  267.              int id,
  268.              int x,
  269.              int y,
  270.              int key,
  271.              int modifiers)
  272. //    Constructs an event with the specified target component, time stamp,
  273. // event type, x and y coordinates, keyboard key, state of the modifier
  274. // keys and an argument set to null.
  275. //   
  276. //      Parameters:
  277. //      target - the target component
  278. //      when - the time stamp
  279. //      id - the event type
  280. //      x - the x coordinate
  281. //      y - the y coordinate
  282. //      key - the key pressed in a keyboard event
  283. //      modifiers - the state of the modifier keys
  284. //   
  285. // 
  286. DEF_ENDLIST
  287. DEF_EVENT
  288. public Event(Object target,
  289.              int id,
  290.              Object arg)
  291. //    Constructs an event with the specified target component, 
  292. // event type, and argument.
  293. //   
  294. //      Parameters:
  295. //      target - the target component
  296. //      id - the event type
  297. //      arg - the specified argument
  298. //   
  299. // 
  300. DEF_ENDLIST
  301. DEF_METHOD
  302. public void translate(int x,
  303.                       int y)
  304. //    Translates an event relative to the given component. This
  305. // involves at a minimum translating the coordinates so they make
  306. // sense within the given component. It may also involve
  307. // translating a region in the case of an expose event.
  308. //   
  309. //      Parameters:
  310. //      x - the x coordinate
  311. //      y - the y coordinate
  312. //   
  313. // 
  314. DEF_ENDLIST
  315. DEF_METHOD
  316. public boolean shiftDown()
  317. //    Checks if the shift key is down.
  318. //   
  319. //      See Also:
  320. //      modifiers, controlDown, metaDown
  321. //   
  322. // 
  323. DEF_ENDLIST
  324. DEF_METHOD
  325. public boolean controlDown()
  326. //    Checks if the control key is down.
  327. //   
  328. //      See Also:
  329. //      modifiers, shiftDown, metaDown
  330. //   
  331. // 
  332. DEF_ENDLIST
  333. DEF_METHOD
  334. public boolean metaDown()
  335. //    Checks if the meta key is down.
  336. //   
  337. //      See Also:
  338. //      modifiers, shiftDown, controlDown
  339. //   
  340. // 
  341. DEF_ENDLIST
  342. DEF_METHOD
  343. protected String paramString()
  344. //    Returns the parameter String of this Event.
  345. // 
  346. DEF_ENDLIST
  347. DEF_METHOD
  348. public String toString()
  349. //    Returns the String representation of this Event's values.
  350. //   
  351. //      Overrides:
  352. //      toString in class Object
  353. //   
  354. // 
  355. DEF_ENDLIST
  356. DEF_ENDCOMPONENT
  357. DEF_COMPONENTNAME
  358. FileDialog
  359. DEF_SUPERCLASS
  360. Dialog
  361. DEF_SUPERCOMPONENT
  362.  
  363. DEF_PACKAGE
  364. java
  365. awt
  366. DEF_ENDLIST
  367. DEF_SUBCOMPONENTLIST
  368. DEF_ENDLIST
  369. DEF_SUBCOMPONENTCLASSLIST
  370. DEF_ENDLIST
  371. DEF_CATEGORY
  372.  
  373. DEF_BITMAP
  374.  
  375. DEF_THUMBNAIL_UP
  376.  
  377. DEF_THUMBNAIL_DOWN
  378.  
  379. DEF_BASE
  380. DEF_IMPORTS
  381. DEF_ENDLIST
  382. DEF_REQUIRES
  383. DEF_ENDLIST
  384. DEF_IMPLEMENTS
  385. DEF_ENDLIST
  386. DEF_DECLARATION
  387. // The File Dialog class displays a file selection dialog. It is a
  388. // modal dialog and will block the calling thread when the show method
  389. // is called to display it, until the user has chosen a file.
  390. // 
  391. //      See Also:
  392. //      show
  393. // 
  394. DEF_ENDLIST
  395. DEF_METHOD
  396. public FileDialog(Frame parent,
  397.                   String title)
  398. //    Creates a file dialog for loading a file.
  399. //   
  400. //      Parameters:
  401. //      parent - the owner of the dialog
  402. //      title - the title of the Dialog
  403. //   
  404. // 
  405. DEF_ENDLIST
  406. DEF_METHOD
  407. public FileDialog(Frame parent,
  408.                   String title,
  409.                   int mode)
  410. //    Creates a file dialog with the specified title and mode.
  411. //   
  412. //      Parameters:
  413. //      parent - the owner of the dialog
  414. //      title - the title of the Dialog
  415. //      mode - the mode of the Dialog
  416. //   
  417. // 
  418. DEF_ENDLIST
  419. DEF_METHOD
  420. public synchronized void addNotify()
  421. //    Creates the frame's peer.  The peer allows us to change the look
  422. // of the file dialog without changing its functionality.
  423. //   
  424. //      Overrides:
  425. //      addNotify in class Dialog
  426. //   
  427. // 
  428. DEF_ENDLIST
  429. DEF_METHOD
  430. public int getMode()
  431. //    Gets the mode of the file dialog.
  432. // 
  433. DEF_ENDLIST
  434. DEF_METHOD
  435. public String getDirectory()
  436. //    Gets the directory of the Dialog.
  437. // 
  438. DEF_ENDLIST
  439. DEF_METHOD
  440. public void setDirectory(String dir)
  441. //    Set the directory of the Dialog to the specified directory.
  442. //   
  443. //      Parameters:
  444. //      dir - the specific directory
  445. //   
  446. // 
  447. DEF_ENDLIST
  448. DEF_METHOD
  449. public String getFile()
  450. //    Gets the file of the Dialog.
  451. // 
  452. DEF_ENDLIST
  453. DEF_METHOD
  454. public void setFile(String file)
  455. //    Sets the file for this dialog to the specified file. This will 
  456. // become the default file if set before the dialog is shown.
  457. //   
  458. //      Parameters:
  459. //      file - the file being set
  460. //   
  461. // 
  462. DEF_ENDLIST
  463. DEF_METHOD
  464. public FilenameFilter getFilenameFilter()
  465. //    Gets the filter.
  466. // 
  467. DEF_ENDLIST
  468. DEF_METHOD
  469. public void setFilenameFilter(FilenameFilter filter)
  470. //    Sets the filter for this dialog to the specified filter.
  471. //   
  472. //      Parameters:
  473. //      filter - the specified filter
  474. //   
  475. // 
  476. DEF_ENDLIST
  477. DEF_METHOD
  478. protected String paramString()
  479. //    Returns the parameter String of this file dialog.
  480. // Parameter String.
  481. //   
  482. //      Overrides:
  483. //      paramString in class Dialog
  484. //   
  485. // 
  486. DEF_ENDLIST
  487. DEF_PROPERTY
  488. File
  489. String
  490. setFile(AVALUE);
  491. AVALUE = getFile();
  492. ""
  493. DEF_ENDLIST
  494. DEF_PROPERTY
  495. Directory
  496. String
  497. setDirectory(AVALUE);
  498. AVALUE = getDirectory();
  499. "."
  500. DEF_ENDLIST
  501. DEF_ENDCOMPONENT
  502. DEF_COMPONENTNAME
  503. FlowLayout
  504. DEF_SUPERCLASS
  505. Object
  506. DEF_SUPERCOMPONENT
  507.  
  508. DEF_PACKAGE
  509. java
  510. awt
  511. DEF_ENDLIST
  512. DEF_SUBCOMPONENTLIST
  513. DEF_ENDLIST
  514. DEF_SUBCOMPONENTCLASSLIST
  515. DEF_ENDLIST
  516. DEF_CATEGORY
  517.  
  518. DEF_BITMAP
  519.  
  520. DEF_THUMBNAIL_UP
  521.  
  522. DEF_THUMBNAIL_DOWN
  523.  
  524. DEF_BASE
  525. DEF_IMPORTS
  526. DEF_ENDLIST
  527. DEF_REQUIRES
  528. DEF_ENDLIST
  529. DEF_IMPLEMENTS
  530. LayoutManager
  531. DEF_ENDLIST
  532. DEF_DECLARATION
  533. // Flow layout is used to layout buttons in a panel. It will arrange
  534. // buttons left to right until no more buttons fit on the same line.
  535. // Each line is centered.
  536. DEF_ENDLIST
  537. DEF_METHOD
  538. public FlowLayout()
  539. //    Constructs a new Flow Layout with a centered alignment.
  540. // 
  541. DEF_ENDLIST
  542. DEF_METHOD
  543. public FlowLayout(int align)
  544. //    Constructs a new Flow Layout with the specified alignment.
  545. //   
  546. //      Parameters:
  547. //      align - the alignment value
  548. //   
  549. // 
  550. DEF_ENDLIST
  551. DEF_METHOD
  552. public FlowLayout(int align,
  553.                   int hgap,
  554.                   int vgap)
  555. //    Constructs a new Flow Layout with the specified alignment and gap
  556. // values.
  557. //   
  558. //      Parameters:
  559. //      align - the alignment value
  560. //      hgap - the horizontal gap variable
  561. //      vgap - the vertical gap variable
  562. //   
  563. // 
  564. DEF_ENDLIST
  565. DEF_METHOD
  566. public void addLayoutComponent(String name,
  567.                                Component comp)
  568. //    Adds the specified component to the layout. Not used by this class.
  569. //   
  570. //      Parameters:
  571. //      name - the name of the component
  572. //      comp - the the component to be added
  573. //   
  574. // 
  575. DEF_ENDLIST
  576. DEF_METHOD
  577. public void removeLayoutComponent(Component comp)
  578. //    Removes the specified component from the layout. Not used by
  579. // this class.
  580. //   
  581. //      Parameters:
  582. //      comp - the component to remove
  583. //   
  584. // 
  585. DEF_ENDLIST
  586. DEF_METHOD
  587. public Dimension preferredLayoutSize(Container target)
  588. //    Returns the preferred dimensions for this layout given the components
  589. // in the specified target container.
  590. //   
  591. //      Parameters:
  592. //      target - the component which needs to be laid out
  593. //      See Also:
  594. //      Container, minimumLayoutSize
  595. //   
  596. // 
  597. DEF_ENDLIST
  598. DEF_METHOD
  599. public Dimension minimumLayoutSize(Container target)
  600. //    Returns the minimum dimensions needed to layout the components
  601. // contained in the specified target container.
  602. //   
  603. //      Parameters:
  604. //      target - the component which needs to be laid out
  605. //      See Also:
  606. //      preferredLayoutSize
  607. //   
  608. // 
  609. DEF_ENDLIST
  610. DEF_METHOD
  611. public void layoutContainer(Container target)
  612. //    Lays out the container. This method will actually reshape the
  613. // components in the target in order to satisfy the constraints of
  614. // the BorderLayout object.
  615. //   
  616. //      Parameters:
  617. //      target - the specified component being laid out.
  618. //      See Also:
  619. //      Container
  620. //   
  621. // 
  622. DEF_ENDLIST
  623. DEF_METHOD
  624. public String toString()
  625. //    Returns the String representation of this FlowLayout's values.
  626. //   
  627. //      Overrides:
  628. //      toString in class Object
  629. //   
  630. // 
  631. DEF_ENDLIST
  632. DEF_ENDCOMPONENT
  633. DEF_COMPONENTNAME
  634. Font
  635. DEF_SUPERCLASS
  636. Object
  637. DEF_SUPERCOMPONENT
  638.  
  639. DEF_PACKAGE
  640. java
  641. awt
  642. DEF_ENDLIST
  643. DEF_SUBCOMPONENTLIST
  644. DEF_ENDLIST
  645. DEF_SUBCOMPONENTCLASSLIST
  646. DEF_ENDLIST
  647. DEF_CATEGORY
  648.  
  649. DEF_BITMAP
  650.  
  651. DEF_THUMBNAIL_UP
  652.  
  653. DEF_THUMBNAIL_DOWN
  654.  
  655. DEF_BASE
  656. DEF_IMPORTS
  657. DEF_ENDLIST
  658. DEF_REQUIRES
  659. DEF_ENDLIST
  660. DEF_IMPLEMENTS
  661. DEF_ENDLIST
  662. DEF_DECLARATION
  663. // A class that produces font objects.
  664. DEF_ENDLIST
  665. DEF_METHOD
  666. public Font(String name,
  667.             int style,
  668.             int size)
  669. //    Creates a new font with the specified name, style and point size.
  670. //   
  671. //      Parameters:
  672. //      name - the font name
  673. //      style - the constant style used
  674. //      size - the point size of the font
  675. //      See Also:
  676. //      getFontList
  677. //   
  678. // 
  679. DEF_ENDLIST
  680. DEF_METHOD
  681. public String getFamily()
  682. //    Gets the platform specific family name of the font.
  683. // Use getName to get the logical name of the font.
  684. //   
  685. //      See Also:
  686. //      getName
  687. //   
  688. // 
  689. DEF_ENDLIST
  690. DEF_METHOD
  691. public String getName()
  692. //    Gets the logical name of the font.
  693. //   
  694. //      See Also:
  695. //      getFamily
  696. //   
  697. // 
  698. DEF_ENDLIST
  699. DEF_METHOD
  700. public int getStyle()
  701. //    Gets the style of the font.
  702. //   
  703. //      See Also:
  704. //      isPlain, isBold, isItalic
  705. //   
  706. // 
  707. DEF_ENDLIST
  708. DEF_METHOD
  709. public int getSize()
  710. //    Gets the point size of the font.
  711. // 
  712. DEF_ENDLIST
  713. DEF_METHOD
  714. public boolean isPlain()
  715. //    Returns true if the font is plain.
  716. //   
  717. //      See Also:
  718. //      getStyle
  719. //   
  720. // 
  721. DEF_ENDLIST
  722. DEF_METHOD
  723. public boolean isBold()
  724. //    Returns true if the font is bold.
  725. //   
  726. //      See Also:
  727. //      getStyle
  728. //   
  729. // 
  730. DEF_ENDLIST
  731. DEF_METHOD
  732. public boolean isItalic()
  733. //    Returns true if the font is italic.
  734. //   
  735. //      See Also:
  736. //      getStyle
  737. //   
  738. // 
  739. DEF_ENDLIST
  740. DEF_METHOD
  741. public static Font getFont(String nm)
  742. //    Gets a font from the system properties list.
  743. //   
  744. //      Parameters:
  745. //      nm - the property name
  746. //   
  747. // 
  748. DEF_ENDLIST
  749. DEF_METHOD
  750. public static Font getFont(String nm,
  751.                            Font font)
  752. //    Gets the specified font from the system properties list.
  753. //   
  754. //      Parameters:
  755. //      nm - the property name
  756. //      font - a default font to return if property 'nm' is not defined
  757. //   
  758. // 
  759. DEF_ENDLIST
  760. DEF_METHOD
  761. public int hashCode()
  762. //    Returns a hashcode for this font.
  763. //   
  764. //      Overrides:
  765. //      hashCode in class Object
  766. //   
  767. // 
  768. DEF_ENDLIST
  769. DEF_METHOD
  770. public boolean equals(Object obj)
  771. //    Compares this object to the specifed object.
  772. //   
  773. //      Parameters:
  774. //      obj - the object to compare with
  775. //      Returns:
  776. //      true if the objects are the same; false otherwise.
  777. //      Overrides:
  778. //      equals in class Object
  779. //   
  780. // 
  781. DEF_ENDLIST
  782. DEF_METHOD
  783. public String toString()
  784. //    Converts this object to a String representation.
  785. //   
  786. //      Overrides:
  787. //      toString in class Object
  788. //   
  789. // 
  790. DEF_ENDLIST
  791. DEF_ENDCOMPONENT
  792. DEF_COMPONENTNAME
  793. FontMetrics
  794. DEF_SUPERCLASS
  795. Object
  796. DEF_SUPERCOMPONENT
  797.  
  798. DEF_PACKAGE
  799. java
  800. awt
  801. DEF_ENDLIST
  802. DEF_SUBCOMPONENTLIST
  803. DEF_ENDLIST
  804. DEF_SUBCOMPONENTCLASSLIST
  805. DEF_ENDLIST
  806. DEF_CATEGORY
  807.  
  808. DEF_BITMAP
  809.  
  810. DEF_THUMBNAIL_UP
  811.  
  812. DEF_THUMBNAIL_DOWN
  813.  
  814. DEF_BASE
  815. DEF_IMPORTS
  816. DEF_ENDLIST
  817. DEF_REQUIRES
  818. DEF_ENDLIST
  819. DEF_IMPLEMENTS
  820. DEF_ENDLIST
  821. DEF_DECLARATION
  822. // A font metrics object. Note that the implementations of these
  823. // methods are inefficient, they are usually overridden with more
  824. // efficient toolkit specific implementations.
  825. DEF_ENDLIST
  826. DEF_METHOD
  827. protected FontMetrics(Font font)
  828. //    Creates a new FontMetrics object with the specified font.
  829. //   
  830. //      Parameters:
  831. //      font - the font
  832. //      See Also:
  833. //      Font
  834. //   
  835. // 
  836. DEF_ENDLIST
  837. DEF_METHOD
  838. public Font getFont()
  839. //    Gets the font.
  840. // 
  841. DEF_ENDLIST
  842. DEF_METHOD
  843. public int getLeading()
  844. //    Gets the standard leading, or line spacing, for the font.  
  845. // This is the logical amount of space to be reserved between the
  846. // descent of one line of text and the ascent of the next line.
  847. // The height metric is calculated to include this extra space.
  848. // 
  849. DEF_ENDLIST
  850. DEF_METHOD
  851. public int getAscent()
  852. //    Gets the font ascent. The font ascent is the distance from the 
  853. // base line to the top of the characters.
  854. //   
  855. //      See Also:
  856. //      getMaxAscent
  857. //   
  858. // 
  859. DEF_ENDLIST
  860. DEF_METHOD
  861. public int getDescent()
  862. //    Gets the font descent. The font descent is the distance from the 
  863. // base line to the bottom of the characters.
  864. //   
  865. //      See Also:
  866. //      getMaxDescent
  867. //   
  868. // 
  869. DEF_ENDLIST
  870. DEF_METHOD
  871. public int getHeight()
  872. //    Gets the total height of the font.  This is the distance between
  873. // the baseline of adjacent lines of text.  It is the sum of the
  874. // leading + ascent + descent.
  875. // 
  876. DEF_ENDLIST
  877. DEF_METHOD
  878. public int getMaxAscent()
  879. //    Gets the maximum ascent of all characters in this Font.
  880. // No character will extend further above the baseline than this 
  881. // metric.
  882. //   
  883. //      See Also:
  884. //      getAscent
  885. //   
  886. // 
  887. DEF_ENDLIST
  888. DEF_METHOD
  889. public int getMaxDescent()
  890. //    Gets the maximum descent of all characters.  
  891. // No character will descend futher below the baseline than this
  892. // metric.
  893. //   
  894. //      See Also:
  895. //      getDescent
  896. //   
  897. // 
  898. DEF_ENDLIST
  899. DEF_METHOD
  900. public int getMaxDecent()
  901. //    For backward compatibility only.
  902. //   
  903. //      See Also:
  904. //      getMaxDescent
  905. //   
  906. // 
  907. DEF_ENDLIST
  908. DEF_METHOD
  909. public int getMaxAdvance()
  910. //    Gets the maximum advance width of any character in this Font.
  911. //   
  912. //      Returns:
  913. //      -1 if the max advance is not known.
  914. //   
  915. // 
  916. DEF_ENDLIST
  917. DEF_METHOD
  918. public int charWidth(int ch)
  919. //    Returns the width of the specified character in this Font.
  920. //   
  921. //      Parameters:
  922. //      ch - the specified font
  923. //      See Also:
  924. //      stringWidth
  925. //   
  926. // 
  927. DEF_ENDLIST
  928. DEF_METHOD
  929. public int charWidth(char ch)
  930. //    Returns the width of the specified character in this Font.
  931. //   
  932. //      Parameters:
  933. //      ch - the specified font
  934. //      See Also:
  935. //      stringWidth
  936. //   
  937. // 
  938. DEF_ENDLIST
  939. DEF_METHOD
  940. public int stringWidth(String str)
  941. //    Returns the width of the specified String in this Font.
  942. //   
  943. //      Parameters:
  944. //      str - the String to be checked
  945. //      See Also:
  946. //      charsWidth, bytesWidth
  947. //   
  948. // 
  949. DEF_ENDLIST
  950. DEF_METHOD
  951. public int charsWidth(char data[],
  952.                       int off,
  953.                       int len)
  954. //    Returns the width of the specified character array in this Font.
  955. //   
  956. //      Parameters:
  957. //      data - the data to be checked
  958. //      off - the start offset of the data
  959. //      len - the maximum number of bytes checked
  960. //      See Also:
  961. //      stringWidth, bytesWidth
  962. //   
  963. // 
  964. DEF_ENDLIST
  965. DEF_METHOD
  966. public int bytesWidth(byte data[],
  967.                       int off,
  968.                       int len)
  969. //    Returns the width of the specified array of bytes in this Font.
  970. //   
  971. //      Parameters:
  972. //      data - the data to be checked
  973. //      off - the start offset of the data
  974. //      len - the maximum number of bytes checked
  975. //      See Also:
  976. //      stringWidth, charsWidth
  977. //   
  978. // 
  979. DEF_ENDLIST
  980. DEF_METHOD
  981. public int[] getWidths()
  982. //    Gets the widths of the first 256 characters in the Font.
  983. // 
  984. DEF_ENDLIST
  985. DEF_METHOD
  986. public String toString()
  987. //    Returns the String representation of this FontMetric's values.
  988. //   
  989. //      Overrides:
  990. //      toString in class Object
  991. //   
  992. // 
  993. DEF_ENDLIST
  994. DEF_ENDCOMPONENT
  995. DEF_COMPONENTNAME
  996. Frame
  997. DEF_SUPERCLASS
  998. Window
  999. DEF_SUPERCOMPONENT
  1000.  
  1001. DEF_PACKAGE
  1002. java
  1003. awt
  1004. DEF_ENDLIST
  1005. DEF_SUBCOMPONENTLIST
  1006. DEF_ENDLIST
  1007. DEF_SUBCOMPONENTCLASSLIST
  1008. DEF_ENDLIST
  1009. DEF_CATEGORY
  1010.  
  1011. DEF_BITMAP
  1012.  
  1013. DEF_THUMBNAIL_UP
  1014.  
  1015. DEF_THUMBNAIL_DOWN
  1016.  
  1017. DEF_BASE
  1018. DEF_IMPORTS
  1019. DEF_ENDLIST
  1020. DEF_REQUIRES
  1021. DEF_ENDLIST
  1022. DEF_IMPLEMENTS
  1023. MenuContainer
  1024. DEF_ENDLIST
  1025. DEF_DECLARATION
  1026. // A Frame is a top-level window with a title.
  1027. // The default layout for a frame is BorderLayout.
  1028. DEF_ENDLIST
  1029. DEF_METHOD
  1030. public synchronized void addNotify()
  1031. //    Creates the Frame's peer.  The peer allows us to change the look
  1032. // of the Frame without changing its functionality.
  1033. //   
  1034. //      Overrides:
  1035. //      addNotify in class Window
  1036. //   
  1037. // 
  1038. DEF_ENDLIST
  1039. DEF_METHOD
  1040. public String getTitle()
  1041. //    Gets the title of the Frame.
  1042. //   
  1043. //      See Also:
  1044. //      setTitle
  1045. //   
  1046. // 
  1047. DEF_ENDLIST
  1048. DEF_METHOD
  1049. public void setTitle(String title)
  1050. //    Sets the title for this Frame to the specified title.
  1051. //   
  1052. //      Parameters:
  1053. //      title - the specified title of this Frame
  1054. //      See Also:
  1055. //      getTitle
  1056. //   
  1057. // 
  1058. DEF_ENDLIST
  1059. DEF_METHOD
  1060. public Image getIconImage()
  1061. //    Returns the icon image for this Frame.
  1062. // 
  1063. DEF_ENDLIST
  1064. DEF_METHOD
  1065. public void setIconImage(Image image)
  1066. //    Sets the image to display when this Frame is iconized. Note that
  1067. // not all platforms support the concept of iconizing a window.
  1068. //   
  1069. //      Parameters:
  1070. //      image - the icon image to be displayed
  1071. //   
  1072. // 
  1073. DEF_ENDLIST
  1074. DEF_METHOD
  1075. public MenuBar getMenuBar()
  1076. //    Gets the menu bar for this Frame.
  1077. // 
  1078. DEF_ENDLIST
  1079. DEF_METHOD
  1080. public synchronized void setMenuBar(MenuBar mb)
  1081. //    Sets the menubar for this Frame to the specified menubar.
  1082. //   
  1083. //      Parameters:
  1084. //      mb - the menubar being set
  1085. //   
  1086. // 
  1087. DEF_ENDLIST
  1088. DEF_METHOD
  1089. public synchronized void remove(MenuComponent m)
  1090. //    Removes the specified menu bar from this Frame.
  1091. // 
  1092. DEF_ENDLIST
  1093. DEF_METHOD
  1094. public synchronized void dispose()
  1095. //    Disposes of the Frame. This method must
  1096. // be called to release the resources that
  1097. // are used for the frame.
  1098. //   
  1099. //      Overrides:
  1100. //      dispose in class Window
  1101. //   
  1102. // 
  1103. DEF_ENDLIST
  1104. DEF_METHOD
  1105. public boolean isResizable()
  1106. //    Returns true if the user can resize the Frame.
  1107. // 
  1108. DEF_ENDLIST
  1109. DEF_METHOD
  1110. public void setResizable(boolean resizable)
  1111. //    Sets the resizable flag.
  1112. //   
  1113. //      Parameters:
  1114. //      resizable - true if resizable; false otherwise.
  1115. //   
  1116. // 
  1117. DEF_ENDLIST
  1118. DEF_METHOD
  1119. public void setCursor(int cursorType)
  1120. //    Set the cursor image to a predefined cursor.
  1121. //   
  1122. //      Parameters:
  1123. //      cursorType - one of the cursor constants defined above.
  1124. //   
  1125. // 
  1126. DEF_ENDLIST
  1127. DEF_METHOD
  1128. public int getCursorType()
  1129. //    Return the cursor type
  1130. // 
  1131. DEF_ENDLIST
  1132. DEF_METHOD
  1133. protected String paramString()
  1134. //    Returns the parameter String of this Frame.
  1135. //   
  1136. //      Overrides:
  1137. //      paramString in class Container
  1138. //   
  1139. // 
  1140. DEF_ENDLIST
  1141. DEF_PROPERTY
  1142. CursorType
  1143. int
  1144. setCursor(AVALUE);
  1145. AVALUE = getCursorType();
  1146. Frame.DEFAULT_CURSOR
  1147. DEF_ENDLIST
  1148. DEF_PROPERTY
  1149. IconImage
  1150. Image
  1151. setIconImage(AVALUE);
  1152. AVALUE = getIconImage();
  1153. null
  1154. DEF_ENDLIST
  1155. DEF_PROPERTY
  1156. Title
  1157. String
  1158. setTitle(AVALUE);
  1159. AVALUE = getTitle();
  1160. ""
  1161. DEF_ENDLIST
  1162. DEF_PROPERTY
  1163. Resizable
  1164. boolean
  1165. setResizable(AVALUE);
  1166. AVALUE = isResizable();
  1167. false
  1168. DEF_ENDLIST
  1169. DEF_ENDCOMPONENT
  1170. DEF_COMPONENTNAME
  1171. Graphics
  1172. DEF_SUPERCLASS
  1173. Object
  1174. DEF_SUPERCOMPONENT
  1175.  
  1176. DEF_PACKAGE
  1177. java
  1178. awt
  1179. DEF_ENDLIST
  1180. DEF_SUBCOMPONENTLIST
  1181. DEF_ENDLIST
  1182. DEF_SUBCOMPONENTCLASSLIST
  1183. DEF_ENDLIST
  1184. DEF_CATEGORY
  1185.  
  1186. DEF_BITMAP
  1187.  
  1188. DEF_THUMBNAIL_UP
  1189.  
  1190. DEF_THUMBNAIL_DOWN
  1191.  
  1192. DEF_BASE
  1193. DEF_IMPORTS
  1194. DEF_ENDLIST
  1195. DEF_REQUIRES
  1196. DEF_ENDLIST
  1197. DEF_IMPLEMENTS
  1198. DEF_ENDLIST
  1199. DEF_DECLARATION
  1200. // Graphics is the abstract base class for all graphic 
  1201. // contexts for various devices.
  1202. DEF_ENDLIST
  1203. DEF_METHOD
  1204. protected Graphics()
  1205. //    Constructs a new Graphics Object. Graphic contexts cannot be 
  1206. // created directly. They must be obtained from another graphics
  1207. // context or created by a Component.
  1208. //   
  1209. //      See Also:
  1210. //      getGraphics, create
  1211. //   
  1212. // 
  1213. DEF_ENDLIST
  1214. DEF_METHOD
  1215. public abstract Graphics create()
  1216. //    Creates a new Graphics Object that is a copy of the original Graphics Object.
  1217. // 
  1218. DEF_ENDLIST
  1219. DEF_METHOD
  1220. public Graphics create(int x,
  1221.                        int y,
  1222.                        int width,
  1223.                        int height)
  1224. //    Creates a new Graphics Object with the specified parameters, based on the original
  1225. // Graphics Object. 
  1226. // This method translates the specified parameters, x and y, to
  1227. // the proper origin coordinates and then clips the Graphics Object to the
  1228. // area.
  1229. //   
  1230. //      Parameters:
  1231. //      x - the x coordinate
  1232. //      y - the y coordinate
  1233. //      width - the width of the area
  1234. //      height - the height of the area
  1235. //      See Also:
  1236. //      translate
  1237. //   
  1238. // 
  1239. DEF_ENDLIST
  1240. DEF_METHOD
  1241. public abstract void translate(int x,
  1242.                                int y)
  1243. //    Translates the specified parameters into the origin of the graphics context. All subsequent
  1244. // operations on this graphics context will be relative to this origin.
  1245. //   
  1246. //      Parameters:
  1247. //      x - the x coordinate
  1248. //      y - the y coordinate
  1249. //   
  1250. // 
  1251. DEF_ENDLIST
  1252. DEF_METHOD
  1253. public abstract Color getColor()
  1254. //    Gets the current color.
  1255. //   
  1256. //      See Also:
  1257. //      setColor
  1258. //   
  1259. // 
  1260. DEF_ENDLIST
  1261. DEF_METHOD
  1262. public abstract void setColor(Color c)
  1263. //    Sets the current color to the specified color. All subsequent graphics operations
  1264. // will use this specified color.
  1265. //   
  1266. //      Parameters:
  1267. //      c - the color to be set
  1268. //      See Also:
  1269. //      Color, getColor
  1270. //   
  1271. // 
  1272. DEF_ENDLIST
  1273. DEF_METHOD
  1274. public abstract void setPaintMode()
  1275. //    Sets the paint mode to overwrite the destination with the
  1276. // current color.
  1277. // 
  1278. DEF_ENDLIST
  1279. DEF_METHOD
  1280. public abstract void setXORMode(Color c1)
  1281. //    Sets the paint mode to alternate between the current color
  1282. // and the new specified color.  When drawing operations are
  1283. // performed, pixels which are the current color will be changed
  1284. // to the specified color and vice versa.  Pixels of colors other
  1285. // than those two colors will be changed in an unpredictable, but
  1286. // reversible manner - if you draw the same figure twice then all
  1287. // pixels will be restored to their original values.
  1288. //   
  1289. //      Parameters:
  1290. //      c1 - the second color
  1291. //   
  1292. // 
  1293. DEF_ENDLIST
  1294. DEF_METHOD
  1295. public abstract Font getFont()
  1296. //    Gets the current font.
  1297. //   
  1298. //      See Also:
  1299. //      setFont
  1300. //   
  1301. // 
  1302. DEF_ENDLIST
  1303. DEF_METHOD
  1304. public abstract void setFont(Font font)
  1305. //    Sets the font for all subsequent text-drawing operations.
  1306. //   
  1307. //      Parameters:
  1308. //      font - the specified font
  1309. //      See Also:
  1310. //      Font, getFont, drawString, drawBytes, drawChars
  1311. //   
  1312. // 
  1313. DEF_ENDLIST
  1314. DEF_METHOD
  1315. public FontMetrics getFontMetrics()
  1316. //    Gets the current font metrics.
  1317. //   
  1318. //      See Also:
  1319. //      getFont
  1320. //   
  1321. // 
  1322. DEF_ENDLIST
  1323. DEF_METHOD
  1324. public abstract FontMetrics getFontMetrics(Font f)
  1325. //    Gets the current font metrics for the specified font.
  1326. //   
  1327. //      Parameters:
  1328. //      f - the specified font
  1329. //      See Also:
  1330. //      getFont, getFontMetrics
  1331. //   
  1332. // 
  1333. DEF_ENDLIST
  1334. DEF_METHOD
  1335. public abstract Rectangle getClipRect()
  1336. //    Returns the bounding rectangle of the current clipping area.
  1337. //   
  1338. //      See Also:
  1339. //      clipRect
  1340. //   
  1341. // 
  1342. DEF_ENDLIST
  1343. DEF_METHOD
  1344. public abstract void clipRect(int x,
  1345.                               int y,
  1346.                               int width,
  1347.                               int height)
  1348. //    Clips to a rectangle. The resulting clipping area is the
  1349. // intersection of the current clipping area and the specified
  1350. // rectangle. Graphic operations have no effect outside of the
  1351. // clipping area.
  1352. //   
  1353. //      Parameters:
  1354. //      x - the x coordinate
  1355. //      y - the y coordinate
  1356. //      width - the width of the rectangle
  1357. //      height - the height of the rectangle
  1358. //      See Also:
  1359. //      getClipRect
  1360. //   
  1361. // 
  1362. DEF_ENDLIST
  1363. DEF_METHOD
  1364. public abstract void copyArea(int x,
  1365.                               int y,
  1366.                               int width,
  1367.                               int height,
  1368.                               int dx,
  1369.                               int dy)
  1370. //    Copies an area of the screen.
  1371. //   
  1372. //      Parameters:
  1373. //      x - the x-coordinate of the source
  1374. //      y - the y-coordinate of the source
  1375. //      width - the width
  1376. //      height - the height
  1377. //      dx - the horizontal distance
  1378. //      dy - the vertical distance
  1379. //   
  1380. // 
  1381. DEF_ENDLIST
  1382. DEF_METHOD
  1383. public abstract void drawLine(int x1,
  1384.                               int y1,
  1385.                               int x2,
  1386.                               int y2)
  1387. //    Draws a line between the coordinates (x1,y1) and (x2,y2). The line is drawn
  1388. // below and to the left of the logical coordinates.
  1389. //   
  1390. //      Parameters:
  1391. //      x1 - the first point's x coordinate
  1392. //      y1 - the first point's y coordinate
  1393. //      x2 - the second point's x coordinate
  1394. //      y2 - the second point's y coordinate
  1395. //   
  1396. // 
  1397. DEF_ENDLIST
  1398. DEF_METHOD
  1399. public abstract void fillRect(int x,
  1400.                               int y,
  1401.                               int width,
  1402.                               int height)
  1403. //    Fills the specified rectangle with the current color.
  1404. //   
  1405. //      Parameters:
  1406. //      x - the x coordinate
  1407. //      y - the y coordinate
  1408. //      width - the width of the rectangle
  1409. //      height - the height of the rectangle
  1410. //      See Also:
  1411. //      drawRect, clearRect
  1412. //   
  1413. // 
  1414. DEF_ENDLIST
  1415. DEF_METHOD
  1416. public void drawRect(int x,
  1417.                      int y,
  1418.                      int width,
  1419.                      int height)
  1420. //    Draws the outline of the specified rectangle using the current color.
  1421. // Use drawRect(x, y, width-1, height-1) to draw the outline inside the specified
  1422. // rectangle.
  1423. //   
  1424. //      Parameters:
  1425. //      x - the x coordinate
  1426. //      y - the y coordinate
  1427. //      width - the width of the rectangle
  1428. //      height - the height of the rectangle
  1429. //      See Also:
  1430. //      fillRect, clearRect
  1431. //   
  1432. // 
  1433. DEF_ENDLIST
  1434. DEF_METHOD
  1435. public abstract void clearRect(int x,
  1436.                                int y,
  1437.                                int width,
  1438.                                int height)
  1439. //    Clears the specified rectangle by filling it with the current background color
  1440. // of the current drawing surface.
  1441. // Which drawing surface it selects depends on how the graphics context
  1442. // was created.
  1443. //   
  1444. //      Parameters:
  1445. //      x - the x coordinate
  1446. //      y - the y coordinate
  1447. //      width - the width of the rectangle
  1448. //      height - the height of the rectangle
  1449. //      See Also:
  1450. //      fillRect, drawRect
  1451. //   
  1452. // 
  1453. DEF_ENDLIST
  1454. DEF_METHOD
  1455. public abstract void drawRoundRect(int x,
  1456.                                    int y,
  1457.                                    int width,
  1458.                                    int height,
  1459.                                    int arcWidth,
  1460.                                    int arcHeight)
  1461. //    Draws an outlined rounded corner rectangle using the current color.
  1462. //   
  1463. //      Parameters:
  1464. //      x - the x coordinate
  1465. //      y - the y coordinate
  1466. //      width - the width of the rectangle
  1467. //      height - the height of the rectangle
  1468. //      arcWidth - the horizontal diameter of the arc at the four corners
  1469. //      arcHeight - the horizontal diameter of the arc at the four corners
  1470. //      See Also:
  1471. //      fillRoundRect
  1472. //   
  1473. // 
  1474. DEF_ENDLIST
  1475. DEF_METHOD
  1476. public abstract void fillRoundRect(int x,
  1477.                                    int y,
  1478.                                    int width,
  1479.                                    int height,
  1480.                                    int arcWidth,
  1481.                                    int arcHeight)
  1482. //    Draws a rounded rectangle filled in with the current color.
  1483. //   
  1484. //      Parameters:
  1485. //      x - the x coordinate
  1486. //      y - the y coordinate
  1487. //      width - the width of the rectangle
  1488. //      height - the height of the rectangle
  1489. //      arcWidth - the horizontal diameter of the arc at the four corners
  1490. //      arcHeight - the horizontal diameter of the arc at the four corners
  1491. //      See Also:
  1492. //      drawRoundRect
  1493. //   
  1494. // 
  1495. DEF_ENDLIST
  1496. DEF_METHOD
  1497. public void draw3DRect(int x,
  1498.                        int y,
  1499.                        int width,
  1500.                        int height,
  1501.                        boolean raised)
  1502. //    Draws a highlighted 3-D rectangle.
  1503. //   
  1504. //      Parameters:
  1505. //      x - the x coordinate
  1506. //      y - the y coordinate
  1507. //      width - the width of the rectangle
  1508. //      height - the height of the rectangle
  1509. //      raised - a boolean that states whether the rectangle is raised or not
  1510. //   
  1511. // 
  1512. DEF_ENDLIST
  1513. DEF_METHOD
  1514. public void fill3DRect(int x,
  1515.                        int y,
  1516.                        int width,
  1517.                        int height,
  1518.                        boolean raised)
  1519. //    Paints a highlighted 3-D rectangle using the current color.
  1520. //   
  1521. //      Parameters:
  1522. //      x - the x coordinate
  1523. //      y - the y coordinate
  1524. //      width - the width of the rectangle
  1525. //      height - the height of the rectangle
  1526. //      raised - a boolean that states whether the rectangle is raised or not
  1527. //   
  1528. // 
  1529. DEF_ENDLIST
  1530. DEF_METHOD
  1531. public abstract void drawOval(int x,
  1532.                               int y,
  1533.                               int width,
  1534.                               int height)
  1535. //    Draws an oval inside the specified rectangle using the current color.
  1536. //   
  1537. //      Parameters:
  1538. //      x - the x coordinate
  1539. //      y - the y coordinate
  1540. //      width - the width of the rectangle
  1541. //      height - the height of the rectangle
  1542. //      See Also:
  1543. //      fillOval
  1544. //   
  1545. // 
  1546. DEF_ENDLIST
  1547. DEF_METHOD
  1548. public abstract void fillOval(int x,
  1549.                               int y,
  1550.                               int width,
  1551.                               int height)
  1552. //    Fills an oval inside the specified rectangle using the current color.
  1553. //   
  1554. //      Parameters:
  1555. //      x - the x coordinate
  1556. //      y - the y coordinate
  1557. //      width - the width of the rectangle
  1558. //      height - the height of the rectangle
  1559. //      See Also:
  1560. //      drawOval
  1561. //   
  1562. // 
  1563. DEF_ENDLIST
  1564. DEF_METHOD
  1565. public abstract void drawArc(int x,
  1566.                              int y,
  1567.                              int width,
  1568.                              int height,
  1569.                              int startAngle,
  1570.                              int arcAngle)
  1571. //    Draws an arc bounded by the specified rectangle from startAngle to
  1572. // endAngle. 0 degrees is at the 3-o'clock position.Positive arc
  1573. // angles indicate counter-clockwise rotations, negative arc angles are
  1574. // drawn clockwise.
  1575. //   
  1576. //      Parameters:
  1577. //      x - the x coordinate
  1578. //      y - the y coordinate
  1579. //      width - the width of the rectangle
  1580. //      height - the height of the rectangle
  1581. //      startAngle - the beginning angle
  1582. //      arcAngle - the angle of the arc (relative to startAngle).
  1583. //      See Also:
  1584. //      fillArc
  1585. //   
  1586. // 
  1587. DEF_ENDLIST
  1588. DEF_METHOD
  1589. public abstract void fillArc(int x,
  1590.                              int y,
  1591.                              int width,
  1592.                              int height,
  1593.                              int startAngle,
  1594.                              int arcAngle)
  1595. //    Fills an arc using the current color. This generates a pie shape.
  1596. //   
  1597. //      Parameters:
  1598. //      x - the x coordinate
  1599. //      y - the y coordinate
  1600. //      width - the width of the arc
  1601. //      height - the height of the arc
  1602. //      startAngle - the beginning angle
  1603. //      arcAngle - the angle of the arc (relative to startAngle).
  1604. //      See Also:
  1605. //      drawArc
  1606. //   
  1607. // 
  1608. DEF_ENDLIST
  1609. DEF_METHOD
  1610. public abstract void drawPolygon(int xPoints[],
  1611.                                  int yPoints[],
  1612.                                  int nPoints)
  1613. //    Draws a polygon defined by an array of x points and y points.
  1614. //   
  1615. //      Parameters:
  1616. //      xPoints - an array of x points
  1617. //      yPoints - an array of y points
  1618. //      nPoints - the total number of points
  1619. //      See Also:
  1620. //      fillPolygon
  1621. //   
  1622. // 
  1623. DEF_ENDLIST
  1624. DEF_METHOD
  1625. public void drawPolygon(Polygon p)
  1626. //    Draws a polygon defined by the specified point.
  1627. //   
  1628. //      Parameters:
  1629. //      p - the specified polygon
  1630. //      See Also:
  1631. //      fillPolygon
  1632. //   
  1633. // 
  1634. DEF_ENDLIST
  1635. DEF_METHOD
  1636. public abstract void fillPolygon(int xPoints[],
  1637.                                  int yPoints[],
  1638.                                  int nPoints)
  1639. //    Fills a polygon with the current color using an
  1640. // even-odd fill rule (otherwise known as an alternating rule).
  1641. //   
  1642. //      Parameters:
  1643. //      xPoints - an array of x points
  1644. //      yPoints - an array of y points
  1645. //      nPoints - the total number of points
  1646. //      See Also:
  1647. //      drawPolygon
  1648. //   
  1649. // 
  1650. DEF_ENDLIST
  1651. DEF_METHOD
  1652. public void fillPolygon(Polygon p)
  1653. //    Fills the specified polygon with the current color using an
  1654. // even-odd fill rule (otherwise known as an alternating rule).
  1655. //   
  1656. //      Parameters:
  1657. //      p - the polygon
  1658. //      See Also:
  1659. //      drawPolygon
  1660. //   
  1661. // 
  1662. DEF_ENDLIST
  1663. DEF_METHOD
  1664. public abstract void drawString(String str,
  1665.                                 int x,
  1666.                                 int y)
  1667. //    Draws the specified String using the current font and color.
  1668. // The x,y position is the starting point of the baseline of the String.
  1669. //   
  1670. //      Parameters:
  1671. //      str - the String to be drawn
  1672. //      x - the x coordinate
  1673. //      y - the y coordinate
  1674. //      See Also:
  1675. //      drawChars, drawBytes
  1676. //   
  1677. // 
  1678. DEF_ENDLIST
  1679. DEF_METHOD
  1680. public void drawChars(char data[],
  1681.                       int offset,
  1682.                       int length,
  1683.                       int x,
  1684.                       int y)
  1685. //    Draws the specified characters using the current font and color.
  1686. //   
  1687. //      Parameters:
  1688. //      data - the array of characters to be drawn
  1689. //      offset - the start offset in the data
  1690. //      length - the number of characters to be drawn
  1691. //      x - the x coordinate
  1692. //      y - the y coordinate
  1693. //      See Also:
  1694. //      drawString, drawBytes
  1695. //   
  1696. // 
  1697. DEF_ENDLIST
  1698. DEF_METHOD
  1699. public void drawBytes(byte data[],
  1700.                       int offset,
  1701.                       int length,
  1702.                       int x,
  1703.                       int y)
  1704. //    Draws the specified bytes using the current font and color.
  1705. //   
  1706. //      Parameters:
  1707. //      data - the data to be drawn
  1708. //      offset - the start offset in the data
  1709. //      length - the number of bytes that are drawn
  1710. //      x - the x coordinate
  1711. //      y - the y coordinate
  1712. //      See Also:
  1713. //      drawString, drawChars
  1714. //   
  1715. // 
  1716. DEF_ENDLIST
  1717. DEF_METHOD
  1718. public abstract boolean drawImage(Image img,
  1719.                                   int x,
  1720.                                   int y,
  1721.                                   ImageObserver observer)
  1722. //    Draws the specified image at the specified coordinate (x, y). If the image is 
  1723. // incomplete the image observer will be notified later.
  1724. //   
  1725. //      Parameters:
  1726. //      img - the specified image to be drawn
  1727. //      x - the x coordinate
  1728. //      y - the y coordinate
  1729. //      observer - notifies if the image is complete or not
  1730. //      See Also:
  1731. //      Image, ImageObserver
  1732. //   
  1733. // 
  1734. DEF_ENDLIST
  1735. DEF_METHOD
  1736. public abstract boolean drawImage(Image img,
  1737.                                   int x,
  1738.                                   int y,
  1739.                                   int width,
  1740.                                   int height,
  1741.                                   ImageObserver observer)
  1742. //    Draws the specified image inside the specified rectangle. The image is
  1743. // scaled if necessary. If the image is incomplete the image observer will be
  1744. // notified later.
  1745. //   
  1746. //      Parameters:
  1747. //      img - the specified image to be drawn
  1748. //      x - the x coordinate
  1749. //      y - the y coordinate
  1750. //      width - the width of the rectangle
  1751. //      height - the height of the rectangle
  1752. //      observer - notifies if the image is complete or not
  1753. //      See Also:
  1754. //      Image, ImageObserver
  1755. //   
  1756. // 
  1757. DEF_ENDLIST
  1758. DEF_METHOD
  1759. public abstract boolean drawImage(Image img,
  1760.                                   int x,
  1761.                                   int y,
  1762.                                   Color bgcolor,
  1763.                                   ImageObserver observer)
  1764. //    Draws the specified image at the specified coordinate (x, y),
  1765. // with the given solid background Color.  If the image is 
  1766. // incomplete the image observer will be notified later.
  1767. //   
  1768. //      Parameters:
  1769. //      img - the specified image to be drawn
  1770. //      x - the x coordinate
  1771. //      y - the y coordinate
  1772. //      observer - notifies if the image is complete or not
  1773. //      See Also:
  1774. //      Image, ImageObserver
  1775. //   
  1776. // 
  1777. DEF_ENDLIST
  1778. DEF_METHOD
  1779. public abstract boolean drawImage(Image img,
  1780.                                   int x,
  1781.                                   int y,
  1782.                                   int width,
  1783.                                   int height,
  1784.                                   Color bgcolor,
  1785.                                   ImageObserver observer)
  1786. //    Draws the specified image inside the specified rectangle,
  1787. // with the given solid background Color. The image is
  1788. // scaled if necessary. If the image is incomplete the image
  1789. // observer will be notified later.
  1790. //   
  1791. //      Parameters:
  1792. //      img - the specified image to be drawn
  1793. //      x - the x coordinate
  1794. //      y - the y coordinate
  1795. //      width - the width of the rectangle
  1796. //      height - the height of the rectangle
  1797. //      observer - notifies if the image is complete or not
  1798. //      See Also:
  1799. //      Image, ImageObserver
  1800. //   
  1801. // 
  1802. DEF_ENDLIST
  1803. DEF_METHOD
  1804. public abstract void dispose()
  1805. //    Disposes of this graphics context.  The Graphics context cannot be used after 
  1806. // being disposed of.
  1807. //   
  1808. //      See Also:
  1809. //      finalize
  1810. //   
  1811. // 
  1812. DEF_ENDLIST
  1813. DEF_METHOD
  1814. public void finalize()
  1815. //    Disposes of this graphics context once it is no longer referenced.
  1816. //   
  1817. //      Overrides:
  1818. //      finalize in class Object
  1819. //      See Also:
  1820. //      dispose
  1821. //   
  1822. // 
  1823. DEF_ENDLIST
  1824. DEF_METHOD
  1825. public String toString()
  1826. //    Returns a String object representing this Graphic's value.
  1827. //   
  1828. //      Overrides:
  1829. //      toString in class Object
  1830. //   
  1831. // 
  1832. DEF_ENDLIST
  1833. DEF_ENDCOMPONENT
  1834. DEF_COMPONENTNAME
  1835. GridBagConstraints
  1836. DEF_SUPERCLASS
  1837. Object
  1838. DEF_SUPERCOMPONENT
  1839.  
  1840. DEF_PACKAGE
  1841. java
  1842. awt
  1843. DEF_ENDLIST
  1844. DEF_SUBCOMPONENTLIST
  1845. DEF_ENDLIST
  1846. DEF_SUBCOMPONENTCLASSLIST
  1847. DEF_ENDLIST
  1848. DEF_CATEGORY
  1849.  
  1850. DEF_BITMAP
  1851.  
  1852. DEF_THUMBNAIL_UP
  1853.  
  1854. DEF_THUMBNAIL_DOWN
  1855.  
  1856. DEF_BASE
  1857. DEF_IMPORTS
  1858. DEF_ENDLIST
  1859. DEF_REQUIRES
  1860. DEF_ENDLIST
  1861. DEF_IMPLEMENTS
  1862. Cloneable
  1863. DEF_ENDLIST
  1864. DEF_DECLARATION
  1865. // GridBagConstraints is used to specify constraints for components
  1866. // laid out using the GridBagLayout class.
  1867. // 
  1868. //      See Also:
  1869. //      GridBagLayout
  1870. // 
  1871. DEF_ENDLIST
  1872. DEF_ENDCOMPONENT
  1873. DEF_COMPONENTNAME
  1874. GridBagLayout
  1875. DEF_SUPERCLASS
  1876. Object
  1877. DEF_SUPERCOMPONENT
  1878.  
  1879. DEF_PACKAGE
  1880. java
  1881. awt
  1882. DEF_ENDLIST
  1883. DEF_SUBCOMPONENTLIST
  1884. DEF_ENDLIST
  1885. DEF_SUBCOMPONENTCLASSLIST
  1886. DEF_ENDLIST
  1887. DEF_CATEGORY
  1888.  
  1889. DEF_BITMAP
  1890.  
  1891. DEF_THUMBNAIL_UP
  1892.  
  1893. DEF_THUMBNAIL_DOWN
  1894.  
  1895. DEF_BASE
  1896. DEF_IMPORTS
  1897. DEF_ENDLIST
  1898. DEF_REQUIRES
  1899. DEF_ENDLIST
  1900. DEF_IMPLEMENTS
  1901. LayoutManager
  1902. DEF_ENDLIST
  1903. DEF_DECLARATION
  1904. // GridBagLayout is a flexible layout manager
  1905. //     that aligns components vertically and horizontally,
  1906. //     without requiring that the components be the same size.
  1907. //     Each GridBagLayout uses a rectangular grid of cells,
  1908. //     with each component occupying one or more cells
  1909. //     (called its display area).
  1910. //     Each component managed by a GridBagLayout 
  1911. //     is associated with a
  1912. //     GridBagConstraints instance
  1913. //     that specifies how the component is laid out
  1914. //     within its display area.
  1915. //     How a GridBagLayout places a set of components
  1916. //     depends on each component's GridBagConstraints and minimum size,
  1917. //     as well as the preferred size of the components' container.
  1918. //     
  1919. //     To use a GridBagLayout effectively,
  1920. //     you must customize one or more of its components' GridBagConstraints.
  1921. //     You customize a GridBagConstraints object by setting one or more
  1922. //     of its instance variables:
  1923. //     
  1924. //      gridx,
  1925. //          gridy
  1926. //      Specifies the cell at the upper left of the component's display area,
  1927. //      where the upper-left-most cell has address gridx=0, gridy=0.
  1928. //      Use GridBagConstraints.RELATIVE (the default value)
  1929. //      to specify that the component be placed
  1930. //      just to the right of (for gridx)
  1931. //      or just below (for gridy)
  1932. //      the component that was added to the container
  1933. //      just before this component was added.
  1934. //      gridwidth,
  1935. //          gridheight
  1936. //      Specifies the number of cells in a row (for gridwidth)
  1937. //      or column (for gridheight)
  1938. //      in the component's display area.
  1939. //      The default value is 1.
  1940. //      Use GridBagConstraints.REMAINDER to specify 
  1941. //      that the component be the last one in its row (for gridwidth)
  1942. //      or column (for gridheight).
  1943. //      Use GridBagConstraints.RELATIVE to specify 
  1944. //      that the component be the next to last one
  1945. //      in its row (for gridwidth) or column (for gridheight).
  1946. //      fill
  1947. //      Used when the component's display area
  1948. //         is larger than the component's requested size
  1949. //      to determine whether (and how) to resize the component.
  1950. //      Valid values are
  1951. //           GridBagConstraint.NONE
  1952. //           (the default),
  1953. //           GridBagConstraint.HORIZONTAL
  1954. //           (make the component wide enough to fill its display area
  1955. //           horizontally, but don't change its height),
  1956. //           GridBagConstraint.VERTICAL
  1957. //           (make the component tall enough to fill its display area
  1958. //           vertically, but don't change its width),
  1959. //           and 
  1960. //           GridBagConstraint.BOTH
  1961. //           (make the component fill its display area entirely).
  1962. //      ipadx,
  1963. //          ipady
  1964. //      Specifies the internal padding: 
  1965. //      how much to add to the minimum size of the component.
  1966. //      The width of the component will be at least
  1967. //      its minimum width plus ipadx*2 pixels
  1968. //      (since the padding applies to both sides of the component).
  1969. //      Similarly, the height of the component will be at least
  1970. //      the minimum height plus ipady*2 pixels.
  1971. //      insets
  1972. //      Specifies the external padding of the component --
  1973. //      the minimum amount of space between the component 
  1974. //      and the edges of its display area.
  1975. //      anchor
  1976. //      Used when the component is smaller than its display area
  1977. //      to determine where (within the area) to place the component.
  1978. //      Valid values are
  1979. //      GridBagConstraints.CENTER (the default),
  1980. //      GridBagConstraints.NORTH,
  1981. //      GridBagConstraints.NORTHEAST,
  1982. //      GridBagConstraints.EAST,
  1983. //      GridBagConstraints.SOUTHEAST,
  1984. //      GridBagConstraints.SOUTH,
  1985. //      GridBagConstraints.SOUTHWEST,
  1986. //      GridBagConstraints.WEST, and
  1987. //      GridBagConstraints.NORTHWEST.
  1988. //      weightx,
  1989. //          weighty
  1990. //      Used to determine how to distribute space;
  1991. //      this is important for specifying resizing behavior.
  1992. //      Unless you specify a weight
  1993. //      for at least one component in a row (weightx)
  1994. //      and column (weighty),
  1995. //      all the components clump together in the center of
  1996. //      their container.
  1997. //      This is because when the weight is zero (the default),
  1998. //      the GridBagLayout puts any extra space 
  1999. //      between its grid of cells and the edges of the container.
  2000. //     
  2001. //     The following figure shows ten components (all buttons)
  2002. //     managed by a GridBagLayout:
  2003. //     
  2004. //     
  2005. //     
  2006. //     All the components have fill=GridBagConstraints.BOTH.
  2007. //     In addition, the components have the following non-default constraints:
  2008. //     
  2009. //     Button1, Button2, Button3:
  2010. //         weightx=1.0
  2011. //     Button4:
  2012. //         weightx=1.0,
  2013. //         gridwidth=GridBagConstraints.REMAINDER
  2014. //     Button5:
  2015. //         gridwidth=GridBagConstraints.REMAINDER
  2016. //     Button6:
  2017. //         gridwidth=GridBagConstraints.RELATIVE
  2018. //     Button7:
  2019. //         gridwidth=GridBagConstraints.REMAINDER
  2020. //     Button8:
  2021. //         gridheight=2, weighty=1.0,
  2022. //     Button9, Button 10:
  2023. //         gridwidth=GridBagConstraints.REMAINDER
  2024. //     
  2025. //     Here is the code that implements the example shown above:
  2026. //     
  2027. //     
  2028. // import java.awt.*;
  2029. // import java.util.*;
  2030. // import java.applet.Applet;
  2031. // public class GridBagEx1 extends Applet {
  2032. //     protected void makebutton(String name,
  2033. //                               GridBagLayout gridbag,
  2034. //                               GridBagConstraints c) {
  2035. //         Button button = new Button(name);
  2036. //         gridbag.setConstraints(button, c);
  2037. //         add(button);
  2038. //     }
  2039. //     public void init() {
  2040. //         GridBagLayout gridbag = new GridBagLayout();
  2041. //         GridBagConstraints c = new GridBagConstraints();
  2042. //         setFont(new Font("Helvetica", Font.PLAIN, 14));
  2043. //         setLayout(gridbag);
  2044. //         c.fill = GridBagConstraints.BOTH;
  2045. //         c.weightx = 1.0;
  2046. //         makebutton("Button1", gridbag, c);
  2047. //         makebutton("Button2", gridbag, c);
  2048. //         makebutton("Button3", gridbag, c);
  2049. //     c.gridwidth = GridBagConstraints.REMAINDER; //end row
  2050. //         makebutton("Button4", gridbag, c);
  2051. //         c.weightx = 0.0;           //reset to the default
  2052. //         makebutton("Button5", gridbag, c); //another row
  2053. //     c.gridwidth = GridBagConstraints.RELATIVE; //next-to-last in row
  2054. //         makebutton("Button6", gridbag, c);
  2055. //     c.gridwidth = GridBagConstraints.REMAINDER; //end row
  2056. //         makebutton("Button7", gridbag, c);
  2057. //     c.gridwidth = 1;              //reset to the default
  2058. //     c.gridheight = 2;
  2059. //         c.weighty = 1.0;
  2060. //         makebutton("Button8", gridbag, c);
  2061. //         c.weighty = 0.0;           //reset to the default
  2062. //     c.gridwidth = GridBagConstraints.REMAINDER; //end row
  2063. //     c.gridheight = 1;           //reset to the default
  2064. //         makebutton("Button9", gridbag, c);
  2065. //         makebutton("Button10", gridbag, c);
  2066. //         resize(300, 100);
  2067. //     }
  2068. //     public static void main(String args[]) {
  2069. //     Frame f = new Frame("GridBag Layout Example");
  2070. //     GridBagEx1 ex1 = new GridBagEx1();
  2071. //     ex1.init();
  2072. //     f.add("Center", ex1);
  2073. //     f.pack();
  2074. //     f.resize(f.preferredSize());
  2075. //     f.show();
  2076. //     }
  2077. // }
  2078. //     
  2079. //     
  2080. DEF_ENDLIST
  2081. DEF_METHOD
  2082. public void setConstraints(Component comp,
  2083.                            GridBagConstraints constraints)
  2084. //    Sets the constraints for the specified component.
  2085. //   
  2086. //      Parameters:
  2087. //      comp - the component to be modified
  2088. //      constraints - the constraints to be applied
  2089. //   
  2090. // 
  2091. DEF_ENDLIST
  2092. DEF_METHOD
  2093. public GridBagConstraints getConstraints(Component comp)
  2094. //    Retrieves the constraints for the specified component.  A copy of
  2095. // the constraints is returned.
  2096. //   
  2097. //      Parameters:
  2098. //      comp - the component to be queried
  2099. //   
  2100. // 
  2101. DEF_ENDLIST
  2102. DEF_METHOD
  2103. protected GridBagConstraints lookupConstraints(Component comp)
  2104. //    Retrieves the constraints for the specified component.  The return
  2105. // value is not a copy, but is the actual constraints class used by the
  2106. // layout mechanism.
  2107. //   
  2108. //      Parameters:
  2109. //      comp - the component to be queried
  2110. //   
  2111. // 
  2112. DEF_ENDLIST
  2113. DEF_METHOD
  2114. public Point getLayoutOrigin()
  2115. //    Adds the specified component with the specified name to the layout.
  2116. //   
  2117. //      Parameters:
  2118. //      name - the name of the component
  2119. //      comp - the component to be added
  2120. //   
  2121. // 
  2122. DEF_ENDLIST
  2123. DEF_METHOD
  2124. public void removeLayoutComponent(Component comp)
  2125. //    Removes the specified component from the layout. Does not apply.
  2126. //   
  2127. //      Parameters:
  2128. //      comp - the component to be removed
  2129. //   
  2130. // 
  2131. DEF_ENDLIST
  2132. DEF_METHOD
  2133. public Dimension preferredLayoutSize(Container parent)
  2134. //    Returns the preferred dimensions for this layout given the components
  2135. // in the specified panel.
  2136. //   
  2137. //      Parameters:
  2138. //      parent - the component which needs to be laid out
  2139. //      See Also:
  2140. //      minimumLayoutSize
  2141. //   
  2142. // 
  2143. DEF_ENDLIST
  2144. DEF_METHOD
  2145. public Dimension minimumLayoutSize(Container parent)
  2146. //    Returns the minimum dimensions needed to layout the components 
  2147. // contained in the specified panel.
  2148. //   
  2149. //      Parameters:
  2150. //      parent - the component which needs to be laid out
  2151. //      See Also:
  2152. //      preferredLayoutSize
  2153. //   
  2154. // 
  2155. DEF_ENDLIST
  2156. DEF_METHOD
  2157. public void layoutContainer(Container parent)
  2158. //    Lays out the container in the specified panel.
  2159. //   
  2160. //      Parameters:
  2161. //      parent - the specified component being laid out
  2162. //      See Also:
  2163. //      Container
  2164. //   
  2165. // 
  2166. DEF_ENDLIST
  2167. DEF_METHOD
  2168. public String toString()
  2169. //    Returns the String representation of this GridLayout's values.
  2170. //   
  2171. //      Overrides:
  2172. //      toString in class Object
  2173. //   
  2174. // 
  2175. DEF_ENDLIST
  2176. DEF_METHOD
  2177. protected void DumpLayoutInfo(GridBagLayoutInfo s)
  2178. //    Print the layout information.  Useful for debugging.
  2179. // 
  2180. DEF_ENDLIST
  2181. DEF_METHOD
  2182. protected void DumpConstraints(GridBagConstraints constraints)
  2183. //    Print the layout constraints.  Useful for debugging.
  2184. // 
  2185. DEF_ENDLIST
  2186. DEF_ENDCOMPONENT
  2187. DEF_COMPONENTNAME
  2188. GridLayout
  2189. DEF_SUPERCLASS
  2190. Object
  2191. DEF_SUPERCOMPONENT
  2192.  
  2193. DEF_PACKAGE
  2194. java
  2195. awt
  2196. DEF_ENDLIST
  2197. DEF_SUBCOMPONENTLIST
  2198. DEF_ENDLIST
  2199. DEF_SUBCOMPONENTCLASSLIST
  2200. DEF_ENDLIST
  2201. DEF_CATEGORY
  2202.  
  2203. DEF_BITMAP
  2204.  
  2205. DEF_THUMBNAIL_UP
  2206.  
  2207. DEF_THUMBNAIL_DOWN
  2208.  
  2209. DEF_BASE
  2210. DEF_IMPORTS
  2211. DEF_ENDLIST
  2212. DEF_REQUIRES
  2213. DEF_ENDLIST
  2214. DEF_IMPLEMENTS
  2215. LayoutManager
  2216. DEF_ENDLIST
  2217. DEF_DECLARATION
  2218. // A layout manager for a container that lays out grids.
  2219. DEF_ENDLIST
  2220. DEF_METHOD
  2221. public GridLayout(int rows,
  2222.                   int cols)
  2223. //    Creates a grid layout with the specified rows and columns.
  2224. //   
  2225. //      Parameters:
  2226. //      rows - the rows
  2227. //      cols - the columns
  2228. //   
  2229. // 
  2230. DEF_ENDLIST
  2231. DEF_METHOD
  2232. public GridLayout(int rows,
  2233.                   int cols,
  2234.                   int hgap,
  2235.                   int vgap)
  2236. //    Creates a grid layout with the specified rows, columns,
  2237. // horizontal gap, and vertical gap.
  2238. //   
  2239. //      Parameters:
  2240. //      rows - the rows; zero means 'any number.'
  2241. //      cols - the columns; zero means 'any number.'  Only one of 'rows'
  2242. // and 'cols' can be zero, not both.
  2243. //      hgap - the horizontal gap variable
  2244. //      vgap - the vertical gap variable
  2245. //      Throws: IllegalArgumentException
  2246. //      If the rows and columns are invalid.
  2247. //   
  2248. // 
  2249. DEF_ENDLIST
  2250. DEF_METHOD
  2251. public void addLayoutComponent(String name,
  2252.                                Component comp)
  2253. //    Adds the specified component with the specified name to the layout.
  2254. //   
  2255. //      Parameters:
  2256. //      name - the name of the component
  2257. //      comp - the component to be added
  2258. //   
  2259. // 
  2260. DEF_ENDLIST
  2261. DEF_METHOD
  2262. public void removeLayoutComponent(Component comp)
  2263. //    Removes the specified component from the layout. Does not apply.
  2264. //   
  2265. //      Parameters:
  2266. //      comp - the component to be removed
  2267. //   
  2268. // 
  2269. DEF_ENDLIST
  2270. DEF_METHOD
  2271. public Dimension preferredLayoutSize(Container parent)
  2272. //    Returns the preferred dimensions for this layout given the components
  2273. // int the specified panel.
  2274. //   
  2275. //      Parameters:
  2276. //      parent - the component which needs to be laid out
  2277. //      See Also:
  2278. //      minimumLayoutSize
  2279. //   
  2280. // 
  2281. DEF_ENDLIST
  2282. DEF_METHOD
  2283. public Dimension minimumLayoutSize(Container parent)
  2284. //    Returns the minimum dimensions needed to layout the components 
  2285. // contained in the specified panel.
  2286. //   
  2287. //      Parameters:
  2288. //      parent - the component which needs to be laid out
  2289. //      See Also:
  2290. //      preferredLayoutSize
  2291. //   
  2292. // 
  2293. DEF_ENDLIST
  2294. DEF_METHOD
  2295. public void layoutContainer(Container parent)
  2296. //    Lays out the container in the specified panel.
  2297. //   
  2298. //      Parameters:
  2299. //      parent - the specified component being laid out
  2300. //      See Also:
  2301. //      Container
  2302. //   
  2303. // 
  2304. DEF_ENDLIST
  2305. DEF_METHOD
  2306. public String toString()
  2307. //    Returns the String representation of this GridLayout's values.
  2308. //   
  2309. //      Overrides:
  2310. //      toString in class Object
  2311. //   
  2312. // 
  2313. DEF_ENDLIST
  2314. DEF_ENDCOMPONENT
  2315. DEF_COMPONENTNAME
  2316. CropImageFilter
  2317. DEF_SUPERCLASS
  2318. ImageFilter
  2319. DEF_SUPERCOMPONENT
  2320.  
  2321. DEF_PACKAGE
  2322. java
  2323. awt
  2324. image
  2325. DEF_ENDLIST
  2326. DEF_SUBCOMPONENTLIST
  2327. DEF_ENDLIST
  2328. DEF_SUBCOMPONENTCLASSLIST
  2329. DEF_ENDLIST
  2330. DEF_CATEGORY
  2331.  
  2332. DEF_BITMAP
  2333.  
  2334. DEF_THUMBNAIL_UP
  2335.  
  2336. DEF_THUMBNAIL_DOWN
  2337.  
  2338. DEF_BASE
  2339. DEF_IMPORTS
  2340. DEF_ENDLIST
  2341. DEF_REQUIRES
  2342. DEF_ENDLIST
  2343. DEF_IMPLEMENTS
  2344. DEF_ENDLIST
  2345. DEF_DECLARATION
  2346. // An ImageFilter class for cropping images.
  2347. // This class extends the basic ImageFilter Class to extract a given
  2348. // rectangular region of an existing Image and provide a source for a
  2349. // new image containing just the extracted region.  It is meant to
  2350. // be used in conjunction with a FilteredImageSource object to produce
  2351. // cropped versions of existing images.
  2352. // 
  2353. //      See Also:
  2354. //      FilteredImageSource, ImageFilter
  2355. // 
  2356. DEF_ENDLIST
  2357. DEF_METHOD
  2358. public CropImageFilter(int x,
  2359.                        int y,
  2360.                        int w,
  2361.                        int h)
  2362. //    Constructs a CropImageFilter that extracts the absolute rectangular
  2363. // region of pixels from its source Image as specified by the x, y,
  2364. // w, and h parameters.
  2365. //   
  2366. //      Parameters:
  2367. //      x - the x location of the top of the rectangle to be extracted
  2368. //      y - the y location of the top of the rectangle to be extracted
  2369. //      w - the width of the rectangle to be extracted
  2370. //      h - the height of the rectangle to be extracted
  2371. //   
  2372. // 
  2373. DEF_ENDLIST
  2374. DEF_METHOD
  2375. public void setProperties(Hashtable props)
  2376. //    Passes along  the properties from the source object after adding a
  2377. // property indicating the cropped region.
  2378. //   
  2379. //      Overrides:
  2380. //      setProperties in class ImageFilter
  2381. //   
  2382. // 
  2383. DEF_ENDLIST
  2384. DEF_METHOD
  2385. public void setDimensions(int w,
  2386.                           int h)
  2387. //    Override the source image's dimensions and pass the dimensions
  2388. // of the rectangular cropped region to the ImageConsumer.
  2389. //   
  2390. //      Overrides:
  2391. //      setDimensions in class ImageFilter
  2392. //      See Also:
  2393. //      ImageConsumer
  2394. //   
  2395. // 
  2396. DEF_ENDLIST
  2397. DEF_METHOD
  2398. public void setPixels(int x,
  2399.                       int y,
  2400.                       int w,
  2401.                       int h,
  2402.                       ColorModel model,
  2403.                       byte pixels[],
  2404.                       int off,
  2405.                       int scansize)
  2406. //    Determine whether the delivered byte pixels intersect the region to
  2407. // be extracted and passes through only that subset of pixels that
  2408. // appear in the output region.
  2409. //   
  2410. //      Overrides:
  2411. //      setPixels in class ImageFilter
  2412. //   
  2413. // 
  2414. DEF_ENDLIST
  2415. DEF_METHOD
  2416. public void setPixels(int x,
  2417.                       int y,
  2418.                       int w,
  2419.                       int h,
  2420.                       ColorModel model,
  2421.                       int pixels[],
  2422.                       int off,
  2423.                       int scansize)
  2424. //    Determine if the delivered int pixels intersect the region to
  2425. // be extracted and pass through only that subset of pixels that
  2426. // appear in the output region.
  2427. //   
  2428. //      Overrides:
  2429. //      setPixels in class ImageFilter
  2430. //   
  2431. // 
  2432. DEF_ENDLIST
  2433. DEF_ENDCOMPONENT
  2434. DEF_COMPONENTNAME
  2435. DirectColorModel
  2436. DEF_SUPERCLASS
  2437. ColorModel
  2438. DEF_SUPERCOMPONENT
  2439.  
  2440. DEF_PACKAGE
  2441. java
  2442. awt
  2443. image
  2444. DEF_ENDLIST
  2445. DEF_SUBCOMPONENTLIST
  2446. DEF_ENDLIST
  2447. DEF_SUBCOMPONENTCLASSLIST
  2448. DEF_ENDLIST
  2449. DEF_CATEGORY
  2450.  
  2451. DEF_BITMAP
  2452.  
  2453. DEF_THUMBNAIL_UP
  2454.  
  2455. DEF_THUMBNAIL_DOWN
  2456.  
  2457. DEF_BASE
  2458. DEF_IMPORTS
  2459. DEF_ENDLIST
  2460. DEF_REQUIRES
  2461. DEF_ENDLIST
  2462. DEF_IMPLEMENTS
  2463. DEF_ENDLIST
  2464. DEF_DECLARATION
  2465. // A ColorModel class that specifies a translation from pixel values
  2466. // to alpha, red, green, and blue color components for pixels which
  2467. // have the color components embedded directly in the bits of the
  2468. // pixel itself.  This color model is similar to an X11 TrueColor
  2469. // visual.
  2470. // Many of the methods in this class are final. This is because the
  2471. // underlying native graphics code makes  assumptions about the layout
  2472. // and operation of this class  and those assumptions are reflected in
  2473. // the implementations of the methods here that are marked final.  You
  2474. // can subclass this class  for other reaons,  but you cannot override
  2475. // or modify the behaviour of those methods.
  2476. // 
  2477. //      See Also:
  2478. //      ColorModel
  2479. // 
  2480. DEF_ENDLIST
  2481. DEF_METHOD
  2482. public DirectColorModel(int bits,
  2483.                         int rmask,
  2484.                         int gmask,
  2485.                         int bmask)
  2486. //    Constructs a DirectColorModel from the given masks specifying
  2487. // which bits in the pixel contain the red, green and blue color
  2488. // components.  Pixels described by this color model will all
  2489. // have alpha components of 255 (fully opaque).  All of the bits
  2490. // in each mask must be contiguous and fit in the specified number
  2491. // of least significant bits of the integer.
  2492. // 
  2493. DEF_ENDLIST
  2494. DEF_METHOD
  2495. public DirectColorModel(int bits,
  2496.                         int rmask,
  2497.                         int gmask,
  2498.                         int bmask,
  2499.                         int amask)
  2500. //    Constructs a DirectColorModel from the given masks specifying
  2501. // which bits in the pixel contain the alhpa, red, green and blue
  2502. // color components.  All of the bits in each mask must be contiguous
  2503. // and fit in the specified number of least significant bits of the
  2504. // integer.
  2505. // 
  2506. DEF_ENDLIST
  2507. DEF_METHOD
  2508. public final int getRedMask()
  2509. //    Returns the mask indicating which bits in a pixel contain the red
  2510. // color component.
  2511. // 
  2512. DEF_ENDLIST
  2513. DEF_METHOD
  2514. public final int getGreenMask()
  2515. //    Returns the mask indicating which bits in a pixel contain the green
  2516. // color component.
  2517. // 
  2518. DEF_ENDLIST
  2519. DEF_METHOD
  2520. public final int getBlueMask()
  2521. //    Returns the mask indicating which bits in a pixel contain the blue
  2522. // color component.
  2523. // 
  2524. DEF_ENDLIST
  2525. DEF_METHOD
  2526. public final int getAlphaMask()
  2527. //    Returns the mask indicating which bits in a pixel contain the alpha
  2528. // transparency component.
  2529. // 
  2530. DEF_ENDLIST
  2531. DEF_METHOD
  2532. public final int getRed(int pixel)
  2533. //    Returns the red color compoment for the specified pixel in the
  2534. // range 0-255.
  2535. //   
  2536. //      Overrides:
  2537. //      getRed in class ColorModel
  2538. //   
  2539. // 
  2540. DEF_ENDLIST
  2541. DEF_METHOD
  2542. public final int getGreen(int pixel)
  2543. //    Returns the green color compoment for the specified pixel in the
  2544. // range 0-255.
  2545. //   
  2546. //      Overrides:
  2547. //      getGreen in class ColorModel
  2548. //   
  2549. // 
  2550. DEF_ENDLIST
  2551. DEF_METHOD
  2552. public final int getBlue(int pixel)
  2553. //    Returns the blue color compoment for the specified pixel in the
  2554. // range 0-255.
  2555. //   
  2556. //      Overrides:
  2557. //      getBlue in class ColorModel
  2558. //   
  2559. // 
  2560. DEF_ENDLIST
  2561. DEF_METHOD
  2562. public final int getAlpha(int pixel)
  2563. //    Return the alpha transparency value for the specified pixel in the
  2564. // range 0-255.
  2565. //   
  2566. //      Overrides:
  2567. //      getAlpha in class ColorModel
  2568. //   
  2569. // 
  2570. DEF_ENDLIST
  2571. DEF_METHOD
  2572. public final int getRGB(int pixel)
  2573. //    Returns the color of the pixel in the default RGB color model.
  2574. //   
  2575. //      Overrides:
  2576. //      getRGB in class ColorModel
  2577. //      See Also:
  2578. //      getRGBdefault
  2579. //   
  2580. // 
  2581. DEF_ENDLIST
  2582. DEF_ENDCOMPONENT
  2583. DEF_COMPONENTNAME
  2584. FilteredImageSource
  2585. DEF_SUPERCLASS
  2586. Object
  2587. DEF_SUPERCOMPONENT
  2588.  
  2589. DEF_PACKAGE
  2590. java
  2591. awt
  2592. image
  2593. DEF_ENDLIST
  2594. DEF_SUBCOMPONENTLIST
  2595. DEF_ENDLIST
  2596. DEF_SUBCOMPONENTCLASSLIST
  2597. DEF_ENDLIST
  2598. DEF_CATEGORY
  2599.  
  2600. DEF_BITMAP
  2601.  
  2602. DEF_THUMBNAIL_UP
  2603.  
  2604. DEF_THUMBNAIL_DOWN
  2605.  
  2606. DEF_BASE
  2607. DEF_IMPORTS
  2608. DEF_ENDLIST
  2609. DEF_REQUIRES
  2610. DEF_ENDLIST
  2611. DEF_IMPLEMENTS
  2612. ImageProducer
  2613. DEF_ENDLIST
  2614. DEF_DECLARATION
  2615. // This class is an implementation of the ImageProducer interface which
  2616. // takes an existing image and a filter object and uses them to produce
  2617. // image data for a new filtered version of the original image.
  2618. // Here is an example which filters an image by swapping the red and
  2619. // blue compents:
  2620. // 
  2621. //     Image src = getImage("doc:///demo/images/duke/T1.gif");
  2622. //     ImageFilter colorfilter = new RedBlueSwapFilter();
  2623. //     Image img = createImage(new FilteredImageSource(src.getSource(),
  2624. //                             colorfilter));
  2625. // 
  2626. // 
  2627. //      See Also:
  2628. //      ImageProducer
  2629. // 
  2630. DEF_ENDLIST
  2631. DEF_METHOD
  2632. public FilteredImageSource(ImageProducer orig,
  2633.                            ImageFilter imgf)
  2634. //    Constructs an ImageProducer object from an existing ImageProducer
  2635. // and a filter object.
  2636. //   
  2637. //      See Also:
  2638. //      ImageFilter, createImage
  2639. //   
  2640. // 
  2641. DEF_ENDLIST
  2642. DEF_METHOD
  2643. public synchronized void addConsumer(ImageConsumer ic)
  2644. //    Adds an ImageConsumer to the list of consumers interested in
  2645. // data for this image.
  2646. //   
  2647. //      See Also:
  2648. //      ImageConsumer
  2649. //   
  2650. // 
  2651. DEF_ENDLIST
  2652. DEF_METHOD
  2653. public synchronized boolean isConsumer(ImageConsumer ic)
  2654. //    Determines whether an ImageConsumer is on the list of consumers 
  2655. // currently interested in data for this image.
  2656. //   
  2657. //      Returns:
  2658. //      true if the ImageConsumer is on the list; false otherwise
  2659. //      See Also:
  2660. //      ImageConsumer
  2661. //   
  2662. // 
  2663. DEF_ENDLIST
  2664. DEF_METHOD
  2665. public synchronized void removeConsumer(ImageConsumer ic)
  2666. //    Removes an ImageConsumer from the list of consumers interested in
  2667. // data for this image.
  2668. //   
  2669. //      See Also:
  2670. //      ImageConsumer
  2671. //   
  2672. // 
  2673. DEF_ENDLIST
  2674. DEF_METHOD
  2675. public void startProduction(ImageConsumer ic)
  2676. //    Adds an ImageConsumer to the list of consumers interested in
  2677. // data for this image, and immediately starts delivery of the
  2678. // image data through the ImageConsumer interface.
  2679. //   
  2680. //      See Also:
  2681. //      ImageConsumer
  2682. //   
  2683. // 
  2684. DEF_ENDLIST
  2685. DEF_METHOD
  2686. public void requestTopDownLeftRightResend(ImageConsumer ic)
  2687. //    Requests that a given ImageConsumer have the image data delivered
  2688. // one more time in top-down, left-right order.  The request is
  2689. // handed to the ImageFilter for further processing, since the
  2690. // ability to preserve the pixel ordering depends on the filter.
  2691. //   
  2692. //      See Also:
  2693. //      ImageConsumer
  2694. //   
  2695. // 
  2696. DEF_ENDLIST
  2697. DEF_ENDCOMPONENT
  2698. DEF_COMPONENTNAME
  2699. ImageFilter
  2700. DEF_SUPERCLASS
  2701. Object
  2702. DEF_SUPERCOMPONENT
  2703.  
  2704. DEF_PACKAGE
  2705. java
  2706. awt
  2707. image
  2708. DEF_ENDLIST
  2709. DEF_SUBCOMPONENTLIST
  2710. DEF_ENDLIST
  2711. DEF_SUBCOMPONENTCLASSLIST
  2712. DEF_ENDLIST
  2713. DEF_CATEGORY
  2714.  
  2715. DEF_BITMAP
  2716.  
  2717. DEF_THUMBNAIL_UP
  2718.  
  2719. DEF_THUMBNAIL_DOWN
  2720.  
  2721. DEF_BASE
  2722. DEF_IMPORTS
  2723. DEF_ENDLIST
  2724. DEF_REQUIRES
  2725. DEF_ENDLIST
  2726. DEF_IMPLEMENTS
  2727. ImageConsumer
  2728. Cloneable
  2729. DEF_ENDLIST
  2730. DEF_DECLARATION
  2731. // This class implements a filter for the set of interface methods that
  2732. // are used to deliver data from an ImageProducer to an ImageConsumer.
  2733. // It is meant to be used in conjunction with a FilteredImageSource
  2734. // object to produce filtered versions of existing images.  It is a
  2735. // base class that provides the calls needed to implement a "Null filter"
  2736. // which has no effect on the data being passed through.  Filters should
  2737. // subclass this class and override the methods which deal with the
  2738. // data that needs to be filtered and modify it as necessary.
  2739. // 
  2740. //      See Also:
  2741. //      FilteredImageSource, ImageConsumer
  2742. // 
  2743. DEF_ENDLIST
  2744. DEF_METHOD
  2745. public ImageFilter()
  2746. //    Returns a unique instance of an ImageFilter object which will
  2747. // actually perform the filtering for the specified ImageConsumer.
  2748. // The default implementation just clones this object.
  2749. // 
  2750. DEF_ENDLIST
  2751. DEF_METHOD
  2752. public void setDimensions(int width,
  2753.                           int height)
  2754. //    Filters the information provided in the setDimensions method
  2755. // of the ImageConsumer interface.
  2756. //   
  2757. //      See Also:
  2758. //      setDimensions
  2759. //   
  2760. // 
  2761. DEF_ENDLIST
  2762. DEF_METHOD
  2763. public void setProperties(Hashtable props)
  2764. //    Passes the properties from the source object along after adding a
  2765. // property indicating the stream of filters it has been run through.
  2766. // 
  2767. DEF_ENDLIST
  2768. DEF_METHOD
  2769. public void setColorModel(ColorModel model)
  2770. //    Filter the information provided in the setColorModel method
  2771. // of the ImageConsumer interface.
  2772. //   
  2773. //      See Also:
  2774. //      setColorModel
  2775. //   
  2776. // 
  2777. DEF_ENDLIST
  2778. DEF_METHOD
  2779. public void setHints(int hints)
  2780. //    Filters the information provided in the setHints method
  2781. // of the ImageConsumer interface.
  2782. //   
  2783. //      See Also:
  2784. //      setHints
  2785. //   
  2786. // 
  2787. DEF_ENDLIST
  2788. DEF_METHOD
  2789. public void setPixels(int x,
  2790.                       int y,
  2791.                       int w,
  2792.                       int h,
  2793.                       ColorModel model,
  2794.                       byte pixels[],
  2795.                       int off,
  2796.                       int scansize)
  2797. //    Filters the information provided in the setPixels method of the
  2798. // ImageConsumer interface which takes an array of bytes.
  2799. //   
  2800. //      See Also:
  2801. //      setPixels
  2802. //   
  2803. // 
  2804. DEF_ENDLIST
  2805. DEF_METHOD
  2806. public void setPixels(int x,
  2807.                       int y,
  2808.                       int w,
  2809.                       int h,
  2810.                       ColorModel model,
  2811.                       int pixels[],
  2812.                       int off,
  2813.                       int scansize)
  2814. //    Filters the information provided in the setPixels method of the
  2815. // ImageConsumer interface which takes an array of integers.
  2816. //   
  2817. //      See Also:
  2818. //      setPixels
  2819. //   
  2820. // 
  2821. DEF_ENDLIST
  2822. DEF_METHOD
  2823. public void imageComplete(int status)
  2824. //    Filters the information provided in the imageComplete method of
  2825. // the ImageConsumer interface.
  2826. //   
  2827. //      See Also:
  2828. //      imageComplete
  2829. //   
  2830. // 
  2831. DEF_ENDLIST
  2832. DEF_METHOD
  2833. public void resendTopDownLeftRight(ImageProducer ip)
  2834. //    Responds to a request for a TopDownLeftRight (TDLR) ordered resend
  2835. // of the pixel data from an ImageConsumer.
  2836. // The ImageFilter can respond to this request in one of three ways.
  2837. // 
  2838. // If the filter can determine that it will forward the pixels in
  2839. // TDLR order if its upstream producer object sends them
  2840. // in TDLR order, then the request is automatically forwarded by
  2841. // default to the indicated ImageProducer using this filter as the
  2842. // requesting ImageConsumer, so no override is necessary.
  2843. // If the filter can resend the pixels in the right order on its
  2844. // own (presumably because the generated pixels have been saved in
  2845. // some sort of buffer), then it can override this method and
  2846. // simply resend the pixels in TDLR order as specified in the
  2847. // ImageProducer API.  If the filter simply returns from this
  2848. // method then the request will be ignored and no resend will
  2849. // occur.   @see ImageProducer#requestTopDownLeftRightResend
  2850. //   
  2851. //      Parameters:
  2852. //      ip - The ImageProducer that is feeding this instance of
  2853. // the filter - also the ImageProducer that the request should be
  2854. // forwarded to if necessary.
  2855. //   
  2856. // 
  2857. DEF_ENDLIST
  2858. DEF_METHOD
  2859. public Object clone()
  2860. //    Clones this object.
  2861. //   
  2862. //      Overrides:
  2863. //      clone in class Object
  2864. //   
  2865. // 
  2866. DEF_ENDLIST
  2867. DEF_ENDCOMPONENT
  2868. DEF_COMPONENTNAME
  2869. IndexColorModel
  2870. DEF_SUPERCLASS
  2871. ColorModel
  2872. DEF_SUPERCOMPONENT
  2873.  
  2874. DEF_PACKAGE
  2875. java
  2876. awt
  2877. image
  2878. DEF_ENDLIST
  2879. DEF_SUBCOMPONENTLIST
  2880. DEF_ENDLIST
  2881. DEF_SUBCOMPONENTCLASSLIST
  2882. DEF_ENDLIST
  2883. DEF_CATEGORY
  2884.  
  2885. DEF_BITMAP
  2886.  
  2887. DEF_THUMBNAIL_UP
  2888.  
  2889. DEF_THUMBNAIL_DOWN
  2890.  
  2891. DEF_BASE
  2892. DEF_IMPORTS
  2893. DEF_ENDLIST
  2894. DEF_REQUIRES
  2895. DEF_ENDLIST
  2896. DEF_IMPLEMENTS
  2897. DEF_ENDLIST
  2898. DEF_DECLARATION
  2899. // A ColorModel class that specifies a translation from pixel values
  2900. // to alpha, red, green, and blue color components for pixels which
  2901. // represent indices into a fixed colormap.  An optional transparent
  2902. // pixel value can be supplied which indicates a completely transparent
  2903. // pixel, regardless of any alpha value recorded for that pixel value.
  2904. // This color model is similar to an X11 PseudoColor visual.
  2905. // Many of the methods in this class are final.  The reason for
  2906. // this is that the underlying native graphics code makes assumptions
  2907. // about the layout and operation of this class and those assumptions
  2908. // are reflected in the implementations of the methods here that are
  2909. // marked final.  You can subclass this class for other reaons, but
  2910. // you cannot override or modify the behaviour of those methods.
  2911. // 
  2912. //      See Also:
  2913. //      ColorModel
  2914. // 
  2915. DEF_ENDLIST
  2916. DEF_METHOD
  2917. public IndexColorModel(int bits,
  2918.                        int size,
  2919.                        byte r[],
  2920.                        byte g[],
  2921.                        byte b[])
  2922. //    Constructs an IndexColorModel from the given arrays of red,
  2923. // green, and blue components.  Pixels described by this color
  2924. // model will all have alpha components of 255 (fully opaque).
  2925. // All of the arrays specifying the color components must have
  2926. // at least the specified number of entries.
  2927. //   
  2928. //      Parameters:
  2929. //      bits - The number of bits each pixel occupies.
  2930. //      size - The size of the color component arrays.
  2931. //      r - The array of red color components.
  2932. //      g - The array of green color components.
  2933. //      b - The array of blue color components.
  2934. //   
  2935. // 
  2936. DEF_ENDLIST
  2937. DEF_METHOD
  2938. public IndexColorModel(int bits,
  2939.                        int size,
  2940.                        byte r[],
  2941.                        byte g[],
  2942.                        byte b[],
  2943.                        int trans)
  2944. //    Constructs an IndexColorModel from the given arrays of red,
  2945. // green, and blue components.  Pixels described by this color
  2946. // model will all have alpha components of 255 (fully opaque),
  2947. // except for the indicated transparent pixel.  All of the arrays
  2948. // specifying the color components must have at least the specified
  2949. // number of entries.
  2950. //   
  2951. //      Parameters:
  2952. //      bits - The number of bits each pixel occupies.
  2953. //      size - The size of the color component arrays.
  2954. //      r - The array of red color components.
  2955. //      g - The array of green color components.
  2956. //      b - The array of blue color components.
  2957. //      trans - The index of the transparent pixel.
  2958. //   
  2959. // 
  2960. DEF_ENDLIST
  2961. DEF_METHOD
  2962. public IndexColorModel(int bits,
  2963.                        int size,
  2964.                        byte r[],
  2965.                        byte g[],
  2966.                        byte b[],
  2967.                        byte a[])
  2968. //    Constructs an IndexColorModel from the given arrays of red,
  2969. // green, blue and alpha components.  All of the arrays specifying
  2970. // the color components must have at least the specified number
  2971. // of entries.
  2972. //   
  2973. //      Parameters:
  2974. //      bits - The number of bits each pixel occupies.
  2975. //      size - The size of the color component arrays.
  2976. //      r - The array of red color components.
  2977. //      g - The array of green color components.
  2978. //      b - The array of blue color components.
  2979. //      a - The array of alpha value components.
  2980. //   
  2981. // 
  2982. DEF_ENDLIST
  2983. DEF_METHOD
  2984. public IndexColorModel(int bits,
  2985.                        int size,
  2986.                        byte cmap[],
  2987.                        int start,
  2988.                        boolean hasalpha)
  2989. //    Constructs an IndexColorModel from a single arrays of packed
  2990. // red, green, blue and optional alpha components.  The array
  2991. // must have enough values in it to fill all of the needed
  2992. // component arrays of the specified size.
  2993. //   
  2994. //      Parameters:
  2995. //      bits - The number of bits each pixel occupies.
  2996. //      size - The size of the color component arrays.
  2997. //      cmap - The array of color components.
  2998. //      start - The starting offset of the first color component.
  2999. //      hasalpha - Indicates whether alpha values are contained in
  3000. //             the cmap array.
  3001. //   
  3002. // 
  3003. DEF_ENDLIST
  3004. DEF_METHOD
  3005. public IndexColorModel(int bits,
  3006.                        int size,
  3007.                        byte cmap[],
  3008.                        int start,
  3009.                        boolean hasalpha,
  3010.                        int trans)
  3011. //    Constructs an IndexColorModel from a single arrays of packed
  3012. // red, green, blue and optional alpha components.  The specified
  3013. // transparent index represents a pixel which will be considered
  3014. // entirely transparent regardless of any alpha value specified
  3015. // for it.  The array must have enough values in it to fill all
  3016. // of the needed component arrays of the specified size.
  3017. //   
  3018. //      Parameters:
  3019. //      bits - The number of bits each pixel occupies.
  3020. //      size - The size of the color component arrays.
  3021. //      cmap - The array of color components.
  3022. //      start - The starting offset of the first color component.
  3023. //      hasalpha - Indicates whether alpha values are contained in
  3024. //             the cmap array.
  3025. //      trans - The index of the fully transparent pixel.
  3026. //   
  3027. // 
  3028. DEF_ENDLIST
  3029. DEF_METHOD
  3030. public final int getMapSize()
  3031. //    Returns the size of the color component arrays in this IndexColorModel.
  3032. // 
  3033. DEF_ENDLIST
  3034. DEF_METHOD
  3035. public final int getTransparentPixel()
  3036. //    Returns the index of the transparent pixel in this IndexColorModel
  3037. // or -1 if there is no transparent pixel.
  3038. // 
  3039. DEF_ENDLIST
  3040. DEF_METHOD
  3041. public final void getReds(byte r[])
  3042. //    Copies the array of red color components into the given array.  Only
  3043. // the initial entries of the array as specified by getMapSize() are
  3044. // written.
  3045. // 
  3046. DEF_ENDLIST
  3047. DEF_METHOD
  3048. public final void getGreens(byte g[])
  3049. //    Copies the array of green color components into the given array.  Only
  3050. // the initial entries of the array as specified by getMapSize() are
  3051. //  written.
  3052. // 
  3053. DEF_ENDLIST
  3054. DEF_METHOD
  3055. public final void getBlues(byte b[])
  3056. //    Copies the array of blue color components into the given array.  Only
  3057. // the initial entries of the array as specified by getMapSize() will
  3058. // be written.
  3059. // 
  3060. DEF_ENDLIST
  3061. DEF_METHOD
  3062. public final void getAlphas(byte a[])
  3063. //    Copies the array of alpha transparency values into the given array.  Only
  3064. // the initial entries of the array as specified by getMapSize() will
  3065. // be written.
  3066. // 
  3067. DEF_ENDLIST
  3068. DEF_METHOD
  3069. public final int getRed(int pixel)
  3070. //    Returns the red color compoment for the specified pixel in the
  3071. // range 0-255.
  3072. //   
  3073. //      Overrides:
  3074. //      getRed in class ColorModel
  3075. //   
  3076. // 
  3077. DEF_ENDLIST
  3078. DEF_METHOD
  3079. public final int getGreen(int pixel)
  3080. //    Returns the green color compoment for the specified pixel in the
  3081. // range 0-255.
  3082. //   
  3083. //      Overrides:
  3084. //      getGreen in class ColorModel
  3085. //   
  3086. // 
  3087. DEF_ENDLIST
  3088. DEF_METHOD
  3089. public final int getBlue(int pixel)
  3090. //    Returns the blue color compoment for the specified pixel in the
  3091. // range 0-255.
  3092. //   
  3093. //      Overrides:
  3094. //      getBlue in class ColorModel
  3095. //   
  3096. // 
  3097. DEF_ENDLIST
  3098. DEF_METHOD
  3099. public final int getAlpha(int pixel)
  3100. //    Returns the alpha transparency value for the specified pixel in the
  3101. // range 0-255.
  3102. //   
  3103. //      Overrides:
  3104. //      getAlpha in class ColorModel
  3105. //   
  3106. // 
  3107. DEF_ENDLIST
  3108. DEF_METHOD
  3109. public final int getRGB(int pixel)
  3110. //    Returns the color of the pixel in the default RGB color model.
  3111. //   
  3112. //      Overrides:
  3113. //      getRGB in class ColorModel
  3114. //      See Also:
  3115. //      getRGBdefault
  3116. //   
  3117. // 
  3118. DEF_ENDLIST
  3119. DEF_ENDCOMPONENT
  3120. DEF_COMPONENTNAME
  3121. Image
  3122. DEF_SUPERCLASS
  3123. Object
  3124. DEF_SUPERCOMPONENT
  3125.  
  3126. DEF_PACKAGE
  3127. java
  3128. awt
  3129. DEF_ENDLIST
  3130. DEF_SUBCOMPONENTLIST
  3131. DEF_ENDLIST
  3132. DEF_SUBCOMPONENTCLASSLIST
  3133. DEF_ENDLIST
  3134. DEF_CATEGORY
  3135.  
  3136. DEF_BITMAP
  3137.  
  3138. DEF_THUMBNAIL_UP
  3139.  
  3140. DEF_THUMBNAIL_DOWN
  3141.  
  3142. DEF_BASE
  3143. DEF_IMPORTS
  3144. DEF_ENDLIST
  3145. DEF_REQUIRES
  3146. DEF_ENDLIST
  3147. DEF_IMPLEMENTS
  3148. DEF_ENDLIST
  3149. DEF_DECLARATION
  3150. // The image class is an abstract class. The image must be obtained in a 
  3151. // platform specific way.
  3152. DEF_ENDLIST
  3153. DEF_METHOD
  3154. public Image()
  3155. //    Gets the actual width of the image.  If the width is not known
  3156. // yet then the ImageObserver will be notified later and -1 will
  3157. // be returned.
  3158. //   
  3159. //      See Also:
  3160. //      getHeight, ImageObserver
  3161. //   
  3162. // 
  3163. DEF_ENDLIST
  3164. DEF_METHOD
  3165. public abstract int getHeight(ImageObserver observer)
  3166. //    Gets the actual height of the image.  If the height is not known
  3167. // yet then the ImageObserver will be notified later and -1 will
  3168. // be returned.
  3169. //   
  3170. //      See Also:
  3171. //      getWidth, ImageObserver
  3172. //   
  3173. // 
  3174. DEF_ENDLIST
  3175. DEF_METHOD
  3176. public abstract ImageProducer getSource()
  3177. //    Gets the object that produces the pixels for the image.
  3178. // This is used by the Image filtering classes and by the
  3179. // image conversion and scaling code.
  3180. //   
  3181. //      See Also:
  3182. //      ImageProducer
  3183. //   
  3184. // 
  3185. DEF_ENDLIST
  3186. DEF_METHOD
  3187. public abstract Graphics getGraphics()
  3188. //    Gets a graphics object to draw into this image.
  3189. // This will only work for off-screen images.
  3190. //   
  3191. //      See Also:
  3192. //      Graphics
  3193. //   
  3194. // 
  3195. DEF_ENDLIST
  3196. DEF_METHOD
  3197. public abstract Object getProperty(String name,
  3198.                                    ImageObserver observer)
  3199. //    Gets a property of the image by name.  Individual property names
  3200. // are defined by the various image formats.  If a property is not
  3201. // defined for a particular image, this method will return the
  3202. // UndefinedProperty object.  If the properties for this image are
  3203. // not yet known, then this method will return null and the ImageObserver
  3204. // object will be notified later.  The property name "comment" should
  3205. // be used to store an optional comment which can be presented to
  3206. // the user as a description of the image, its source, or its author.
  3207. //   
  3208. //      See Also:
  3209. //      ImageObserver, UndefinedProperty
  3210. //   
  3211. // 
  3212. DEF_ENDLIST
  3213. DEF_METHOD
  3214. public abstract void flush()
  3215. //    Flushes all resources being used by this Image object.  This
  3216. // includes any pixel data that is being cached for rendering to
  3217. // the screen as well as any system resources that are being used
  3218. // to store data or pixels for the image.  The image is reset to
  3219. // a state similar to when it was first created so that if it is
  3220. // again rendered, the image data will have to be recreated or
  3221. // fetched again from its source.
  3222. // 
  3223. DEF_ENDLIST
  3224. DEF_ENDCOMPONENT
  3225. DEF_COMPONENTNAME
  3226. Insets
  3227. DEF_SUPERCLASS
  3228. Object
  3229. DEF_SUPERCOMPONENT
  3230.  
  3231. DEF_PACKAGE
  3232. java
  3233. awt
  3234. DEF_ENDLIST
  3235. DEF_SUBCOMPONENTLIST
  3236. DEF_ENDLIST
  3237. DEF_SUBCOMPONENTCLASSLIST
  3238. DEF_ENDLIST
  3239. DEF_CATEGORY
  3240.  
  3241. DEF_BITMAP
  3242.  
  3243. DEF_THUMBNAIL_UP
  3244.  
  3245. DEF_THUMBNAIL_DOWN
  3246.  
  3247. DEF_BASE
  3248. DEF_IMPORTS
  3249. DEF_ENDLIST
  3250. DEF_REQUIRES
  3251. DEF_ENDLIST
  3252. DEF_IMPLEMENTS
  3253. Cloneable
  3254. DEF_ENDLIST
  3255. DEF_DECLARATION
  3256. // The insets of a container.
  3257. // This class is used to layout containers.
  3258. // 
  3259. //      See Also:
  3260. //      LayoutManager, Container
  3261. // 
  3262. DEF_ENDLIST
  3263. DEF_METHOD
  3264. public Insets(int top,
  3265.               int left,
  3266.               int bottom,
  3267.               int right)
  3268. //    Constructs and initializes a new Inset with the specified top,
  3269. // left, bottom, and right insets.
  3270. //   
  3271. //      Parameters:
  3272. //      top - the inset from the top
  3273. //      left - the inset from the left
  3274. //      bottom - the inset from the bottom
  3275. //      right - the inset from the right
  3276. //   
  3277. // 
  3278. DEF_ENDLIST
  3279. DEF_METHOD
  3280. public String toString()
  3281. //    Returns a String object representing this Inset's values.
  3282. //   
  3283. //      Overrides:
  3284. //      toString in class Object
  3285. //   
  3286. // 
  3287. DEF_ENDLIST
  3288. DEF_METHOD
  3289. public Object clone()
  3290. //    Creates a clone of the object.
  3291. //   
  3292. //      Overrides:
  3293. //      clone in class Object
  3294. //   
  3295. // 
  3296. DEF_ENDLIST
  3297. DEF_ENDCOMPONENT
  3298. DEF_COMPONENTNAME
  3299. DataInputStream
  3300. DEF_SUPERCLASS
  3301. FilterInputStream
  3302. DEF_SUPERCOMPONENT
  3303.  
  3304. DEF_PACKAGE
  3305. java
  3306. io
  3307. DEF_ENDLIST
  3308. DEF_SUBCOMPONENTLIST
  3309. DEF_ENDLIST
  3310. DEF_SUBCOMPONENTCLASSLIST
  3311. DEF_ENDLIST
  3312. DEF_CATEGORY
  3313.  
  3314. DEF_BITMAP
  3315.  
  3316. DEF_THUMBNAIL_UP
  3317.  
  3318. DEF_THUMBNAIL_DOWN
  3319.  
  3320. DEF_BASE
  3321. DEF_IMPORTS
  3322. java.io.DataInputStream
  3323. DEF_ENDLIST
  3324. DEF_REQUIRES
  3325. DEF_ENDLIST
  3326. DEF_IMPLEMENTS
  3327. DataInput
  3328. DEF_ENDLIST
  3329. DEF_DECLARATION
  3330. // A data input stream that lets you read primitive Java data types
  3331. // from a stream in a portable way.  Primitive data types are well
  3332. // understood types with associated operations.  For example,
  3333. // Integers are considered primitive data types.
  3334. // 
  3335. //      See Also:
  3336. //      DataOutputStream
  3337. // 
  3338. DEF_ENDLIST
  3339. DEF_METHOD
  3340. public DataInputStream(InputStream in)
  3341. //    Creates a new DataInputStream.
  3342. //   
  3343. //      Parameters:
  3344. //      in - the input stream
  3345. //   
  3346. // 
  3347. DEF_ENDLIST
  3348. DEF_METHOD
  3349. public final int read(byte b[]) throws IOException
  3350. //    Reads data into an array of bytes.
  3351. // This method blocks until some input is available.
  3352. //   
  3353. //      Parameters:
  3354. //      b - the buffer into which the data is read
  3355. //      Returns:
  3356. //      the actual number of bytes read, -1 is
  3357. //         returned when the end of the stream is reached.
  3358. //      Throws: IOException
  3359. //      If an I/O error has occurred.
  3360. //      Overrides:
  3361. //      read in class FilterInputStream
  3362. //   
  3363. // 
  3364. DEF_ENDLIST
  3365. DEF_METHOD
  3366. public final int read(byte b[],
  3367.                       int off,
  3368.                       int len) throws IOException
  3369. //    Reads data into an array of bytes.
  3370. // This method blocks until some input is available.
  3371. //   
  3372. //      Parameters:
  3373. //      b - the buffer into which the data is read
  3374. //      off - the start offset of the data
  3375. //      len - the maximum number of bytes read
  3376. //      Returns:
  3377. //      the actual number of bytes read, -1 is
  3378. //         returned when the end of the stream is reached.
  3379. //      Throws: IOException
  3380. //      If an I/O error has occurred.
  3381. //      Overrides:
  3382. //      read in class FilterInputStream
  3383. //   
  3384. // 
  3385. DEF_ENDLIST
  3386. DEF_METHOD
  3387. public final void readFully(byte b[]) throws IOException
  3388. //    Reads bytes, blocking until all bytes are read.
  3389. //   
  3390. //      Parameters:
  3391. //      b - the buffer into which the data is read
  3392. //      Throws: IOException
  3393. //      If an I/O error has occurred.
  3394. //      Throws: EOFException
  3395. //      If EOF reached before all bytes are read.
  3396. //   
  3397. // 
  3398. DEF_ENDLIST
  3399. DEF_METHOD
  3400. public final void readFully(byte b[],
  3401.                             int off,
  3402.                             int len) throws IOException
  3403. //    Reads bytes, blocking until all bytes are read.
  3404. //   
  3405. //      Parameters:
  3406. //      b - the buffer into which the data is read
  3407. //      off - the start offset of the data
  3408. //      len - the maximum number of bytes read
  3409. //      Throws: IOException
  3410. //      If an I/O error has occurred.
  3411. //      Throws: EOFException
  3412. //      If EOF reached before all bytes are read.
  3413. //   
  3414. // 
  3415. DEF_ENDLIST
  3416. DEF_METHOD
  3417. public final int skipBytes(int n) throws IOException
  3418. //    Skips bytes, blocks until all bytes are skipped.
  3419. //   
  3420. //      Parameters:
  3421. //      n - the number of bytes to be skipped
  3422. //      Returns:
  3423. //      the actual number of bytes skipped.
  3424. //      Throws: IOException
  3425. //      If an I/O error has occurred.
  3426. //   
  3427. // 
  3428. DEF_ENDLIST
  3429. DEF_METHOD
  3430. public final boolean readBoolean() throws IOException
  3431. //    Reads a boolean.
  3432. //   
  3433. //      Returns:
  3434. //      the boolean read.
  3435. //   
  3436. // 
  3437. DEF_ENDLIST
  3438. DEF_METHOD
  3439. public final byte readByte() throws IOException
  3440. //    Reads an 8 bit byte.
  3441. //   
  3442. //      Returns:
  3443. //      the 8 bit byte read.
  3444. //   
  3445. // 
  3446. DEF_ENDLIST
  3447. DEF_METHOD
  3448. public final int readUnsignedByte() throws IOException
  3449. //    Reads an unsigned 8 bit byte.
  3450. //   
  3451. //      Returns:
  3452. //      the 8 bit byte read.
  3453. //   
  3454. // 
  3455. DEF_ENDLIST
  3456. DEF_METHOD
  3457. public final short readShort() throws IOException
  3458. //    Reads a 16 bit short.
  3459. //   
  3460. //      Returns:
  3461. //      the 16 bit short read.
  3462. //   
  3463. // 
  3464. DEF_ENDLIST
  3465. DEF_METHOD
  3466. public final int readUnsignedShort() throws IOException
  3467. //    Reads 16 bit short.
  3468. //   
  3469. //      Returns:
  3470. //      the 16 bit short read.
  3471. //   
  3472. // 
  3473. DEF_ENDLIST
  3474. DEF_METHOD
  3475. public final char readChar() throws IOException
  3476. //    Reads a 16 bit char.
  3477. //   
  3478. //      Returns:
  3479. //      the read 16 bit char.
  3480. //   
  3481. // 
  3482. DEF_ENDLIST
  3483. DEF_METHOD
  3484. public final int readInt() throws IOException
  3485. //    Reads a 32 bit int.
  3486. //   
  3487. //      Returns:
  3488. //      the 32 bit integer read.
  3489. //   
  3490. // 
  3491. DEF_ENDLIST
  3492. DEF_METHOD
  3493. public final long readLong() throws IOException
  3494. //    Reads a 64 bit long.
  3495. //   
  3496. //      Returns:
  3497. //      the 64 bit long read.
  3498. //   
  3499. // 
  3500. DEF_ENDLIST
  3501. DEF_METHOD
  3502. public final float readFloat() throws IOException
  3503. //    Reads a 32 bit float.
  3504. //   
  3505. //      Returns:
  3506. //      the read 32 bit float.
  3507. //   
  3508. // 
  3509. DEF_ENDLIST
  3510. DEF_METHOD
  3511. public final double readDouble() throws IOException
  3512. //    Reads a 64 bit double.
  3513. //   
  3514. //      Returns:
  3515. //      the 64 bit double read.
  3516. //   
  3517. // 
  3518. DEF_ENDLIST
  3519. DEF_METHOD
  3520. public final String readLine() throws IOException
  3521. //    Reads in a line that has been terminated by a \n, \r, 
  3522. // \r\n or EOF.
  3523. //   
  3524. //      Returns:
  3525. //      a String copy of the line.
  3526. //   
  3527. // 
  3528. DEF_ENDLIST
  3529. DEF_METHOD
  3530. public final String readUTF() throws IOException
  3531. //    Reads a UTF format String.
  3532. //   
  3533. //      Returns:
  3534. //      the String.
  3535. //   
  3536. // 
  3537. DEF_ENDLIST
  3538. DEF_METHOD
  3539. public final static String readUTF(DataInput in) throws IOException
  3540. //    Reads a UTF format String from the given input stream.
  3541. //   
  3542. //      Returns:
  3543. //      the String.
  3544. //   
  3545. // 
  3546. DEF_ENDLIST
  3547. DEF_ENDCOMPONENT
  3548. DEF_COMPONENTNAME
  3549. DataOutputStream
  3550. DEF_SUPERCLASS
  3551. FilterOutputStream
  3552. DEF_SUPERCOMPONENT
  3553.  
  3554. DEF_PACKAGE
  3555. java
  3556. io
  3557. DEF_ENDLIST
  3558. DEF_SUBCOMPONENTLIST
  3559. DEF_ENDLIST
  3560. DEF_SUBCOMPONENTCLASSLIST
  3561. DEF_ENDLIST
  3562. DEF_CATEGORY
  3563.  
  3564. DEF_BITMAP
  3565.  
  3566. DEF_THUMBNAIL_UP
  3567.  
  3568. DEF_THUMBNAIL_DOWN
  3569.  
  3570. DEF_BASE
  3571. DEF_IMPORTS
  3572. java.io.DataOutputStream
  3573. DEF_ENDLIST
  3574. DEF_REQUIRES
  3575. DEF_ENDLIST
  3576. DEF_IMPLEMENTS
  3577. DataOutput
  3578. DEF_ENDLIST
  3579. DEF_DECLARATION
  3580. // This class lets you write primitive Java data types
  3581. // to a stream in a portable way. Primitive data types are well
  3582. // understood types with associated operations.  For example, an 
  3583. // Integer is considered to be a good primitive data type.
  3584. // The data can be converted back using a DataInputStream.
  3585. DEF_ENDLIST
  3586. DEF_METHOD
  3587. public DataOutputStream(OutputStream out)
  3588. //    Creates a new DataOutputStream.
  3589. //   
  3590. //      Parameters:
  3591. //      out - the output stream
  3592. //   
  3593. // 
  3594. DEF_ENDLIST
  3595. DEF_METHOD
  3596. public synchronized void write(int b) throws IOException
  3597. //    Writes a byte. Will block until the byte is actually
  3598. // written.
  3599. //   
  3600. //      Parameters:
  3601. //      b - the byte to be written
  3602. //      Throws: IOException
  3603. //      If an I/O error has occurred.
  3604. //      Overrides:
  3605. //      write in class FilterOutputStream
  3606. //   
  3607. // 
  3608. DEF_ENDLIST
  3609. DEF_METHOD
  3610. public synchronized void write(byte b[],
  3611.                                int off,
  3612.                                int len) throws IOException
  3613. //    Writes a sub array of bytes.
  3614. //   
  3615. //      Parameters:
  3616. //      b - the data to be written
  3617. //      off - the start offset in the data
  3618. //      len - the number of bytes that are written
  3619. //      Throws: IOException
  3620. //      If an I/O error has occurred.
  3621. //      Overrides:
  3622. //      write in class FilterOutputStream
  3623. //   
  3624. // 
  3625. DEF_ENDLIST
  3626. DEF_METHOD
  3627. public void flush() throws IOException
  3628. //    Flushes the stream. This will write any buffered
  3629. // output bytes.
  3630. //   
  3631. //      Throws: IOException
  3632. //      If an I/O error has occurred.
  3633. //      Overrides:
  3634. //      flush in class FilterOutputStream
  3635. //   
  3636. // 
  3637. DEF_ENDLIST
  3638. DEF_METHOD
  3639. public final void writeBoolean(boolean v) throws IOException
  3640. //    Writes a boolean.
  3641. //   
  3642. //      Parameters:
  3643. //      v - the boolean to be written
  3644. //   
  3645. // 
  3646. DEF_ENDLIST
  3647. DEF_METHOD
  3648. public final void writeByte(int v) throws IOException
  3649. //    Writes an 8 bit byte.
  3650. //   
  3651. //      Parameters:
  3652. //      v - the byte value to be written
  3653. //   
  3654. // 
  3655. DEF_ENDLIST
  3656. DEF_METHOD
  3657. public final void writeShort(int v) throws IOException
  3658. //    Writes a 16 bit short.
  3659. //   
  3660. //      Parameters:
  3661. //      v - the short value to be written
  3662. //   
  3663. // 
  3664. DEF_ENDLIST
  3665. DEF_METHOD
  3666. public final void writeChar(int v) throws IOException
  3667. //    Writes a 16 bit char.
  3668. //   
  3669. //      Parameters:
  3670. //      v - the char value to be written
  3671. //   
  3672. // 
  3673. DEF_ENDLIST
  3674. DEF_METHOD
  3675. public final void writeInt(int v) throws IOException
  3676. //    Writes a 32 bit int.
  3677. //   
  3678. //      Parameters:
  3679. //      v - the integer value to be written
  3680. //   
  3681. // 
  3682. DEF_ENDLIST
  3683. DEF_METHOD
  3684. public final void writeLong(long v) throws IOException
  3685. //    Writes a 64 bit long.
  3686. //   
  3687. //      Parameters:
  3688. //      v - the long value to be written
  3689. //   
  3690. // 
  3691. DEF_ENDLIST
  3692. DEF_METHOD
  3693. public final void writeFloat(float v) throws IOException
  3694. //    Writes a 32 bit float.
  3695. //   
  3696. //      Parameters:
  3697. //      v - the float value to be written
  3698. //   
  3699. // 
  3700. DEF_ENDLIST
  3701. DEF_METHOD
  3702. public final void writeDouble(double v) throws IOException
  3703. //    Writes a 64 bit double.
  3704. //   
  3705. //      Parameters:
  3706. //      v - the double value to be written
  3707. //   
  3708. // 
  3709. DEF_ENDLIST
  3710. DEF_METHOD
  3711. public final void writeBytes(String s) throws IOException
  3712. //    Writes a String as a sequence of bytes.
  3713. //   
  3714. //      Parameters:
  3715. //      s - the String of bytes to be written
  3716. //   
  3717. // 
  3718. DEF_ENDLIST
  3719. DEF_METHOD
  3720. public final void writeChars(String s) throws IOException
  3721. //    Writes a String as a sequence of chars.
  3722. //   
  3723. //      Parameters:
  3724. //      s - the String of chars to be written
  3725. //   
  3726. // 
  3727. DEF_ENDLIST
  3728. DEF_METHOD
  3729. public final void writeUTF(String str) throws IOException
  3730. //    Writes a String in UTF format.
  3731. //   
  3732. //      Parameters:
  3733. //      str - the String in UTF format
  3734. //   
  3735. // 
  3736. DEF_ENDLIST
  3737. DEF_METHOD
  3738. public final int size()
  3739. //    Returns the number of bytes written.
  3740. //   
  3741. //      Returns:
  3742. //      the number of bytes written thus far.
  3743. //   
  3744. // 
  3745. DEF_ENDLIST
  3746. DEF_ENDCOMPONENT
  3747. DEF_COMPONENTNAME
  3748. EOFException
  3749. DEF_SUPERCLASS
  3750. IOException
  3751. DEF_SUPERCOMPONENT
  3752.  
  3753. DEF_PACKAGE
  3754. java
  3755. io
  3756. DEF_ENDLIST
  3757. DEF_SUBCOMPONENTLIST
  3758. DEF_ENDLIST
  3759. DEF_SUBCOMPONENTCLASSLIST
  3760. DEF_ENDLIST
  3761. DEF_CATEGORY
  3762.  
  3763. DEF_BITMAP
  3764.  
  3765. DEF_THUMBNAIL_UP
  3766.  
  3767. DEF_THUMBNAIL_DOWN
  3768.  
  3769. DEF_BASE
  3770. DEF_IMPORTS
  3771. java.io.EOFException
  3772. DEF_ENDLIST
  3773. DEF_REQUIRES
  3774. DEF_ENDLIST
  3775. DEF_IMPLEMENTS
  3776. DEF_ENDLIST
  3777. DEF_DECLARATION
  3778. // Signals that and EOF has been reached unexpectedly during input.
  3779. // 
  3780. //      See Also:
  3781. //      IOException, DataInputStream
  3782. // 
  3783. DEF_ENDLIST
  3784. DEF_METHOD
  3785. public EOFException()
  3786. //    Constructs an EOFException with no detail message.
  3787. // A detail message is a String that describes this particular exception.
  3788. // 
  3789. DEF_ENDLIST
  3790. DEF_METHOD
  3791. public EOFException(String s)
  3792. //    Constructs an EOFException with the specified detail message.
  3793. // A detail message is a String that describes this particular exception.
  3794. //   
  3795. //      Parameters:
  3796. //      s - the detail message
  3797. //   
  3798. // 
  3799. DEF_ENDLIST
  3800. DEF_ENDCOMPONENT
  3801. DEF_COMPONENTNAME
  3802. File
  3803. DEF_SUPERCLASS
  3804. Object
  3805. DEF_SUPERCOMPONENT
  3806.  
  3807. DEF_PACKAGE
  3808. java
  3809. io
  3810. DEF_ENDLIST
  3811. DEF_SUBCOMPONENTLIST
  3812. DEF_ENDLIST
  3813. DEF_SUBCOMPONENTCLASSLIST
  3814. DEF_ENDLIST
  3815. DEF_CATEGORY
  3816.  
  3817. DEF_BITMAP
  3818.  
  3819. DEF_THUMBNAIL_UP
  3820.  
  3821. DEF_THUMBNAIL_DOWN
  3822.  
  3823. DEF_BASE
  3824. DEF_IMPORTS
  3825. java.io.File
  3826. DEF_ENDLIST
  3827. DEF_REQUIRES
  3828. DEF_ENDLIST
  3829. DEF_IMPLEMENTS
  3830. DEF_ENDLIST
  3831. DEF_DECLARATION
  3832. // This class represents a file name of the host file system.
  3833. // The file name can be relative or absolute. It must use
  3834. // the file name conventions of the host platform. 
  3835. // The intention is to provide an abstraction that deals
  3836. // with most of the system-dependent file name features such
  3837. // as the separator character, root, device name, etc.
  3838. // Not all features are currently fully implemented.
  3839. // Note that whenever a file name or path is  used it is
  3840. // assumed that the host's file name conventions are used.
  3841. DEF_ENDLIST
  3842. DEF_METHOD
  3843. public File(String path)
  3844. //    Creates a File object.
  3845. //   
  3846. //      Parameters:
  3847. //      path - the file path
  3848. //      Throws: NullPointerException
  3849. //      If the file path is equal to 
  3850. // null.
  3851. //   
  3852. // 
  3853. DEF_ENDLIST
  3854. DEF_METHOD
  3855. public File(String path,
  3856.             String name)
  3857. //    Creates a File object from the specified directory.
  3858. //   
  3859. //      Parameters:
  3860. //      path - the directory path
  3861. //      name - the file name
  3862. //   
  3863. // 
  3864. DEF_ENDLIST
  3865. DEF_METHOD
  3866. public File(File dir,
  3867.             String name)
  3868. //    Creates a File object (given a directory File object).
  3869. //   
  3870. //      Parameters:
  3871. //      dir - the directory
  3872. //      name - the file name
  3873. //   
  3874. // 
  3875. DEF_ENDLIST
  3876. DEF_METHOD
  3877. public String getName()
  3878. //    Gets the name of the file. This method does not include the
  3879. // directory.
  3880. //   
  3881. //      Returns:
  3882. //      the file name.
  3883. //   
  3884. // 
  3885. DEF_ENDLIST
  3886. DEF_METHOD
  3887. public String getPath()
  3888. //    Gets the path of the file.
  3889. //   
  3890. //      Returns:
  3891. //      the file path.
  3892. //   
  3893. // 
  3894. DEF_ENDLIST
  3895. DEF_METHOD
  3896. public String getAbsolutePath()
  3897. //    Gets the absolute path of the file.
  3898. //   
  3899. //      Returns:
  3900. //      the absolute file path.
  3901. //   
  3902. // 
  3903. DEF_ENDLIST
  3904. DEF_METHOD
  3905. public String getParent()
  3906. //    Gets the name of the parent directory.
  3907. //   
  3908. //      Returns:
  3909. //      the parent directory, or null if one is not found.
  3910. //   
  3911. // 
  3912. DEF_ENDLIST
  3913. DEF_METHOD
  3914. public boolean exists()
  3915. //    Returns a boolean indicating whether or not a file exists.
  3916. // 
  3917. DEF_ENDLIST
  3918. DEF_METHOD
  3919. public boolean canWrite()
  3920. //    Returns a boolean indicating whether or not a writable file 
  3921. // exists.
  3922. // 
  3923. DEF_ENDLIST
  3924. DEF_METHOD
  3925. public boolean canRead()
  3926. //    Returns a boolean indicating whether or not a readable file 
  3927. // exists.
  3928. // 
  3929. DEF_ENDLIST
  3930. DEF_METHOD
  3931. public boolean isFile()
  3932. //    Returns a boolean indicating whether or not a normal file 
  3933. // exists.
  3934. // 
  3935. DEF_ENDLIST
  3936. DEF_METHOD
  3937. public boolean isDirectory()
  3938. //    Returns a boolean indicating whether or not a directory file 
  3939. // exists.
  3940. // 
  3941. DEF_ENDLIST
  3942. DEF_METHOD
  3943. public boolean isAbsolute()
  3944. //    Returns a boolean indicating whether the file name is absolute.
  3945. // 
  3946. DEF_ENDLIST
  3947. DEF_METHOD
  3948. public long lastModified()
  3949. //    Returns the last modification time. The return value should
  3950. // only be used to compare modification dates. It is meaningless
  3951. // as an absolute time.
  3952. // 
  3953. DEF_ENDLIST
  3954. DEF_METHOD
  3955. public long length()
  3956. //    Returns the length of the file.
  3957. // 
  3958. DEF_ENDLIST
  3959. DEF_METHOD
  3960. public boolean mkdir()
  3961. //    Creates a directory and returns a boolean indicating the
  3962. // success of the creation.
  3963. // 
  3964. DEF_ENDLIST
  3965. DEF_METHOD
  3966. public boolean renameTo(File dest)
  3967. //    Renames a file and returns a boolean indicating whether 
  3968. // or not this method was successful.
  3969. //   
  3970. //      Parameters:
  3971. //      dest - the new file name
  3972. //   
  3973. // 
  3974. DEF_ENDLIST
  3975. DEF_METHOD
  3976. public boolean mkdirs()
  3977. //    Creates all directories in this path.  This method 
  3978. // returns true if all directories in this path are created.
  3979. // 
  3980. DEF_ENDLIST
  3981. DEF_METHOD
  3982. public String[] list()
  3983. //    Lists the files in a directory. Works only on directories.
  3984. //   
  3985. //      Returns:
  3986. //      an array of file names.  This list will include all
  3987. // files in the directory except the equivalent of "." and ".." .
  3988. //   
  3989. // 
  3990. DEF_ENDLIST
  3991. DEF_METHOD
  3992. public String[] list(FilenameFilter filter)
  3993. //    Uses the specified filter to list files in a directory.
  3994. //   
  3995. //      Parameters:
  3996. //      filter - the filter used to select file names
  3997. //      Returns:
  3998. //      the filter selected files in this directory.
  3999. //      See Also:
  4000. //      FilenameFilter
  4001. //   
  4002. // 
  4003. DEF_ENDLIST
  4004. DEF_METHOD
  4005. public boolean delete()
  4006. //    Deletes the specified file. Returns true
  4007. // if the file could be deleted.
  4008. // 
  4009. DEF_ENDLIST
  4010. DEF_METHOD
  4011. public int hashCode()
  4012. //    Computes a hashcode for the file.
  4013. //   
  4014. //      Overrides:
  4015. //      hashCode in class Object
  4016. //   
  4017. // 
  4018. DEF_ENDLIST
  4019. DEF_METHOD
  4020. public boolean equals(Object obj)
  4021. //    Compares this object against the specified object.
  4022. //   
  4023. //      Parameters:
  4024. //      obj - the object to compare with
  4025. //      Returns:
  4026. //      true if the objects are the same; false otherwise.
  4027. //      Overrides:
  4028. //      equals in class Object
  4029. //   
  4030. // 
  4031. DEF_ENDLIST
  4032. DEF_METHOD
  4033. public String toString()
  4034. //    Returns a String object representing this file's path.
  4035. //   
  4036. //      Overrides:
  4037. //      toString in class Object
  4038. //   
  4039. // 
  4040. DEF_ENDLIST
  4041. DEF_ENDCOMPONENT
  4042. DEF_COMPONENTNAME
  4043. FileDescriptor
  4044. DEF_SUPERCLASS
  4045. Object
  4046. DEF_SUPERCOMPONENT
  4047.  
  4048. DEF_PACKAGE
  4049. java
  4050. io
  4051. DEF_ENDLIST
  4052. DEF_SUBCOMPONENTLIST
  4053. DEF_ENDLIST
  4054. DEF_SUBCOMPONENTCLASSLIST
  4055. DEF_ENDLIST
  4056. DEF_CATEGORY
  4057.  
  4058. DEF_BITMAP
  4059.  
  4060. DEF_THUMBNAIL_UP
  4061.  
  4062. DEF_THUMBNAIL_DOWN
  4063.  
  4064. DEF_BASE
  4065. DEF_IMPORTS
  4066. java.io.FileDescriptor
  4067. DEF_ENDLIST
  4068. DEF_REQUIRES
  4069. DEF_ENDLIST
  4070. DEF_IMPLEMENTS
  4071. DEF_ENDLIST
  4072. DEF_DECLARATION
  4073. DEF_ENDLIST
  4074. DEF_METHOD
  4075. public FileDescriptor()
  4076. //    Determines whether the file descriptor object is valid.
  4077. // 
  4078. DEF_ENDLIST
  4079. DEF_ENDCOMPONENT
  4080. DEF_COMPONENTNAME
  4081. FileInputStream
  4082. DEF_SUPERCLASS
  4083. InputStream
  4084. DEF_SUPERCOMPONENT
  4085.  
  4086. DEF_PACKAGE
  4087. java
  4088. io
  4089. DEF_ENDLIST
  4090. DEF_SUBCOMPONENTLIST
  4091. DEF_ENDLIST
  4092. DEF_SUBCOMPONENTCLASSLIST
  4093. DEF_ENDLIST
  4094. DEF_CATEGORY
  4095.  
  4096. DEF_BITMAP
  4097.  
  4098. DEF_THUMBNAIL_UP
  4099.  
  4100. DEF_THUMBNAIL_DOWN
  4101.  
  4102. DEF_BASE
  4103. DEF_IMPORTS
  4104. java.io.FileInputStream
  4105. DEF_ENDLIST
  4106. DEF_REQUIRES
  4107. DEF_ENDLIST
  4108. DEF_IMPLEMENTS
  4109. DEF_ENDLIST
  4110. DEF_DECLARATION
  4111. // File input stream, can be constructed from
  4112. // a file descriptor or a file name.
  4113. // 
  4114. //      See Also:
  4115. //      FileOutputStream, File
  4116. // 
  4117. DEF_ENDLIST
  4118. DEF_METHOD
  4119. public FileInputStream(String name) throws FileNotFoundException
  4120. //    Creates an input file with the specified system dependent file 
  4121. // name.
  4122. //   
  4123. //      Parameters:
  4124. //      name - the system dependent file name
  4125. //      Throws: IOException
  4126. //      If the file is not found.
  4127. //   
  4128. // 
  4129. DEF_ENDLIST
  4130. DEF_METHOD
  4131. public FileInputStream(File file) throws FileNotFoundException
  4132. //    Creates an input file from the specified File object.
  4133. //   
  4134. //      Parameters:
  4135. //      file - the file to be opened for reading
  4136. //      Throws: IOException
  4137. //      If the file is not found.
  4138. //   
  4139. // 
  4140. DEF_ENDLIST
  4141. DEF_METHOD
  4142. public FileInputStream(FileDescriptor fdObj)
  4143. //    Reads a byte of data. This method will block if no input is 
  4144. // available.
  4145. //   
  4146. //      Returns:
  4147. //      the byte read, or -1 if the end of the
  4148. //         stream is reached.
  4149. //      Throws: IOException
  4150. //      If an I/O error has occurred.
  4151. //      Overrides:
  4152. //      read in class InputStream
  4153. //   
  4154. // 
  4155. DEF_ENDLIST
  4156. DEF_METHOD
  4157. public int read(byte b[]) throws IOException
  4158. //    Reads data into an array of bytes.
  4159. // This method blocks until some input is available.
  4160. //   
  4161. //      Parameters:
  4162. //      b - the buffer into which the data is read
  4163. //      Returns:
  4164. //      the actual number of bytes read. -1 is
  4165. //         returned if the end of stream is reached.
  4166. //      Throws: IOException
  4167. //      If an I/O error has occurred.
  4168. //      Overrides:
  4169. //      read in class InputStream
  4170. //   
  4171. // 
  4172. DEF_ENDLIST
  4173. DEF_METHOD
  4174. public int read(byte b[],
  4175.                 int off,
  4176.                 int len) throws IOException
  4177. //    Reads data into an array of bytes.
  4178. // This method blocks until some input is available.
  4179. //   
  4180. //      Parameters:
  4181. //      b - the buffer into which the data is read
  4182. //      off - the start offset of the data
  4183. //      len - the maximum number of bytes read
  4184. //      Returns:
  4185. //      the actual number of bytes read. -1 is
  4186. //         returned when the end of the stream is reached.
  4187. //      Throws: IOException
  4188. //      If an I/O error has occurred.
  4189. //      Overrides:
  4190. //      read in class InputStream
  4191. //   
  4192. // 
  4193. DEF_ENDLIST
  4194. DEF_METHOD
  4195. public long skip(long n) throws IOException
  4196. //    Skips n bytes of input.
  4197. //   
  4198. //      Parameters:
  4199. //      n - the number of bytes to be skipped
  4200. //      Returns:
  4201. //      the actual number of bytes skipped.
  4202. //      Throws: IOException
  4203. //      If an I/O error has occurred.
  4204. //      Overrides:
  4205. //      skip in class InputStream
  4206. //   
  4207. // 
  4208. DEF_ENDLIST
  4209. DEF_METHOD
  4210. public int available() throws IOException
  4211. //    Returns the number of bytes that can be read
  4212. // without blocking.
  4213. //   
  4214. //      Returns:
  4215. //      the number of available bytes, which is initially
  4216. //         equal to the file size.
  4217. //      Overrides:
  4218. //      available in class InputStream
  4219. //   
  4220. // 
  4221. DEF_ENDLIST
  4222. DEF_METHOD
  4223. public void close() throws IOException
  4224. //    Closes the input stream. This method must be called
  4225. // to release any resources associated with
  4226. // the stream.
  4227. //   
  4228. //      Throws: IOException
  4229. //      If an I/O error has occurred.
  4230. //      Overrides:
  4231. //      close in class InputStream
  4232. //   
  4233. // 
  4234. DEF_ENDLIST
  4235. DEF_METHOD
  4236. public final FileDescriptor getFD() throws IOException
  4237. //    Returns the opaque file descriptor object associated with this stream.
  4238. //   
  4239. //      Returns:
  4240. //      the file descriptor.
  4241. //   
  4242. // 
  4243. DEF_ENDLIST
  4244. DEF_METHOD
  4245. protected void finalize() throws IOException
  4246. //    Closes the stream when garbage is collected.
  4247. //   
  4248. //      Overrides:
  4249. //      finalize in class Object
  4250. //   
  4251. // 
  4252. DEF_ENDLIST
  4253. DEF_ENDCOMPONENT
  4254. DEF_COMPONENTNAME
  4255. FileNotFoundException
  4256. DEF_SUPERCLASS
  4257. IOException
  4258. DEF_SUPERCOMPONENT
  4259.  
  4260. DEF_PACKAGE
  4261. java
  4262. io
  4263. DEF_ENDLIST
  4264. DEF_SUBCOMPONENTLIST
  4265. DEF_ENDLIST
  4266. DEF_SUBCOMPONENTCLASSLIST
  4267. DEF_ENDLIST
  4268. DEF_CATEGORY
  4269.  
  4270. DEF_BITMAP
  4271.  
  4272. DEF_THUMBNAIL_UP
  4273.  
  4274. DEF_THUMBNAIL_DOWN
  4275.  
  4276. DEF_BASE
  4277. DEF_IMPORTS
  4278. java.io.FileNotFoundException
  4279. DEF_ENDLIST
  4280. DEF_REQUIRES
  4281. DEF_ENDLIST
  4282. DEF_IMPLEMENTS
  4283. DEF_ENDLIST
  4284. DEF_DECLARATION
  4285. // Signals that a file was not found.
  4286. DEF_ENDLIST
  4287. DEF_METHOD
  4288. public FileNotFoundException()
  4289. //    Constructs a FileNotFoundException with no detail message.  
  4290. // A detail message is a String that describes this particular exception.
  4291. // 
  4292. DEF_ENDLIST
  4293. DEF_METHOD
  4294. public FileNotFoundException(String s)
  4295. //    Constructs a FileNotFoundException with the specified detail message.
  4296. // A detail message is a String that describes this particular exception.
  4297. //   
  4298. //      Parameters:
  4299. //      s - the detail message
  4300. //   
  4301. // 
  4302. DEF_ENDLIST
  4303. DEF_ENDCOMPONENT
  4304. DEF_COMPONENTNAME
  4305. FileOutputStream
  4306. DEF_SUPERCLASS
  4307. OutputStream
  4308. DEF_SUPERCOMPONENT
  4309.  
  4310. DEF_PACKAGE
  4311. java
  4312. io
  4313. DEF_ENDLIST
  4314. DEF_SUBCOMPONENTLIST
  4315. DEF_ENDLIST
  4316. DEF_SUBCOMPONENTCLASSLIST
  4317. DEF_ENDLIST
  4318. DEF_CATEGORY
  4319.  
  4320. DEF_BITMAP
  4321.  
  4322. DEF_THUMBNAIL_UP
  4323.  
  4324. DEF_THUMBNAIL_DOWN
  4325.  
  4326. DEF_BASE
  4327. DEF_IMPORTS
  4328. java.io.FileOutputStream
  4329. DEF_ENDLIST
  4330. DEF_REQUIRES
  4331. DEF_ENDLIST
  4332. DEF_IMPLEMENTS
  4333. DEF_ENDLIST
  4334. DEF_DECLARATION
  4335. // File output stream, can be constructed from
  4336. // a file descriptor or a file name.
  4337. // 
  4338. //      See Also:
  4339. //      FileInputStream, File
  4340. // 
  4341. DEF_ENDLIST
  4342. DEF_METHOD
  4343. public FileOutputStream(String name) throws IOException
  4344. //    Creates an output file with the specified system dependent
  4345. // file name.
  4346. //   
  4347. //      Parameters:
  4348. //      name - the system dependent file name
  4349. //      Throws: IOException
  4350. //      If the file is not found.
  4351. //   
  4352. // 
  4353. DEF_ENDLIST
  4354. DEF_METHOD
  4355. public FileOutputStream(File file) throws IOException
  4356. //    Creates an output file with the specified File object.
  4357. //   
  4358. //      Parameters:
  4359. //      file - the file to be opened for reading
  4360. //      Throws: IOException
  4361. //      If the file is not found.
  4362. //   
  4363. // 
  4364. DEF_ENDLIST
  4365. DEF_METHOD
  4366. public FileOutputStream(FileDescriptor fdObj)
  4367. //    Writes a byte of data. This method will block until the byte is 
  4368. // actually written.
  4369. //   
  4370. //      Parameters:
  4371. //      b - the byte to be written
  4372. //      Throws: IOException
  4373. //      If an I/O error has occurred.
  4374. //      Overrides:
  4375. //      write in class OutputStream
  4376. //   
  4377. // 
  4378. DEF_ENDLIST
  4379. DEF_METHOD
  4380. public void write(byte b[]) throws IOException
  4381. //    Writes an array of bytes. Will block until the bytes
  4382. // are actually written.
  4383. //   
  4384. //      Parameters:
  4385. //      b - the data to be written
  4386. //      Throws: IOException
  4387. //      If an I/O error has occurred.
  4388. //      Overrides:
  4389. //      write in class OutputStream
  4390. //   
  4391. // 
  4392. DEF_ENDLIST
  4393. DEF_METHOD
  4394. public void write(byte b[],
  4395.                   int off,
  4396.                   int len) throws IOException
  4397. //    Writes a sub array of bytes.
  4398. //   
  4399. //      Parameters:
  4400. //      b - the data to be written
  4401. //      off - the start offset in the data
  4402. //      len - the number of bytes that are written
  4403. //      Throws: IOException
  4404. //      If an I/O error has occurred.
  4405. //      Overrides:
  4406. //      write in class OutputStream
  4407. //   
  4408. // 
  4409. DEF_ENDLIST
  4410. DEF_METHOD
  4411. public void close() throws IOException
  4412. //    Closes the stream. This method must be called
  4413. // to release any resources associated with the
  4414. // stream.
  4415. //   
  4416. //      Throws: IOException
  4417. //      If an I/O error has occurred.
  4418. //      Overrides:
  4419. //      close in class OutputStream
  4420. //   
  4421. // 
  4422. DEF_ENDLIST
  4423. DEF_METHOD
  4424. public final FileDescriptor getFD() throws IOException
  4425. //    Returns the file descriptor associated with this stream.
  4426. //   
  4427. //      Returns:
  4428. //      the file descriptor.
  4429. //   
  4430. // 
  4431. DEF_ENDLIST
  4432. DEF_METHOD
  4433. protected void finalize() throws IOException
  4434. //    Closes the stream when garbage is collected.
  4435. //   
  4436. //      Overrides:
  4437. //      finalize in class Object
  4438. //   
  4439. // 
  4440. DEF_ENDLIST
  4441. DEF_ENDCOMPONENT
  4442. DEF_COMPONENTNAME
  4443. FilterInputStream
  4444. DEF_SUPERCLASS
  4445. InputStream
  4446. DEF_SUPERCOMPONENT
  4447.  
  4448. DEF_PACKAGE
  4449. java
  4450. io
  4451. DEF_ENDLIST
  4452. DEF_SUBCOMPONENTLIST
  4453. DEF_ENDLIST
  4454. DEF_SUBCOMPONENTCLASSLIST
  4455. DEF_ENDLIST
  4456. DEF_CATEGORY
  4457.  
  4458. DEF_BITMAP
  4459.  
  4460. DEF_THUMBNAIL_UP
  4461.  
  4462. DEF_THUMBNAIL_DOWN
  4463.  
  4464. DEF_BASE
  4465. DEF_IMPORTS
  4466. java.io.FilterInputStream
  4467. DEF_ENDLIST
  4468. DEF_REQUIRES
  4469. DEF_ENDLIST
  4470. DEF_IMPLEMENTS
  4471. DEF_ENDLIST
  4472. DEF_DECLARATION
  4473. // Abstract class representing a filtered input stream of bytes.
  4474. // This class is the basis for enhancing input stream functionality.
  4475. // It allows multiple input stream filters to be chained together,
  4476. // each providing additional functionality.
  4477. DEF_ENDLIST
  4478. DEF_METHOD
  4479. protected FilterInputStream(InputStream in)
  4480. //    Creates an input stream filter.
  4481. //   
  4482. //      Parameters:
  4483. //      in - the input stream
  4484. //   
  4485. // 
  4486. DEF_ENDLIST
  4487. DEF_METHOD
  4488. public int read() throws IOException
  4489. //    Reads a byte. Will block if no input is available.
  4490. //   
  4491. //      Returns:
  4492. //      the byte read, or -1 if the end of the
  4493. //         stream is reached.
  4494. //      Throws: IOException
  4495. //      If an I/O error has occurred.
  4496. //      Overrides:
  4497. //      read in class InputStream
  4498. //   
  4499. // 
  4500. DEF_ENDLIST
  4501. DEF_METHOD
  4502. public int read(byte b[]) throws IOException
  4503. //    Reads into an array of bytes.
  4504. // Blocks until some input is available.
  4505. //   
  4506. //      Parameters:
  4507. //      b - the buffer into which the data is read
  4508. //      Returns:
  4509. //      the actual number of bytes read. Returns -1
  4510. //         when the end of the stream is reached.
  4511. //      Throws: IOException
  4512. //      If an I/O error has occurred.
  4513. //      Overrides:
  4514. //      read in class InputStream
  4515. //   
  4516. // 
  4517. DEF_ENDLIST
  4518. DEF_METHOD
  4519. public int read(byte b[],
  4520.                 int off,
  4521.                 int len) throws IOException
  4522. //    Reads into an array of bytes.
  4523. // Blocks until some input is available.
  4524. // This method should be overridden in a subclass for
  4525. // efficiency (the default implementation reads 1 byte
  4526. // at a time).
  4527. //   
  4528. //      Parameters:
  4529. //      b - the buffer into which the data is read
  4530. //      off - the start offset of the data
  4531. //      len - the maximum number of bytes read
  4532. //      Returns:
  4533. //      the actual number of bytes read. Returns -1 
  4534. //         when the end of the stream is reached.
  4535. //      Throws: IOException
  4536. //      If an I/O error has occurred.
  4537. //      Overrides:
  4538. //      read in class InputStream
  4539. //   
  4540. // 
  4541. DEF_ENDLIST
  4542. DEF_METHOD
  4543. public long skip(long n) throws IOException
  4544. //    Skips bytes of input.
  4545. //   
  4546. //      Parameters:
  4547. //      n - bytes to be skipped
  4548. //      Returns:
  4549. //      actual number of bytes skipped
  4550. //      Throws: IOException
  4551. //      If an I/O error has occurred.
  4552. //      Overrides:
  4553. //      skip in class InputStream
  4554. //   
  4555. // 
  4556. DEF_ENDLIST
  4557. DEF_METHOD
  4558. public int available() throws IOException
  4559. //    Returns the number of bytes that can be read
  4560. // without blocking.
  4561. //   
  4562. //      Returns:
  4563. //      the number of available bytes
  4564. //      Overrides:
  4565. //      available in class InputStream
  4566. //   
  4567. // 
  4568. DEF_ENDLIST
  4569. DEF_METHOD
  4570. public void close() throws IOException
  4571. //    Closes the input stream. Must be called
  4572. // to release any resources associated with
  4573. // the stream.
  4574. //   
  4575. //      Throws: IOException
  4576. //      If an I/O error has occurred.
  4577. //      Overrides:
  4578. //      close in class InputStream
  4579. //   
  4580. // 
  4581. DEF_ENDLIST
  4582. DEF_METHOD
  4583. public synchronized void mark(int readlimit)
  4584. //    Marks the current position in the input stream.  A subsequent
  4585. // call to reset() will reposition the stream at the last
  4586. // marked position so that subsequent reads will re-read
  4587. // the same bytes.  The stream promises to allow readlimit bytes
  4588. // to be read before the mark position gets invalidated.
  4589. //   
  4590. //      Parameters:
  4591. //      readlimit - the maximum limit of bytes allowed tobe read before the
  4592. // mark position becomes invalid.
  4593. //      Overrides:
  4594. //      mark in class InputStream
  4595. //   
  4596. // 
  4597. DEF_ENDLIST
  4598. DEF_METHOD
  4599. public synchronized void reset() throws IOException
  4600. //    Repositions the stream to the last marked position.  If the
  4601. // stream has not been marked, or if the mark has been invalidated,
  4602. // an IOException is thrown.  Stream marks are intended to be used in
  4603. // situations where you need to read ahead a little to see what's in
  4604. // the stream.  Often this is most easily done by invoking some
  4605. // general parser.  If the stream is of the type handled by the
  4606. // parse, it just chugs along happily.  If the stream is not of
  4607. // that type, the parser should toss an exception when it fails.
  4608. // If this happens within readlimit bytes,  it allows the outer
  4609. // code to reset the stream and try another parser.
  4610. //   
  4611. //      Overrides:
  4612. //      reset in class InputStream
  4613. //   
  4614. // 
  4615. DEF_ENDLIST
  4616. DEF_METHOD
  4617. public boolean markSupported()
  4618. //    Returns true if this stream type supports mark/reset.
  4619. //   
  4620. //      Overrides:
  4621. //      markSupported in class InputStream
  4622. //   
  4623. // 
  4624. DEF_ENDLIST
  4625. DEF_ENDCOMPONENT
  4626. DEF_COMPONENTNAME
  4627. FilterOutputStream
  4628. DEF_SUPERCLASS
  4629. OutputStream
  4630. DEF_SUPERCOMPONENT
  4631.  
  4632. DEF_PACKAGE
  4633. java
  4634. io
  4635. DEF_ENDLIST
  4636. DEF_SUBCOMPONENTLIST
  4637. DEF_ENDLIST
  4638. DEF_SUBCOMPONENTCLASSLIST
  4639. DEF_ENDLIST
  4640. DEF_CATEGORY
  4641.  
  4642. DEF_BITMAP
  4643.  
  4644. DEF_THUMBNAIL_UP
  4645.  
  4646. DEF_THUMBNAIL_DOWN
  4647.  
  4648. DEF_BASE
  4649. DEF_IMPORTS
  4650. java.io.FilterOutputStream
  4651. DEF_ENDLIST
  4652. DEF_REQUIRES
  4653. DEF_ENDLIST
  4654. DEF_IMPLEMENTS
  4655. DEF_ENDLIST
  4656. DEF_DECLARATION
  4657. // Abstract class representing a filtered output stream of bytes.
  4658. // This class is the basis for enhancing output stream functionality.
  4659. // It allows multiple output stream filters to be chained together,
  4660. // each providing additional functionality.
  4661. DEF_ENDLIST
  4662. DEF_METHOD
  4663. public FilterOutputStream(OutputStream out)
  4664. //    Creates an output stream filter.
  4665. //   
  4666. //      Parameters:
  4667. //      out - the output stream
  4668. //   
  4669. // 
  4670. DEF_ENDLIST
  4671. DEF_METHOD
  4672. public void write(int b) throws IOException
  4673. //    Writes a byte. Will block until the byte is actually
  4674. // written.
  4675. //   
  4676. //      Parameters:
  4677. //      b - the byte
  4678. //      Throws: IOException
  4679. //      If an I/O error has occurred.
  4680. //      Overrides:
  4681. //      write in class OutputStream
  4682. //   
  4683. // 
  4684. DEF_ENDLIST
  4685. DEF_METHOD
  4686. public void write(byte b[]) throws IOException
  4687. //    Writes an array of bytes. Will block until the bytes
  4688. // are actually written.
  4689. //   
  4690. //      Parameters:
  4691. //      b - the data to be written
  4692. //      Throws: IOException
  4693. //      If an I/O error has occurred.
  4694. //      Overrides:
  4695. //      write in class OutputStream
  4696. //   
  4697. // 
  4698. DEF_ENDLIST
  4699. DEF_METHOD
  4700. public void write(byte b[],
  4701.                   int off,
  4702.                   int len) throws IOException
  4703. //    Writes a subarray of bytes. To be efficient it should
  4704. // be overridden in a subclass.
  4705. //   
  4706. //      Parameters:
  4707. //      b - the data to be written
  4708. //      off - the start offset in the data
  4709. //      len - the number of bytes that are written
  4710. //      Throws: IOException
  4711. //      If an I/O error has occurred.
  4712. //      Overrides:
  4713. //      write in class OutputStream
  4714. //   
  4715. // 
  4716. DEF_ENDLIST
  4717. DEF_METHOD
  4718. public void flush() throws IOException
  4719. //    Flushes the stream. This will write any buffered
  4720. // output bytes.
  4721. //   
  4722. //      Throws: IOException
  4723. //      If an I/O error has occurred.
  4724. //      Overrides:
  4725. //      flush in class OutputStream
  4726. //   
  4727. // 
  4728. DEF_ENDLIST
  4729. DEF_METHOD
  4730. public void close() throws IOException
  4731. //    Closes the stream. This method must be called
  4732. // to release any resources associated with the
  4733. // stream.
  4734. //   
  4735. //      Throws: IOException
  4736. //      If an I/O error has occurred.
  4737. //      Overrides:
  4738. //      close in class OutputStream
  4739. //   
  4740. // 
  4741. DEF_ENDLIST
  4742. DEF_ENDCOMPONENT
  4743. DEF_COMPONENTNAME
  4744. InputStream
  4745. DEF_SUPERCLASS
  4746. Object
  4747. DEF_SUPERCOMPONENT
  4748.  
  4749. DEF_PACKAGE
  4750. java
  4751. io
  4752. DEF_ENDLIST
  4753. DEF_SUBCOMPONENTLIST
  4754. DEF_ENDLIST
  4755. DEF_SUBCOMPONENTCLASSLIST
  4756. DEF_ENDLIST
  4757. DEF_CATEGORY
  4758.  
  4759. DEF_BITMAP
  4760.  
  4761. DEF_THUMBNAIL_UP
  4762.  
  4763. DEF_THUMBNAIL_DOWN
  4764.  
  4765. DEF_BASE
  4766. DEF_IMPORTS
  4767. java.io.InputStream
  4768. DEF_ENDLIST
  4769. DEF_REQUIRES
  4770. DEF_ENDLIST
  4771. DEF_IMPLEMENTS
  4772. DEF_ENDLIST
  4773. DEF_DECLARATION
  4774. // An abstract class representing an input stream of bytes.
  4775. // All InputStreams are based on this class.
  4776. // 
  4777. //      See Also:
  4778. //      OutputStream, FilterInputStream, BufferedInputStream, DataInputStream, ByteArrayInputStream, PushbackInputStream
  4779. // 
  4780. DEF_ENDLIST
  4781. DEF_METHOD
  4782. public InputStream()
  4783. //    Reads a byte of data. This method will block if no input is 
  4784. // available.
  4785. //   
  4786. //      Returns:
  4787. //      the byte read, or -1 if the end of the
  4788. //         stream is reached.
  4789. //      Throws: IOException
  4790. //      If an I/O error has occurred.
  4791. //   
  4792. // 
  4793. DEF_ENDLIST
  4794. DEF_METHOD
  4795. public int read(byte b[]) throws IOException
  4796. //    Reads into an array of bytes.  This method will
  4797. // block until some input is available.
  4798. //   
  4799. //      Parameters:
  4800. //      b - the buffer into which the data is read
  4801. //      Returns:
  4802. //      the actual number of bytes read, -1 is
  4803. //         returned when the end of the stream is reached.
  4804. //      Throws: IOException
  4805. //      If an I/O error has occurred.
  4806. //   
  4807. // 
  4808. DEF_ENDLIST
  4809. DEF_METHOD
  4810. public int read(byte b[],
  4811.                 int off,
  4812.                 int len) throws IOException
  4813. //    Reads into an array of bytes.  This method will
  4814. // block until some input is available.
  4815. //   
  4816. //      Parameters:
  4817. //      b - the buffer into which the data is read
  4818. //      off - the start offset of the data
  4819. //      len - the maximum number of bytes read
  4820. //      Returns:
  4821. //      the actual number of bytes read, -1 is
  4822. //         returned when the end of the stream is reached.
  4823. //      Throws: IOException
  4824. //      If an I/O error has occurred.
  4825. //   
  4826. // 
  4827. DEF_ENDLIST
  4828. DEF_METHOD
  4829. public long skip(long n) throws IOException
  4830. //    Skips n bytes of input.
  4831. //   
  4832. //      Parameters:
  4833. //      n - the number of bytes to be skipped
  4834. //      Returns:
  4835. //      the actual number of bytes skipped.
  4836. //      Throws: IOException
  4837. //      If an I/O error has occurred.
  4838. //   
  4839. // 
  4840. DEF_ENDLIST
  4841. DEF_METHOD
  4842. public int available() throws IOException
  4843. //    Returns the number of bytes that can be read
  4844. // without blocking.
  4845. //   
  4846. //      Returns:
  4847. //      the number of available bytes.
  4848. //   
  4849. // 
  4850. DEF_ENDLIST
  4851. DEF_METHOD
  4852. public void close() throws IOException
  4853. //    Closes the input stream. Must be called
  4854. // to release any resources associated with
  4855. // the stream.
  4856. //   
  4857. //      Throws: IOException
  4858. //      If an I/O error has occurred.
  4859. //   
  4860. // 
  4861. DEF_ENDLIST
  4862. DEF_METHOD
  4863. public synchronized void mark(int readlimit)
  4864. //    Marks the current position in the input stream.  A subsequent
  4865. // call to reset() will reposition the stream at the last
  4866. // marked position so that subsequent reads will re-read
  4867. // the same bytes.  The stream promises to allow readlimit bytes
  4868. // to be read before the mark position gets invalidated.
  4869. //   
  4870. //      Parameters:
  4871. //      readlimit - the maximum limit of bytes allowed to be read
  4872. // before the mark position becomes invalid.
  4873. //   
  4874. // 
  4875. DEF_ENDLIST
  4876. DEF_METHOD
  4877. public synchronized void reset() throws IOException
  4878. //    Repositions the stream to the last marked position.  If the
  4879. // stream has not been marked, or if the mark has been invalidated,
  4880. // an IOException is thrown.  Stream marks are intended to be used in
  4881. // situations where you need to read ahead a little to see what's in
  4882. // the stream.  Often this is most easily done by invoking some
  4883. // general parser.  If the stream is of the type handled by the
  4884. // parser, it just chugs along happily.  If the stream is not of
  4885. // that type, the parser should toss an exception when it fails,
  4886. // which, if it happens within readlimit bytes, allows the outer
  4887. // code to reset the stream and try another parser.
  4888. //   
  4889. //      Throws: IOException
  4890. //      If the stream has not been marked or 
  4891. // if the mark has been invalidated.
  4892. //   
  4893. // 
  4894. DEF_ENDLIST
  4895. DEF_METHOD
  4896. public boolean markSupported()
  4897. //    Returns a boolean indicating whether or not this stream type 
  4898. // supports mark/reset.
  4899. //   
  4900. //      Returns:
  4901. //      true if this stream type supports mark/reset; false
  4902. // otherwise.
  4903. //   
  4904. // 
  4905. DEF_ENDLIST
  4906. DEF_ENDCOMPONENT
  4907. DEF_COMPONENTNAME
  4908. IOException
  4909. DEF_SUPERCLASS
  4910. Exception
  4911. DEF_SUPERCOMPONENT
  4912.  
  4913. DEF_PACKAGE
  4914. java
  4915. io
  4916. DEF_ENDLIST
  4917. DEF_SUBCOMPONENTLIST
  4918. DEF_ENDLIST
  4919. DEF_SUBCOMPONENTCLASSLIST
  4920. DEF_ENDLIST
  4921. DEF_CATEGORY
  4922.  
  4923. DEF_BITMAP
  4924.  
  4925. DEF_THUMBNAIL_UP
  4926.  
  4927. DEF_THUMBNAIL_DOWN
  4928.  
  4929. DEF_BASE
  4930. DEF_IMPORTS
  4931. java.io.IOException
  4932. DEF_ENDLIST
  4933. DEF_REQUIRES
  4934. DEF_ENDLIST
  4935. DEF_IMPLEMENTS
  4936. DEF_ENDLIST
  4937. DEF_DECLARATION
  4938. // Signals that an I/O exception has occurred.
  4939. // 
  4940. //      See Also:
  4941. //      InputStream, OutputStream
  4942. // 
  4943. DEF_ENDLIST
  4944. DEF_METHOD
  4945. public IOException()
  4946. //    Constructs an IOException with no detail message.
  4947. // A detail message is a String that describes this particular exception.
  4948. // 
  4949. DEF_ENDLIST
  4950. DEF_METHOD
  4951. public IOException(String s)
  4952. //    Constructs an IOException with the specified detail message.
  4953. // A detail message is a String that describes this particular exception.
  4954. //   
  4955. //      Parameters:
  4956. //      s - the detail message
  4957. //   
  4958. // 
  4959. DEF_ENDLIST
  4960. DEF_ENDCOMPONENT
  4961. DEF_COMPONENTNAME
  4962. Double
  4963. DEF_SUPERCLASS
  4964. Number
  4965. DEF_SUPERCOMPONENT
  4966.  
  4967. DEF_PACKAGE
  4968. java
  4969. lang
  4970. DEF_ENDLIST
  4971. DEF_SUBCOMPONENTLIST
  4972. DEF_ENDLIST
  4973. DEF_SUBCOMPONENTCLASSLIST
  4974. DEF_ENDLIST
  4975. DEF_CATEGORY
  4976.  
  4977. DEF_BITMAP
  4978.  
  4979. DEF_THUMBNAIL_UP
  4980.  
  4981. DEF_THUMBNAIL_DOWN
  4982.  
  4983. DEF_BASE
  4984. DEF_IMPORTS
  4985. DEF_ENDLIST
  4986. DEF_REQUIRES
  4987. DEF_ENDLIST
  4988. DEF_IMPLEMENTS
  4989. DEF_ENDLIST
  4990. DEF_DECLARATION
  4991. // The Double class provides an object wrapper for Double data values and serves 
  4992. // as a place for double-oriented operations.  A wrapper is useful because most of
  4993. // Java's utility classes require the use of objects.  Since doubles are not 
  4994. // objects in Java, they need to be "wrapped" in a Double instance.
  4995. DEF_ENDLIST
  4996. DEF_METHOD
  4997. public Double(double value)
  4998. //    Constructs a Double wrapper for the specified double value.
  4999. //   
  5000. //      Parameters:
  5001. //      value - the initial value of the double
  5002. //   
  5003. // 
  5004. DEF_ENDLIST
  5005. DEF_METHOD
  5006. public Double(String s) throws NumberFormatException
  5007. //    Constructs a Double object initialized to the value specified by the
  5008. // String parameter.
  5009. //   
  5010. //      Parameters:
  5011. //      s - the String to be converted to a Double
  5012. //      Throws: NumberFormatException
  5013. //      If the String does not contain a parsable number.
  5014. //   
  5015. // 
  5016. DEF_ENDLIST
  5017. DEF_METHOD
  5018. public static String toString(double d)
  5019. //    Returns a String representation for the specified double value.
  5020. //   
  5021. //      Parameters:
  5022. //      d - the double to be converted
  5023. //   
  5024. // 
  5025. DEF_ENDLIST
  5026. DEF_METHOD
  5027. public static Double valueOf(String s) throws NumberFormatException
  5028. //    Returns a new Double value initialized to the value represented by the 
  5029. // specified String.
  5030. //   
  5031. //      Parameters:
  5032. //      s - the String to be parsed
  5033. //      Throws: NumberFormatException
  5034. //      If the String cannot be parsed.
  5035. //   
  5036. // 
  5037. DEF_ENDLIST
  5038. DEF_METHOD
  5039. public static boolean isNaN(double v)
  5040. //    Returns true if the specified number is the special Not-a-Number (NaN) value.
  5041. //   
  5042. //      Parameters:
  5043. //      v - the value to be tested
  5044. //   
  5045. // 
  5046. DEF_ENDLIST
  5047. DEF_METHOD
  5048. public static boolean isInfinite(double v)
  5049. //    Returns true if the specified number is infinitely large in magnitude.
  5050. //   
  5051. //      Parameters:
  5052. //      v - the value to be tested
  5053. //   
  5054. // 
  5055. DEF_ENDLIST
  5056. DEF_METHOD
  5057. public boolean isNaN()
  5058. //    Returns true if this Double value is the special Not-a-Number (NaN) value.
  5059. // 
  5060. DEF_ENDLIST
  5061. DEF_METHOD
  5062. public boolean isInfinite()
  5063. //    Returns true if this Double value is infinitely large in magnitude.
  5064. // 
  5065. DEF_ENDLIST
  5066. DEF_METHOD
  5067. public String toString()
  5068. //    Returns a String representation of this Double object.
  5069. //   
  5070. //      Overrides:
  5071. //      toString in class Object
  5072. //   
  5073. // 
  5074. DEF_ENDLIST
  5075. DEF_METHOD
  5076. public int intValue()
  5077. //    Returns the integer value of this Double (by casting to an int).
  5078. //   
  5079. //      Overrides:
  5080. //      intValue in class Number
  5081. //   
  5082. // 
  5083. DEF_ENDLIST
  5084. DEF_METHOD
  5085. public long longValue()
  5086. //    Returns the long value of this Double (by casting to a long).
  5087. //   
  5088. //      Overrides:
  5089. //      longValue in class Number
  5090. //   
  5091. // 
  5092. DEF_ENDLIST
  5093. DEF_METHOD
  5094. public float floatValue()
  5095. //    Returns the float value of this Double.
  5096. //   
  5097. //      Overrides:
  5098. //      floatValue in class Number
  5099. //   
  5100. // 
  5101. DEF_ENDLIST
  5102. DEF_METHOD
  5103. public double doubleValue()
  5104. //    Returns the double value of this Double.
  5105. //   
  5106. //      Overrides:
  5107. //      doubleValue in class Number
  5108. //   
  5109. // 
  5110. DEF_ENDLIST
  5111. DEF_METHOD
  5112. public int hashCode()
  5113. //    Returns a hashcode for this Double.
  5114. //   
  5115. //      Overrides:
  5116. //      hashCode in class Object
  5117. //   
  5118. // 
  5119. DEF_ENDLIST
  5120. DEF_METHOD
  5121. public boolean equals(Object obj)
  5122. //    Compares this object against the specified object.
  5123. // 
  5124. // Note: To be useful in hashtables this method
  5125. // considers two NaN double values to be equal. This
  5126. // is not according to IEEE specification
  5127. //   
  5128. //      Parameters:
  5129. //      obj - the object to compare with
  5130. //      Returns:
  5131. //      true if the objects are the same; false otherwise.
  5132. //      Overrides:
  5133. //      equals in class Object
  5134. //   
  5135. // 
  5136. DEF_ENDLIST
  5137. DEF_METHOD
  5138. public static long doubleToLongBits(double value)
  5139. //    Returns the bit represention of a double-float value
  5140. // 
  5141. DEF_ENDLIST
  5142. DEF_METHOD
  5143. public static double longBitsToDouble(long bits)
  5144. //    Returns the double-float corresponding to a given bit represention.
  5145. // 
  5146. DEF_ENDLIST
  5147. DEF_ENDCOMPONENT
  5148. DEF_COMPONENTNAME
  5149. Error
  5150. DEF_SUPERCLASS
  5151. Throwable
  5152. DEF_SUPERCOMPONENT
  5153.  
  5154. DEF_PACKAGE
  5155. java
  5156. lang
  5157. DEF_ENDLIST
  5158. DEF_SUBCOMPONENTLIST
  5159. DEF_ENDLIST
  5160. DEF_SUBCOMPONENTCLASSLIST
  5161. DEF_ENDLIST
  5162. DEF_CATEGORY
  5163.  
  5164. DEF_BITMAP
  5165.  
  5166. DEF_THUMBNAIL_UP
  5167.  
  5168. DEF_THUMBNAIL_DOWN
  5169.  
  5170. DEF_BASE
  5171. DEF_IMPORTS
  5172. DEF_ENDLIST
  5173. DEF_REQUIRES
  5174. DEF_ENDLIST
  5175. DEF_IMPLEMENTS
  5176. DEF_ENDLIST
  5177. DEF_DECLARATION
  5178. // Error is a subtype of Throwable for abnormal events that should not occur.
  5179. // Do not try to catch Error's unless you really know what you're
  5180. // doing.
  5181. DEF_ENDLIST
  5182. DEF_METHOD
  5183. public Error()
  5184. //    Constructs an Error with no specified detail message.
  5185. // A detail message is a String that describes this particular error.
  5186. // 
  5187. DEF_ENDLIST
  5188. DEF_METHOD
  5189. public Error(String s)
  5190. //    Constructs an Error with the specified detail message.
  5191. // A detail message is a String that describes this particular error
  5192. //   
  5193. //      Parameters:
  5194. //      s - the detail message
  5195. //   
  5196. // 
  5197. DEF_ENDLIST
  5198. DEF_ENDCOMPONENT
  5199. DEF_COMPONENTNAME
  5200. Exception
  5201. DEF_SUPERCLASS
  5202. Throwable
  5203. DEF_SUPERCOMPONENT
  5204.  
  5205. DEF_PACKAGE
  5206. java
  5207. lang
  5208. DEF_ENDLIST
  5209. DEF_SUBCOMPONENTLIST
  5210. DEF_ENDLIST
  5211. DEF_SUBCOMPONENTCLASSLIST
  5212. DEF_ENDLIST
  5213. DEF_CATEGORY
  5214.  
  5215. DEF_BITMAP
  5216.  
  5217. DEF_THUMBNAIL_UP
  5218.  
  5219. DEF_THUMBNAIL_DOWN
  5220.  
  5221. DEF_BASE
  5222. DEF_IMPORTS
  5223. DEF_ENDLIST
  5224. DEF_REQUIRES
  5225. DEF_ENDLIST
  5226. DEF_IMPLEMENTS
  5227. DEF_ENDLIST
  5228. DEF_DECLARATION
  5229. // Exception are a form of Throwable that normal programs may wish to try and catch.
  5230. DEF_ENDLIST
  5231. DEF_METHOD
  5232. public Exception()
  5233. //    Constructs an Exception with no specified detail message.
  5234. // A detail message is a String that describes this particular exception.
  5235. // 
  5236. DEF_ENDLIST
  5237. DEF_METHOD
  5238. public Exception(String s)
  5239. //    Constructs a Exception with the specified detail message.
  5240. // A detail message is a String that describes this particular exception.
  5241. //   
  5242. //      Parameters:
  5243. //      s - the detail message
  5244. //   
  5245. // 
  5246. DEF_ENDLIST
  5247. DEF_ENDCOMPONENT
  5248. DEF_COMPONENTNAME
  5249. Float
  5250. DEF_SUPERCLASS
  5251. Number
  5252. DEF_SUPERCOMPONENT
  5253.  
  5254. DEF_PACKAGE
  5255. java
  5256. lang
  5257. DEF_ENDLIST
  5258. DEF_SUBCOMPONENTLIST
  5259. DEF_ENDLIST
  5260. DEF_SUBCOMPONENTCLASSLIST
  5261. DEF_ENDLIST
  5262. DEF_CATEGORY
  5263.  
  5264. DEF_BITMAP
  5265.  
  5266. DEF_THUMBNAIL_UP
  5267.  
  5268. DEF_THUMBNAIL_DOWN
  5269.  
  5270. DEF_BASE
  5271. DEF_IMPORTS
  5272. DEF_ENDLIST
  5273. DEF_REQUIRES
  5274. DEF_ENDLIST
  5275. DEF_IMPLEMENTS
  5276. DEF_ENDLIST
  5277. DEF_DECLARATION
  5278. // The Float class provides an object wrapper for Float data values, and serves as
  5279. // a place for float-oriented operations.  A wrapper is useful because most of Java's
  5280. // utility classes require the use of objects.  Since floats are not objects in 
  5281. // Java, they need to be "wrapped" in a Float instance.
  5282. DEF_ENDLIST
  5283. DEF_METHOD
  5284. public Float(float value)
  5285. //    Constructs a Float wrapper for the specified float value.
  5286. //   
  5287. //      Parameters:
  5288. //      value - the value of the Float
  5289. //   
  5290. // 
  5291. DEF_ENDLIST
  5292. DEF_METHOD
  5293. public Float(double value)
  5294. //    Constructs a Float wrapper for the specified double value.
  5295. //   
  5296. //      Parameters:
  5297. //      value - the value of the Float
  5298. //   
  5299. // 
  5300. DEF_ENDLIST
  5301. DEF_METHOD
  5302. public Float(String s) throws NumberFormatException
  5303. //    Constructs a Float object initialized to the value specified by the
  5304. // String parameter.
  5305. //   
  5306. //      Parameters:
  5307. //      s - the String to be converted to a Float
  5308. //      Throws: NumberFormatException
  5309. //      If the String does not contain a parsable number.
  5310. //   
  5311. // 
  5312. DEF_ENDLIST
  5313. DEF_METHOD
  5314. public static String toString(float f)
  5315. //    Returns a String representation for the specified float value.
  5316. //   
  5317. //      Parameters:
  5318. //      f - the float to be converted
  5319. //   
  5320. // 
  5321. DEF_ENDLIST
  5322. DEF_METHOD
  5323. public static Float valueOf(String s) throws NumberFormatException
  5324. //    Returns the floating point value represented by the specified String.
  5325. //   
  5326. //      Parameters:
  5327. //      s - the String to be parsed
  5328. //      Throws: NumberFormatException
  5329. //      If the String does not contain a parsable 
  5330. // Float.
  5331. //   
  5332. // 
  5333. DEF_ENDLIST
  5334. DEF_METHOD
  5335. public static boolean isNaN(float v)
  5336. //    Returns true if the specified number is the special Not-a-Number (NaN) value.
  5337. //   
  5338. //      Parameters:
  5339. //      v - the value to be tested
  5340. //   
  5341. // 
  5342. DEF_ENDLIST
  5343. DEF_METHOD
  5344. public static boolean isInfinite(float v)
  5345. //    Returns true if the specified number is infinitely large in magnitude.
  5346. //   
  5347. //      Parameters:
  5348. //      v - the value to be tested
  5349. //   
  5350. // 
  5351. DEF_ENDLIST
  5352. DEF_METHOD
  5353. public boolean isNaN()
  5354. //    Returns true if this Float value is Not-a-Number (NaN).
  5355. // 
  5356. DEF_ENDLIST
  5357. DEF_METHOD
  5358. public boolean isInfinite()
  5359. //    Returns true if this Float value is infinitely large in magnitude.
  5360. // 
  5361. DEF_ENDLIST
  5362. DEF_METHOD
  5363. public String toString()
  5364. //    Returns a String representation of this Float object.
  5365. //   
  5366. //      Overrides:
  5367. //      toString in class Object
  5368. //   
  5369. // 
  5370. DEF_ENDLIST
  5371. DEF_METHOD
  5372. public int intValue()
  5373. //    Returns the integer value of this Float (by casting to an int).
  5374. //   
  5375. //      Overrides:
  5376. //      intValue in class Number
  5377. //   
  5378. // 
  5379. DEF_ENDLIST
  5380. DEF_METHOD
  5381. public long longValue()
  5382. //    Returns the long value of this Float (by casting to a long).
  5383. //   
  5384. //      Overrides:
  5385. //      longValue in class Number
  5386. //   
  5387. // 
  5388. DEF_ENDLIST
  5389. DEF_METHOD
  5390. public float floatValue()
  5391. //    Returns the float value of this Float object.
  5392. //   
  5393. //      Overrides:
  5394. //      floatValue in class Number
  5395. //   
  5396. // 
  5397. DEF_ENDLIST
  5398. DEF_METHOD
  5399. public double doubleValue()
  5400. //    Returns the double value of this Float.
  5401. //   
  5402. //      Overrides:
  5403. //      doubleValue in class Number
  5404. //   
  5405. // 
  5406. DEF_ENDLIST
  5407. DEF_METHOD
  5408. public int hashCode()
  5409. //    Returns a hashcode for this Float.
  5410. //   
  5411. //      Overrides:
  5412. //      hashCode in class Object
  5413. //   
  5414. // 
  5415. DEF_ENDLIST
  5416. DEF_METHOD
  5417. public boolean equals(Object obj)
  5418. //    Compares this object against some other object.
  5419. // 
  5420. // Note: To be useful in hashtables this method
  5421. // considers two Nan floating point values to be equal. This
  5422. // is not according to IEEE specification
  5423. //   
  5424. //      Parameters:
  5425. //      obj - the object to compare with
  5426. //      Returns:
  5427. //      true if the objects are the same; false otherwise.
  5428. //      Overrides:
  5429. //      equals in class Object
  5430. //   
  5431. // 
  5432. DEF_ENDLIST
  5433. DEF_METHOD
  5434. public static int floatToIntBits(float value)
  5435. //    Returns the bit represention of a single-float value
  5436. // 
  5437. DEF_ENDLIST
  5438. DEF_METHOD
  5439. public static float intBitsToFloat(int bits)
  5440. //    Returns the single-float corresponding to a given bit represention.
  5441. // 
  5442. DEF_ENDLIST
  5443. DEF_ENDCOMPONENT
  5444. DEF_COMPONENTNAME
  5445. IllegalAccessError
  5446. DEF_SUPERCLASS
  5447. IncompatibleClassChangeError
  5448. DEF_SUPERCOMPONENT
  5449.  
  5450. DEF_PACKAGE
  5451. java
  5452. lang
  5453. DEF_ENDLIST
  5454. DEF_SUBCOMPONENTLIST
  5455. DEF_ENDLIST
  5456. DEF_SUBCOMPONENTCLASSLIST
  5457. DEF_ENDLIST
  5458. DEF_CATEGORY
  5459.  
  5460. DEF_BITMAP
  5461.  
  5462. DEF_THUMBNAIL_UP
  5463.  
  5464. DEF_THUMBNAIL_DOWN
  5465.  
  5466. DEF_BASE
  5467. DEF_IMPORTS
  5468. DEF_ENDLIST
  5469. DEF_REQUIRES
  5470. DEF_ENDLIST
  5471. DEF_IMPLEMENTS
  5472. DEF_ENDLIST
  5473. DEF_DECLARATION
  5474. // Signals that an illegal access exception has occurred.
  5475. DEF_ENDLIST
  5476. DEF_METHOD
  5477. public IllegalAccessError()
  5478. //    Constructs an IllegalAccessError with no detail message.
  5479. // A detail message is a String that describes this particular exception.
  5480. // 
  5481. DEF_ENDLIST
  5482. DEF_METHOD
  5483. public IllegalAccessError(String s)
  5484. //    Constructs an IllegalAccessError with the specified detail message.
  5485. // A detail message is a String that describes this particular exception.
  5486. //   
  5487. //      Parameters:
  5488. //      s - the detail message
  5489. //   
  5490. // 
  5491. DEF_ENDLIST
  5492. DEF_ENDCOMPONENT
  5493. DEF_COMPONENTNAME
  5494. IllegalAccessException
  5495. DEF_SUPERCLASS
  5496. Exception
  5497. DEF_SUPERCOMPONENT
  5498.  
  5499. DEF_PACKAGE
  5500. java
  5501. lang
  5502. DEF_ENDLIST
  5503. DEF_SUBCOMPONENTLIST
  5504. DEF_ENDLIST
  5505. DEF_SUBCOMPONENTCLASSLIST
  5506. DEF_ENDLIST
  5507. DEF_CATEGORY
  5508.  
  5509. DEF_BITMAP
  5510.  
  5511. DEF_THUMBNAIL_UP
  5512.  
  5513. DEF_THUMBNAIL_DOWN
  5514.  
  5515. DEF_BASE
  5516. DEF_IMPORTS
  5517. DEF_ENDLIST
  5518. DEF_REQUIRES
  5519. DEF_ENDLIST
  5520. DEF_IMPLEMENTS
  5521. DEF_ENDLIST
  5522. DEF_DECLARATION
  5523. // Signals that a particular method could not be found.
  5524. DEF_ENDLIST
  5525. DEF_METHOD
  5526. public IllegalAccessException()
  5527. //    Constructs a IllegalAccessException without a detail message.
  5528. // A detail message is a String that describes this particular exception.
  5529. // 
  5530. DEF_ENDLIST
  5531. DEF_METHOD
  5532. public IllegalAccessException(String s)
  5533. //    Constructs a IllegalAccessException with a detail message.
  5534. // A detail message is a String that describes this particular exception.
  5535. //   
  5536. //      Parameters:
  5537. //      s - the detail message
  5538. //   
  5539. // 
  5540. DEF_ENDLIST
  5541. DEF_ENDCOMPONENT
  5542. DEF_COMPONENTNAME
  5543. IllegalArgumentException
  5544. DEF_SUPERCLASS
  5545. RuntimeException
  5546. DEF_SUPERCOMPONENT
  5547.  
  5548. DEF_PACKAGE
  5549. java
  5550. lang
  5551. DEF_ENDLIST
  5552. DEF_SUBCOMPONENTLIST
  5553. DEF_ENDLIST
  5554. DEF_SUBCOMPONENTCLASSLIST
  5555. DEF_ENDLIST
  5556. DEF_CATEGORY
  5557.  
  5558. DEF_BITMAP
  5559.  
  5560. DEF_THUMBNAIL_UP
  5561.  
  5562. DEF_THUMBNAIL_DOWN
  5563.  
  5564. DEF_BASE
  5565. DEF_IMPORTS
  5566. DEF_ENDLIST
  5567. DEF_REQUIRES
  5568. DEF_ENDLIST
  5569. DEF_IMPLEMENTS
  5570. DEF_ENDLIST
  5571. DEF_DECLARATION
  5572. // Signals that an illegal argument exception has occurred.
  5573. // 
  5574. //      See Also:
  5575. //      setPriority
  5576. // 
  5577. DEF_ENDLIST
  5578. DEF_METHOD
  5579. public IllegalArgumentException()
  5580. //    Constructs an IllegalArgumentException with no detail message.
  5581. // A detail message is a String that describes this particular exception.
  5582. // 
  5583. DEF_ENDLIST
  5584. DEF_METHOD
  5585. public IllegalArgumentException(String s)
  5586. //    Constructs an IllegalArgumentException with the specified detail message.
  5587. // A detail message is a String that describes this particular exception.
  5588. //   
  5589. //      Parameters:
  5590. //      s - the detail message
  5591. //   
  5592. // 
  5593. DEF_ENDLIST
  5594. DEF_ENDCOMPONENT
  5595. DEF_COMPONENTNAME
  5596. IllegalMonitorStateException
  5597. DEF_SUPERCLASS
  5598. RuntimeException
  5599. DEF_SUPERCOMPONENT
  5600.  
  5601. DEF_PACKAGE
  5602. java
  5603. lang
  5604. DEF_ENDLIST
  5605. DEF_SUBCOMPONENTLIST
  5606. DEF_ENDLIST
  5607. DEF_SUBCOMPONENTCLASSLIST
  5608. DEF_ENDLIST
  5609. DEF_CATEGORY
  5610.  
  5611. DEF_BITMAP
  5612.  
  5613. DEF_THUMBNAIL_UP
  5614.  
  5615. DEF_THUMBNAIL_DOWN
  5616.  
  5617. DEF_BASE
  5618. DEF_IMPORTS
  5619. DEF_ENDLIST
  5620. DEF_REQUIRES
  5621. DEF_ENDLIST
  5622. DEF_IMPLEMENTS
  5623. DEF_ENDLIST
  5624. DEF_DECLARATION
  5625. // Signals that a monitor operation has been attempted when the monitor
  5626. // is in an invalid state.  For example, trying to notify a monitor that
  5627. // you do not own would invoke this class.
  5628. DEF_ENDLIST
  5629. DEF_METHOD
  5630. public IllegalMonitorStateException()
  5631. //    Constructs an IllegalMonitorStateException with no detail message.
  5632. // A detail message is a String that describes this particular exception.
  5633. // 
  5634. DEF_ENDLIST
  5635. DEF_METHOD
  5636. public IllegalMonitorStateException(String s)
  5637. //    Constructs an IllegalMonitorStateException with the specified detail
  5638. // message.  A detail message is a String that describes this particular
  5639. // exception.
  5640. //   
  5641. //      Parameters:
  5642. //      s - the String that contains a detailed message
  5643. //   
  5644. // 
  5645. DEF_ENDLIST
  5646. DEF_ENDCOMPONENT
  5647. DEF_COMPONENTNAME
  5648. IllegalThreadStateException
  5649. DEF_SUPERCLASS
  5650. IllegalArgumentException
  5651. DEF_SUPERCOMPONENT
  5652.  
  5653. DEF_PACKAGE
  5654. java
  5655. lang
  5656. DEF_ENDLIST
  5657. DEF_SUBCOMPONENTLIST
  5658. DEF_ENDLIST
  5659. DEF_SUBCOMPONENTCLASSLIST
  5660. DEF_ENDLIST
  5661. DEF_CATEGORY
  5662.  
  5663. DEF_BITMAP
  5664.  
  5665. DEF_THUMBNAIL_UP
  5666.  
  5667. DEF_THUMBNAIL_DOWN
  5668.  
  5669. DEF_BASE
  5670. DEF_IMPORTS
  5671. DEF_ENDLIST
  5672. DEF_REQUIRES
  5673. DEF_ENDLIST
  5674. DEF_IMPLEMENTS
  5675. DEF_ENDLIST
  5676. DEF_DECLARATION
  5677. // Exception indicating that a thread is not in the proper state for the
  5678. // requested operation.
  5679. // 
  5680. //      See Also:
  5681. //      suspend, resume
  5682. // 
  5683. DEF_ENDLIST
  5684. DEF_METHOD
  5685. public IllegalThreadStateException()
  5686. //    Constructs an IllegalThreadStateException with no detail message.
  5687. // A detail message is a String that describes this particular exception.
  5688. // 
  5689. DEF_ENDLIST
  5690. DEF_METHOD
  5691. public IllegalThreadStateException(String s)
  5692. //    Constructs an IllegalThreadStateException with the specified detail message.
  5693. // A detail message is a String that describes this particular exception.
  5694. //   
  5695. //      Parameters:
  5696. //      s - the detail message
  5697. //   
  5698. // 
  5699. DEF_ENDLIST
  5700. DEF_ENDCOMPONENT
  5701. DEF_COMPONENTNAME
  5702. IncompatibleClassChangeError
  5703. DEF_SUPERCLASS
  5704. LinkageError
  5705. DEF_SUPERCOMPONENT
  5706.  
  5707. DEF_PACKAGE
  5708. java
  5709. lang
  5710. DEF_ENDLIST
  5711. DEF_SUBCOMPONENTLIST
  5712. DEF_ENDLIST
  5713. DEF_SUBCOMPONENTCLASSLIST
  5714. DEF_ENDLIST
  5715. DEF_CATEGORY
  5716.  
  5717. DEF_BITMAP
  5718.  
  5719. DEF_THUMBNAIL_UP
  5720.  
  5721. DEF_THUMBNAIL_DOWN
  5722.  
  5723. DEF_BASE
  5724. DEF_IMPORTS
  5725. DEF_ENDLIST
  5726. DEF_REQUIRES
  5727. DEF_ENDLIST
  5728. DEF_IMPLEMENTS
  5729. DEF_ENDLIST
  5730. DEF_DECLARATION
  5731. // Signals that an incompatible class change has occurred.
  5732. DEF_ENDLIST
  5733. DEF_METHOD
  5734. public IncompatibleClassChangeError()
  5735. //    Constructs an IncompatibleClassChangeError with no detail message.
  5736. // A detail message is a String that describes this particular exception.
  5737. // 
  5738. DEF_ENDLIST
  5739. DEF_METHOD
  5740. public IncompatibleClassChangeError(String s)
  5741. //    Constructs an IncompatibleClassChangeError with the specified detail 
  5742. // message.
  5743. // A detail message is a String that describes this particular exception.
  5744. //   
  5745. //      Parameters:
  5746. //      s - the detail message
  5747. //   
  5748. // 
  5749. DEF_ENDLIST
  5750. DEF_ENDCOMPONENT
  5751. DEF_COMPONENTNAME
  5752. IndexOutOfBoundsException
  5753. DEF_SUPERCLASS
  5754. RuntimeException
  5755. DEF_SUPERCOMPONENT
  5756.  
  5757. DEF_PACKAGE
  5758. java
  5759. lang
  5760. DEF_ENDLIST
  5761. DEF_SUBCOMPONENTLIST
  5762. DEF_ENDLIST
  5763. DEF_SUBCOMPONENTCLASSLIST
  5764. DEF_ENDLIST
  5765. DEF_CATEGORY
  5766.  
  5767. DEF_BITMAP
  5768.  
  5769. DEF_THUMBNAIL_UP
  5770.  
  5771. DEF_THUMBNAIL_DOWN
  5772.  
  5773. DEF_BASE
  5774. DEF_IMPORTS
  5775. DEF_ENDLIST
  5776. DEF_REQUIRES
  5777. DEF_ENDLIST
  5778. DEF_IMPLEMENTS
  5779. DEF_ENDLIST
  5780. DEF_DECLARATION
  5781. // Signals that an index of some sort is out of bounds.
  5782. DEF_ENDLIST
  5783. DEF_METHOD
  5784. public IndexOutOfBoundsException()
  5785. //    Constructs an IndexOutOfBoundsException with no detail message.
  5786. // A detail message is a String that describes this particular exception.
  5787. // 
  5788. DEF_ENDLIST
  5789. DEF_METHOD
  5790. public IndexOutOfBoundsException(String s)
  5791. //    Constructs a IndexOutOfBoundsException with the specified detail message.
  5792. // A detail message is a String that describes this particular exception.
  5793. //   
  5794. //      Parameters:
  5795. //      s - the detail message
  5796. //   
  5797. // 
  5798. DEF_ENDLIST
  5799. DEF_ENDCOMPONENT
  5800. DEF_COMPONENTNAME
  5801. InstantiationError
  5802. DEF_SUPERCLASS
  5803. IncompatibleClassChangeError
  5804. DEF_SUPERCOMPONENT
  5805.  
  5806. DEF_PACKAGE
  5807. java
  5808. lang
  5809. DEF_ENDLIST
  5810. DEF_SUBCOMPONENTLIST
  5811. DEF_ENDLIST
  5812. DEF_SUBCOMPONENTCLASSLIST
  5813. DEF_ENDLIST
  5814. DEF_CATEGORY
  5815.  
  5816. DEF_BITMAP
  5817.  
  5818. DEF_THUMBNAIL_UP
  5819.  
  5820. DEF_THUMBNAIL_DOWN
  5821.  
  5822. DEF_BASE
  5823. DEF_IMPORTS
  5824. DEF_ENDLIST
  5825. DEF_REQUIRES
  5826. DEF_ENDLIST
  5827. DEF_IMPLEMENTS
  5828. DEF_ENDLIST
  5829. DEF_DECLARATION
  5830. // Signals that the interpreter has tried to instantiate an abstract class or
  5831. // an interface.
  5832. DEF_ENDLIST
  5833. DEF_METHOD
  5834. public InstantiationError()
  5835. //    Constructs an InstantiationError with no detail message.  A detail 
  5836. // message is a String that describes this particular exception.
  5837. // 
  5838. DEF_ENDLIST
  5839. DEF_METHOD
  5840. public InstantiationError(String s)
  5841. //    Constructs an InstantiationError with the specified detail message.
  5842. // A detail message is a String that describes this particular exception.
  5843. //   
  5844. //      Parameters:
  5845. //      s - the String that contains the detail message
  5846. //   
  5847. // 
  5848. DEF_ENDLIST
  5849. DEF_ENDCOMPONENT
  5850. DEF_COMPONENTNAME
  5851. InstantiationException
  5852. DEF_SUPERCLASS
  5853. Exception
  5854. DEF_SUPERCOMPONENT
  5855.  
  5856. DEF_PACKAGE
  5857. java
  5858. lang
  5859. DEF_ENDLIST
  5860. DEF_SUBCOMPONENTLIST
  5861. DEF_ENDLIST
  5862. DEF_SUBCOMPONENTCLASSLIST
  5863. DEF_ENDLIST
  5864. DEF_CATEGORY
  5865.  
  5866. DEF_BITMAP
  5867.  
  5868. DEF_THUMBNAIL_UP
  5869.  
  5870. DEF_THUMBNAIL_DOWN
  5871.  
  5872. DEF_BASE
  5873. DEF_IMPORTS
  5874. DEF_ENDLIST
  5875. DEF_REQUIRES
  5876. DEF_ENDLIST
  5877. DEF_IMPLEMENTS
  5878. DEF_ENDLIST
  5879. DEF_DECLARATION
  5880. // Signals that an attempt has been made to instantiate an abstract class or
  5881. // an interface.
  5882. DEF_ENDLIST
  5883. DEF_METHOD
  5884. public InstantiationException()
  5885. //    Constructs an InstantiationException with no detail message.
  5886. // A detail message is a String that describes this particular exception.
  5887. // 
  5888. DEF_ENDLIST
  5889. DEF_METHOD
  5890. public InstantiationException(String s)
  5891. //    Constructs an InstantiationException with the specified detail message.
  5892. // A detail message is a String that describes this particular exception.
  5893. //   
  5894. //      Parameters:
  5895. //      s - the String containing a detail message
  5896. //   
  5897. // 
  5898. DEF_ENDLIST
  5899. DEF_ENDCOMPONENT
  5900. DEF_COMPONENTNAME
  5901. ContentHandler
  5902. DEF_SUPERCLASS
  5903. Object
  5904. DEF_SUPERCOMPONENT
  5905.  
  5906. DEF_PACKAGE
  5907. java
  5908. net
  5909. DEF_ENDLIST
  5910. DEF_SUBCOMPONENTLIST
  5911. DEF_ENDLIST
  5912. DEF_SUBCOMPONENTCLASSLIST
  5913. DEF_ENDLIST
  5914. DEF_CATEGORY
  5915.  
  5916. DEF_BITMAP
  5917.  
  5918. DEF_THUMBNAIL_UP
  5919.  
  5920. DEF_THUMBNAIL_DOWN
  5921.  
  5922. DEF_BASE
  5923. DEF_IMPORTS
  5924. java.net.ContentHandler
  5925. DEF_ENDLIST
  5926. DEF_REQUIRES
  5927. DEF_ENDLIST
  5928. DEF_IMPLEMENTS
  5929. DEF_ENDLIST
  5930. DEF_DECLARATION
  5931. // A class to read data from a URLConnection and construct an
  5932. // Object.  Specific subclasses of ContentHandler handle
  5933. // specific mime types.  It is the responsibility of a ContentHandlerFactory
  5934. // to select an appropriate ContentHandler for the mime-type
  5935. // of the URLConnection.  Applications should never call ContentHandlers
  5936. // directly, rather they should use URL.getContent() or
  5937. // URLConnection.getContent()
  5938. DEF_ENDLIST
  5939. DEF_METHOD
  5940. public ContentHandler()
  5941. //    Given an input stream positioned at the beginning of the
  5942. // representation of an object, reads that stream and recreates
  5943. // the object from it.
  5944. //   
  5945. //      Throws: IOException
  5946. //      An IO error occurred while reading the object.
  5947. //   
  5948. // 
  5949. DEF_ENDLIST
  5950. DEF_ENDCOMPONENT
  5951. DEF_COMPONENTNAME
  5952. DatagramPacket
  5953. DEF_SUPERCLASS
  5954. Object
  5955. DEF_SUPERCOMPONENT
  5956.  
  5957. DEF_PACKAGE
  5958. java
  5959. net
  5960. DEF_ENDLIST
  5961. DEF_SUBCOMPONENTLIST
  5962. DEF_ENDLIST
  5963. DEF_SUBCOMPONENTCLASSLIST
  5964. DEF_ENDLIST
  5965. DEF_CATEGORY
  5966.  
  5967. DEF_BITMAP
  5968.  
  5969. DEF_THUMBNAIL_UP
  5970.  
  5971. DEF_THUMBNAIL_DOWN
  5972.  
  5973. DEF_BASE
  5974. DEF_IMPORTS
  5975. java.net.DatagramPacket
  5976. DEF_ENDLIST
  5977. DEF_REQUIRES
  5978. DEF_ENDLIST
  5979. DEF_IMPLEMENTS
  5980. DEF_ENDLIST
  5981. DEF_DECLARATION
  5982. // A class that represents a datagram packet containing packet data, packet
  5983. // length, internet addresses and port.
  5984. DEF_ENDLIST
  5985. DEF_METHOD
  5986. public DatagramPacket(byte ibuf[],
  5987.                       int ilength)
  5988. //    This constructor is used to create a DatagramPacket object used 
  5989. // for receiving datagrams.
  5990. //   
  5991. //      Parameters:
  5992. //      ibuf - is where packet data is to be received.
  5993. //      ilength - is the number of bytes to be received.
  5994. //   
  5995. // 
  5996. DEF_ENDLIST
  5997. DEF_METHOD
  5998. public DatagramPacket(byte ibuf[],
  5999.                       int ilength,
  6000.                       InetAddress iaddr,
  6001.                       int iport)
  6002. //    This constructor is used construct the DatagramPacket to be sent.
  6003. //   
  6004. //      Parameters:
  6005. //      ibuf - contains the packet data.
  6006. //      ilength - contains the packet length
  6007. //      iaddr - and iport contains destination ip addr and port number.
  6008. //   
  6009. // 
  6010. DEF_ENDLIST
  6011. DEF_ENDCOMPONENT
  6012. DEF_COMPONENTNAME
  6013. DatagramSocket
  6014. DEF_SUPERCLASS
  6015. Object
  6016. DEF_SUPERCOMPONENT
  6017.  
  6018. DEF_PACKAGE
  6019. java
  6020. net
  6021. DEF_ENDLIST
  6022. DEF_SUBCOMPONENTLIST
  6023. DEF_ENDLIST
  6024. DEF_SUBCOMPONENTCLASSLIST
  6025. DEF_ENDLIST
  6026. DEF_CATEGORY
  6027.  
  6028. DEF_BITMAP
  6029.  
  6030. DEF_THUMBNAIL_UP
  6031.  
  6032. DEF_THUMBNAIL_DOWN
  6033.  
  6034. DEF_BASE
  6035. DEF_IMPORTS
  6036. java.net.DatagramSocket
  6037. DEF_ENDLIST
  6038. DEF_REQUIRES
  6039. DEF_ENDLIST
  6040. DEF_IMPLEMENTS
  6041. DEF_ENDLIST
  6042. DEF_DECLARATION
  6043. // The datagram socket class implements unreliable datagrams.
  6044. DEF_ENDLIST
  6045. DEF_METHOD
  6046. public DatagramSocket() throws SocketException
  6047. //    Creates a datagram socket
  6048. // 
  6049. DEF_ENDLIST
  6050. DEF_METHOD
  6051. public DatagramSocket(int port) throws SocketException
  6052. //    Creates a datagram socket
  6053. //   
  6054. //      Parameters:
  6055. //      local - port to use
  6056. //   
  6057. // 
  6058. DEF_ENDLIST
  6059. DEF_METHOD
  6060. public void send(DatagramPacket p) throws IOException
  6061. //    Sends Datagram Packet to the destination address
  6062. //   
  6063. //      Parameters:
  6064. //      DatagramPacket - to be sent. The packet contains the buffer 
  6065. // of bytes, length and destination InetAddress and port.
  6066. //      Throws: IOException
  6067. //      i/o error occurred
  6068. //   
  6069. // 
  6070. DEF_ENDLIST
  6071. DEF_METHOD
  6072. public synchronized void receive(DatagramPacket p) throws IOException
  6073. //    Receives datagram packet.
  6074. //   
  6075. //      Parameters:
  6076. //      DatagramPacket - to be received.
  6077. // On return, the DatagramPacket contains the buffer in which the 
  6078. // data is received, packet length, sender's address and sender's port 
  6079. // number. Blocks until some input is available.
  6080. //      Throws: IOException
  6081. //      i/o error occurred
  6082. //   
  6083. // 
  6084. DEF_ENDLIST
  6085. DEF_METHOD
  6086. public int getLocalPort()
  6087. //    Returns the local port that this socket is bound to.
  6088. // 
  6089. DEF_ENDLIST
  6090. DEF_METHOD
  6091. public synchronized void close()
  6092. //    Close the datagram socket.
  6093. // 
  6094. DEF_ENDLIST
  6095. DEF_METHOD
  6096. protected synchronized void finalize()
  6097. //    Code to perform when this object is garbage collected.
  6098. //   
  6099. //      Overrides:
  6100. //      finalize in class Object
  6101. //   
  6102. // 
  6103. DEF_ENDLIST
  6104. DEF_ENDCOMPONENT
  6105. DEF_COMPONENTNAME
  6106. InetAddress
  6107. DEF_SUPERCLASS
  6108. Object
  6109. DEF_SUPERCOMPONENT
  6110.  
  6111. DEF_PACKAGE
  6112. java
  6113. net
  6114. DEF_ENDLIST
  6115. DEF_SUBCOMPONENTLIST
  6116. DEF_ENDLIST
  6117. DEF_SUBCOMPONENTCLASSLIST
  6118. DEF_ENDLIST
  6119. DEF_CATEGORY
  6120.  
  6121. DEF_BITMAP
  6122.  
  6123. DEF_THUMBNAIL_UP
  6124.  
  6125. DEF_THUMBNAIL_DOWN
  6126.  
  6127. DEF_BASE
  6128. DEF_IMPORTS
  6129. java.net.InetAddress
  6130. DEF_ENDLIST
  6131. DEF_REQUIRES
  6132. DEF_ENDLIST
  6133. DEF_IMPLEMENTS
  6134. DEF_ENDLIST
  6135. DEF_DECLARATION
  6136. // A class that represents Internet addresses.
  6137. DEF_ENDLIST
  6138. DEF_METHOD
  6139. public String getHostName()
  6140. //    Gets the hostname for this address; also the key in the 
  6141. // hashtable.
  6142. // If the host is equal to null, then this address refers to any
  6143. // of the local machine's available network addresses.
  6144. // 
  6145. DEF_ENDLIST
  6146. DEF_METHOD
  6147. public byte[] getAddress()
  6148. //    Returns the raw IP address in network byte order.  The highest
  6149. // order byte position is in addr[0]. To be prepared for 64-bit
  6150. // IP addresses n array of bytes is returned.
  6151. //   
  6152. //      Returns:
  6153. //      raw IP address in network byte order.
  6154. //   
  6155. // 
  6156. DEF_ENDLIST
  6157. DEF_METHOD
  6158. public int hashCode()
  6159. //    Returns a hashcode for this InetAddress.
  6160. //   
  6161. //      Overrides:
  6162. //      hashCode in class Object
  6163. //   
  6164. // 
  6165. DEF_ENDLIST
  6166. DEF_METHOD
  6167. public boolean equals(Object obj)
  6168. //    Compares this object against the specified object.
  6169. //   
  6170. //      Parameters:
  6171. //      obj - the object to compare against.
  6172. //      Returns:
  6173. //      true if the objects are the same; false otherwise.
  6174. //      Overrides:
  6175. //      equals in class Object
  6176. //   
  6177. // 
  6178. DEF_ENDLIST
  6179. DEF_METHOD
  6180. public String toString()
  6181. //    Converts the InetAddress to a String.
  6182. //   
  6183. //      Overrides:
  6184. //      toString in class Object
  6185. //   
  6186. // 
  6187. DEF_ENDLIST
  6188. DEF_METHOD
  6189. public static synchronized InetAddress getByName(String host) throws UnknownHostException
  6190. //    Returns a network address for the indicated host.  A host name
  6191. // of null refers to default address for the local machine.  A local
  6192. // cache is used to speed access to addresses.  If all
  6193. // addresses for a host are needed, use the getAllByName() method.
  6194. //   
  6195. //      Parameters:
  6196. //      host - the specified host
  6197. //      Throws: UnknownHostException
  6198. //      If the address is unknown.
  6199. //   
  6200. // 
  6201. DEF_ENDLIST
  6202. DEF_METHOD
  6203. public static synchronized InetAddress[] getAllByName(String host) throws UnknownHostException
  6204. //    Given a hostname, returns an array of all the corresponding InetAddresses.
  6205. //   
  6206. //      Throws: UnknownHostException
  6207. //      If the host name could not be resolved
  6208. //   
  6209. // 
  6210. DEF_ENDLIST
  6211. DEF_METHOD
  6212. public static InetAddress getLocalHost() throws UnknownHostException
  6213. //    Returns the local host.
  6214. //   
  6215. //      Throws: UnknownHostException
  6216. //      If the host name could not be resolved
  6217. //   
  6218. // 
  6219. DEF_ENDLIST
  6220. DEF_ENDCOMPONENT
  6221. DEF_COMPONENTNAME
  6222. Date
  6223. DEF_SUPERCLASS
  6224. Object
  6225. DEF_SUPERCOMPONENT
  6226.  
  6227. DEF_PACKAGE
  6228. java
  6229. util
  6230. DEF_ENDLIST
  6231. DEF_SUBCOMPONENTLIST
  6232. DEF_ENDLIST
  6233. DEF_SUBCOMPONENTCLASSLIST
  6234. DEF_ENDLIST
  6235. DEF_CATEGORY
  6236.  
  6237. DEF_BITMAP
  6238.  
  6239. DEF_THUMBNAIL_UP
  6240.  
  6241. DEF_THUMBNAIL_DOWN
  6242.  
  6243. DEF_BASE
  6244. DEF_IMPORTS
  6245. java.util.Date
  6246. DEF_ENDLIST
  6247. DEF_REQUIRES
  6248. DEF_ENDLIST
  6249. DEF_IMPLEMENTS
  6250. DEF_ENDLIST
  6251. DEF_DECLARATION
  6252. // A wrapper for a date. This class lets you manipulate
  6253. // dates in a system independent way. To print today's
  6254. // date use:
  6255. // 
  6256. //     Date d = new Date();
  6257. //     System.out.println("today = " + d);
  6258. // 
  6259. // To find out what day corresponds to a particular date:
  6260. // 
  6261. //     Date d = new Date(63, 0, 16);    // January 16, 1963
  6262. //     System.out.println("Day of the week: " + d.getDay());
  6263. // 
  6264. // The date can be set and examined
  6265. // according to the local time zone into the
  6266. // year, month, day, hour, minute and second.
  6267. // 
  6268. // While the API is intended to reflect UTC, Coordinated Universal Time,
  6269. // it doesn't do so exactly.  This inexact behavior is inherited from
  6270. // the time system of the underlying OS.  All modern OS's that I (jag)
  6271. // am aware of assume that 1 day = 24*60*60 seconds.  In UTC, about once
  6272. // a year there is an extra second, called a "leap second" added to
  6273. // a day to account for the wobble of the earth.  Most computer clocks
  6274. // are not accurate enough to be able to reflect this distinction.
  6275. // Some computer standards are defined in GMT, which is equivalent
  6276. // to UT, Universal Time.  GMT is the "civil" name for the standard,
  6277. // UT is the "scientific" name for the same standard.  The distinction
  6278. // between UTC and UT is that the first is based on an atomic clock and
  6279. // the second is based on astronomical observations, which for all
  6280. // practical purposes is an invisibly fine hair to split.
  6281. // An interesting source of further information is the
  6282. // US Naval Observatory, particularly the
  6283. // Directorate of Time
  6284. // and their definitions of
  6285. // Systems of Time.
  6286. DEF_ENDLIST
  6287. DEF_METHOD
  6288. public Date()
  6289. //    Creates today's date/time.
  6290. // 
  6291. DEF_ENDLIST
  6292. DEF_METHOD
  6293. public Date(long date)
  6294. //    Creates a date.
  6295. // The fields are normalized before the Date object is created.
  6296. // The argument does not have to be in the correct range. For
  6297. // example, the 32nd of January is correctly interpreted as the
  6298. // 1st of February.  You can use this to figure out what day a
  6299. // particular date falls on.
  6300. //   
  6301. //      Parameters:
  6302. //      date - the value of the argument to be created
  6303. //   
  6304. // 
  6305. DEF_ENDLIST
  6306. DEF_METHOD
  6307. public Date(int year,
  6308.             int month,
  6309.             int date)
  6310. //    Creates a date.
  6311. // The fields are normalized before the Date object is created.
  6312. // The arguments do not have to be in the correct range. For example,
  6313. // the 32nd of January is correctly interpreted as the 1st of February.
  6314. // You can use this to figure out what day a particular date falls on.
  6315. //   
  6316. //      Parameters:
  6317. //      year - a year after 1900
  6318. //      month - a month between 0-11
  6319. //      date - day of the month between 1-31
  6320. //   
  6321. // 
  6322. DEF_ENDLIST
  6323. DEF_METHOD
  6324. public Date(int year,
  6325.             int month,
  6326.             int date,
  6327.             int hrs,
  6328.             int min)
  6329. //    Creates a date.
  6330. // The fields are normalized before the Date object is created.
  6331. // The arguments do not have to be in the correct range. For example,
  6332. // the 32nd of January is correctly interpreted as the 1st of February.
  6333. // You can use this to figure out what day a particular date falls on.
  6334. //   
  6335. //      Parameters:
  6336. //      year - a year after 1900
  6337. //      month - a month between 0-11
  6338. //      date - day of the month between 1-31
  6339. //      hrs - hours between 0-23
  6340. //      min - minutes between 0-59
  6341. //   
  6342. // 
  6343. DEF_ENDLIST
  6344. DEF_METHOD
  6345. public Date(int year,
  6346.             int month,
  6347.             int date,
  6348.             int hrs,
  6349.             int min,
  6350.             int sec)
  6351. //    Creates a date. The fields are normalized before the Date object is
  6352. // created. The arguments do not have to be in the correct range. For
  6353. // example, the 32nd of January is correctly interpreted as the 1st of
  6354. // February. You can use this to figure out what day a particular date
  6355. // falls on.
  6356. //   
  6357. //      Parameters:
  6358. //      year - a year after 1900
  6359. //      month - a month between 0-11
  6360. //      date - day of the month between 1-31
  6361. //      hrs - hours between 0-23
  6362. //      min - minutes between 0-59
  6363. //      sec - seconds between 0-59
  6364. //   
  6365. // 
  6366. DEF_ENDLIST
  6367. DEF_METHOD
  6368. public Date(String s)
  6369. //    Creates a date from a string according to the syntax
  6370. // accepted by parse().
  6371. // 
  6372. DEF_ENDLIST
  6373. DEF_METHOD
  6374. public static long UTC(int year,
  6375.                        int month,
  6376.                        int date,
  6377.                        int hrs,
  6378.                        int min,
  6379.                        int sec)
  6380. //    Calculates a UTC value from YMDHMS. Interpretes
  6381. // the parameters in UTC, not in the local time zone.
  6382. //   
  6383. //      Parameters:
  6384. //      year - a year after 1900
  6385. //      month - a month between 0-11
  6386. //      date - day of the month between 1-31
  6387. //      hrs - hours between 0-23
  6388. //      min - minutes between 0-59
  6389. //      sec - seconds between 0-59
  6390. //   
  6391. // 
  6392. DEF_ENDLIST
  6393. DEF_METHOD
  6394. public static long parse(String s)
  6395. //    Given a string representing a time, parse it and return the time value.
  6396. // It accepts many syntaxes, but most importantly, in accepts the IETF
  6397. // standard date syntax: "Sat, 12 Aug 1995 13:30:00 GMT".  It understands
  6398. // the continental US time zone abbreviations, but for general use, a
  6399. // timezone offset should be used: "Sat, 12 Aug 1995 13:30:00 GMT+0430"
  6400. // (4 hours, 30 minutes west of the Greenwich meridian).
  6401. // If no time zone is specified, the local time zone is assumed.
  6402. // GMT and UTC are considered equivalent.
  6403. // 
  6404. DEF_ENDLIST
  6405. DEF_METHOD
  6406. public int getYear()
  6407. //    Returns the year after 1900.
  6408. // 
  6409. DEF_ENDLIST
  6410. DEF_METHOD
  6411. public void setYear(int year)
  6412. //    Sets the year.
  6413. //   
  6414. //      Parameters:
  6415. //      year - the year value
  6416. //   
  6417. // 
  6418. DEF_ENDLIST
  6419. DEF_METHOD
  6420. public int getMonth()
  6421. //    Returns the month. This method assigns months with the
  6422. // values 0-11, with January beginning at value 0.
  6423. // 
  6424. DEF_ENDLIST
  6425. DEF_METHOD
  6426. public void setMonth(int month)
  6427. //    Sets the month.
  6428. //   
  6429. //      Parameters:
  6430. //      month - the month value (0-11)
  6431. //   
  6432. // 
  6433. DEF_ENDLIST
  6434. DEF_METHOD
  6435. public int getDate()
  6436. //    Returns the day of the month. This method assigns days
  6437. // with the values of 1 to 31.
  6438. // 
  6439. DEF_ENDLIST
  6440. DEF_METHOD
  6441. public void setDate(int date)
  6442. //    Sets the date.
  6443. //   
  6444. //      Parameters:
  6445. //      date - the day value
  6446. //   
  6447. // 
  6448. DEF_ENDLIST
  6449. DEF_METHOD
  6450. public int getDay()
  6451. //    Returns the day of the week. This method assigns days
  6452. // of the week with the values 0-6, with 0 being Sunday.
  6453. // 
  6454. DEF_ENDLIST
  6455. DEF_METHOD
  6456. public int getHours()
  6457. //    Returns the hour. This method assigns the value of the
  6458. // hours of the day to range from 0 to 23, with midnight equal
  6459. // to 0.
  6460. // 
  6461. DEF_ENDLIST
  6462. DEF_METHOD
  6463. public void setHours(int hours)
  6464. //    Sets the hours.
  6465. //   
  6466. //      Parameters:
  6467. //      hours - the hour value
  6468. //   
  6469. // 
  6470. DEF_ENDLIST
  6471. DEF_METHOD
  6472. public int getMinutes()
  6473. //    Returns the minute. This method assigns the minutes of an
  6474. // hour to be any value from 0 to 59.
  6475. // 
  6476. DEF_ENDLIST
  6477. DEF_METHOD
  6478. public void setMinutes(int minutes)
  6479. //    Sets the minutes.
  6480. //   
  6481. //      Parameters:
  6482. //      minutes - the value of the minutes
  6483. //   
  6484. // 
  6485. DEF_ENDLIST
  6486. DEF_METHOD
  6487. public int getSeconds()
  6488. //    Returns the second. This method assigns the seconds of
  6489. // a minute to values of 0-59.
  6490. // 
  6491. DEF_ENDLIST
  6492. DEF_METHOD
  6493. public void setSeconds(int seconds)
  6494. //    Sets the seconds.
  6495. //   
  6496. //      Parameters:
  6497. //      seconds - the second value
  6498. //   
  6499. // 
  6500. DEF_ENDLIST
  6501. DEF_METHOD
  6502. public long getTime()
  6503. //    Returns the time in milliseconds since the epoch.
  6504. // 
  6505. DEF_ENDLIST
  6506. DEF_METHOD
  6507. public void setTime(long time)
  6508. //    Sets the time.
  6509. //   
  6510. //      Parameters:
  6511. //      time - The new time value in milliseconds since the epoch.
  6512. //   
  6513. // 
  6514. DEF_ENDLIST
  6515. DEF_METHOD
  6516. public boolean before(Date when)
  6517. //    Checks whether this date comes before the specified date.
  6518. //   
  6519. //      Parameters:
  6520. //      when - the date to compare
  6521. //      Returns:
  6522. //      true if the original date comes before the specified
  6523. // one; false otherwise.
  6524. //   
  6525. // 
  6526. DEF_ENDLIST
  6527. DEF_METHOD
  6528. public boolean after(Date when)
  6529. //    Checks whether this date comes after the specified date.
  6530. //   
  6531. //      Parameters:
  6532. //      when - the date to compare
  6533. //      Returns:
  6534. //      true if the original date comes after the specified
  6535. // one; false otherwise.
  6536. //   
  6537. // 
  6538. DEF_ENDLIST
  6539. DEF_METHOD
  6540. public boolean equals(Object obj)
  6541. //    Compares this object against the specified object.
  6542. //   
  6543. //      Parameters:
  6544. //      obj - the object to compare with
  6545. //      Returns:
  6546. //      true if the objects are the same; false otherwise.
  6547. //      Overrides:
  6548. //      equals in class Object
  6549. //   
  6550. // 
  6551. DEF_ENDLIST
  6552. DEF_METHOD
  6553. public int hashCode()
  6554. //    Computes a hashCode.
  6555. //   
  6556. //      Overrides:
  6557. //      hashCode in class Object
  6558. //   
  6559. // 
  6560. DEF_ENDLIST
  6561. DEF_METHOD
  6562. public String toString()
  6563. //    Converts a date to a String, using the UNIX ctime conventions.
  6564. //   
  6565. //      Overrides:
  6566. //      toString in class Object
  6567. //   
  6568. // 
  6569. DEF_ENDLIST
  6570. DEF_METHOD
  6571. public String toLocaleString()
  6572. //    Converts a date to a String, using the locale conventions.
  6573. // 
  6574. DEF_ENDLIST
  6575. DEF_METHOD
  6576. public String toGMTString()
  6577. //    Converts a date to a String, using the Internet GMT conventions.
  6578. // 
  6579. DEF_ENDLIST
  6580. DEF_METHOD
  6581. public int getTimezoneOffset()
  6582. //    Return the time zone offset in minutes for the current locale that is appropriate
  6583. // for this time.  This value would be a constant except for
  6584. // daylight savings time.
  6585. // 
  6586. DEF_ENDLIST
  6587. DEF_ENDCOMPONENT
  6588. DEF_COMPONENTNAME
  6589. Dictionary
  6590. DEF_SUPERCLASS
  6591. Object
  6592. DEF_SUPERCOMPONENT
  6593.  
  6594. DEF_PACKAGE
  6595. java
  6596. util
  6597. DEF_ENDLIST
  6598. DEF_SUBCOMPONENTLIST
  6599. DEF_ENDLIST
  6600. DEF_SUBCOMPONENTCLASSLIST
  6601. DEF_ENDLIST
  6602. DEF_CATEGORY
  6603.  
  6604. DEF_BITMAP
  6605.  
  6606. DEF_THUMBNAIL_UP
  6607.  
  6608. DEF_THUMBNAIL_DOWN
  6609.  
  6610. DEF_BASE
  6611. DEF_IMPORTS
  6612. java.util.Dictionary
  6613. DEF_ENDLIST
  6614. DEF_REQUIRES
  6615. DEF_ENDLIST
  6616. DEF_IMPLEMENTS
  6617. DEF_ENDLIST
  6618. DEF_DECLARATION
  6619. // The Dictionary class is the abstract parent of Hashtable, which maps
  6620. // keys to values. Any object can be used as a key and/or value.
  6621. // 
  6622. //      See Also:
  6623. //      Hashtable, hashCode, equals
  6624. // 
  6625. DEF_ENDLIST
  6626. DEF_METHOD
  6627. public Dictionary()
  6628. //    Returns the number of elements contained within the Dictionary.
  6629. // 
  6630. DEF_ENDLIST
  6631. DEF_METHOD
  6632. public abstract boolean isEmpty()
  6633. //    Returns true if the Dictionary contains no elements.
  6634. // 
  6635. DEF_ENDLIST
  6636. DEF_METHOD
  6637. public abstract Enumeration keys()
  6638. //    Returns an enumeration of the Dictionary's keys.
  6639. //   
  6640. //      See Also:
  6641. //      elements, Enumeration
  6642. //   
  6643. // 
  6644. DEF_ENDLIST
  6645. DEF_METHOD
  6646. public abstract Enumeration elements()
  6647. //    Returns an enumeration of the elements. Use the Enumeration methods 
  6648. // on the returned object to fetch the elements sequentially.
  6649. //   
  6650. //      See Also:
  6651. //      keys, Enumeration
  6652. //   
  6653. // 
  6654. DEF_ENDLIST
  6655. DEF_METHOD
  6656. public abstract Object get(Object key)
  6657. //    Gets the object associated with the specified key in the Dictionary.
  6658. //   
  6659. //      Parameters:
  6660. //      key - the key in the hash table
  6661. //      Returns:
  6662. //      s the element for the key, or null if the key
  6663. //         is not defined in the hash table.
  6664. //      See Also:
  6665. //      put
  6666. //   
  6667. // 
  6668. DEF_ENDLIST
  6669. DEF_METHOD
  6670. public abstract Object put(Object key,
  6671.                            Object value)
  6672. //    Puts the specified element into the Dictionary, using the specified
  6673. // key.  The element may be retrieved by doing a get() with the same 
  6674. // key.  The key and the element cannot be null.
  6675. //   
  6676. //      Parameters:
  6677. //      key - the specified hashtable key
  6678. //      value - the specified element
  6679. //      Returns:
  6680. //      the old value of the key, or null if it did not have one.
  6681. //      Throws: NullPointerException
  6682. //      If the value of the specified
  6683. // element is null.
  6684. //      See Also:
  6685. //      get
  6686. //   
  6687. // 
  6688. DEF_ENDLIST
  6689. DEF_METHOD
  6690. public abstract Object remove(Object key)
  6691. //    Removes the element corresponding to the key. Does nothing if the
  6692. // key is not present.
  6693. //   
  6694. //      Parameters:
  6695. //      key - the key that needs to be removed
  6696. //      Returns:
  6697. //      the value of key, or null if the key was not found.
  6698. //   
  6699. // 
  6700. DEF_ENDLIST
  6701. DEF_ENDCOMPONENT
  6702. DEF_COMPONENTNAME
  6703. EmptyStackException
  6704. DEF_SUPERCLASS
  6705. RuntimeException
  6706. DEF_SUPERCOMPONENT
  6707.  
  6708. DEF_PACKAGE
  6709. java
  6710. util
  6711. DEF_ENDLIST
  6712. DEF_SUBCOMPONENTLIST
  6713. DEF_ENDLIST
  6714. DEF_SUBCOMPONENTCLASSLIST
  6715. DEF_ENDLIST
  6716. DEF_CATEGORY
  6717.  
  6718. DEF_BITMAP
  6719.  
  6720. DEF_THUMBNAIL_UP
  6721.  
  6722. DEF_THUMBNAIL_DOWN
  6723.  
  6724. DEF_BASE
  6725. DEF_IMPORTS
  6726. java.util.EmptyStackException
  6727. DEF_ENDLIST
  6728. DEF_REQUIRES
  6729. DEF_ENDLIST
  6730. DEF_IMPLEMENTS
  6731. DEF_ENDLIST
  6732. DEF_DECLARATION
  6733. // Signals that the stack is empty.
  6734. // 
  6735. //      See Also:
  6736. //      Stack
  6737. // 
  6738. DEF_ENDLIST
  6739. DEF_METHOD
  6740. public EmptyStackException()
  6741. //    Constructs a new EmptyStackException with no detail message.
  6742. // A detail message is a String that describes the exception.
  6743. // 
  6744. DEF_ENDLIST
  6745. DEF_ENDCOMPONENT
  6746. DEF_COMPONENTNAME
  6747. Hashtable
  6748. DEF_SUPERCLASS
  6749. Dictionary
  6750. DEF_SUPERCOMPONENT
  6751.  
  6752. DEF_PACKAGE
  6753. java
  6754. util
  6755. DEF_ENDLIST
  6756. DEF_SUBCOMPONENTLIST
  6757. DEF_ENDLIST
  6758. DEF_SUBCOMPONENTCLASSLIST
  6759. DEF_ENDLIST
  6760. DEF_CATEGORY
  6761.  
  6762. DEF_BITMAP
  6763.  
  6764. DEF_THUMBNAIL_UP
  6765.  
  6766. DEF_THUMBNAIL_DOWN
  6767.  
  6768. DEF_BASE
  6769. DEF_IMPORTS
  6770. java.util.Hashtable
  6771. DEF_ENDLIST
  6772. DEF_REQUIRES
  6773. DEF_ENDLIST
  6774. DEF_IMPLEMENTS
  6775. Cloneable
  6776. DEF_ENDLIST
  6777. DEF_DECLARATION
  6778. // Hashtable class. Maps keys to values. Any object can be used as
  6779. // a key and/or value.
  6780. // To sucessfully store and retrieve objects from a hash table, the
  6781. // object used as the key must implement the hashCode() and equals()
  6782. // methods.
  6783. // This example creates a hashtable of numbers. It uses the names of
  6784. // the numbers as keys:
  6785. // 
  6786. //     Hashtable numbers = new Hashtable();
  6787. //     numbers.put("one", new Integer(1));
  6788. //     numbers.put("two", new Integer(2));
  6789. //     numbers.put("three", new Integer(3));
  6790. // 
  6791. // To retrieve a number use:
  6792. // 
  6793. //     Integer n = (Integer)numbers.get("two");
  6794. //     if (n != null) {
  6795. //         System.out.println("two = " + n);
  6796. //     }
  6797. // 
  6798. // 
  6799. //      See Also:
  6800. //      hashCode, equals
  6801. // 
  6802. DEF_ENDLIST
  6803. DEF_METHOD
  6804. public Hashtable(int initialCapacity,
  6805.                  float loadFactor)
  6806. //    Constructs a new, empty hashtable with the specified initial 
  6807. // capacity and the specified load factor.
  6808. //   
  6809. //      Parameters:
  6810. //      initialCapacity - the initial number of buckets
  6811. //      loadFactor - a number between 0.0 and 1.0, it defines
  6812. //         the threshold for rehashing the hashtable into
  6813. //         a bigger one.
  6814. //      Throws: IllegalArgumentException
  6815. //      If the initial capacity
  6816. // is less than or equal to zero.
  6817. //      Throws: IllegalArgumentException
  6818. //      If the load factor is
  6819. // less than or equal to zero.
  6820. //   
  6821. // 
  6822. DEF_ENDLIST
  6823. DEF_METHOD
  6824. public Hashtable(int initialCapacity)
  6825. //    Constructs a new, empty hashtable with the specified initial 
  6826. // capacity.
  6827. //   
  6828. //      Parameters:
  6829. //      initialCapacity - the initial number of buckets
  6830. //   
  6831. // 
  6832. DEF_ENDLIST
  6833. DEF_METHOD
  6834. public Hashtable()
  6835. //    Constructs a new, empty hashtable. A default capacity and load factor
  6836. // is used. Note that the hashtable will automatically grow when it gets
  6837. // full.
  6838. // 
  6839. DEF_ENDLIST
  6840. DEF_METHOD
  6841. public int size()
  6842. //    Returns the number of elements contained in the hashtable.
  6843. //   
  6844. //      Overrides:
  6845. //      size in class Dictionary
  6846. //   
  6847. // 
  6848. DEF_ENDLIST
  6849. DEF_METHOD
  6850. public boolean isEmpty()
  6851. //    Returns true if the hashtable contains no elements.
  6852. //   
  6853. //      Overrides:
  6854. //      isEmpty in class Dictionary
  6855. //   
  6856. // 
  6857. DEF_ENDLIST
  6858. DEF_METHOD
  6859. public synchronized Enumeration keys()
  6860. //    Returns an enumeration of the hashtable's keys.
  6861. //   
  6862. //      Overrides:
  6863. //      keys in class Dictionary
  6864. //      See Also:
  6865. //      elements, Enumeration
  6866. //   
  6867. // 
  6868. DEF_ENDLIST
  6869. DEF_METHOD
  6870. public synchronized Enumeration elements()
  6871. //    Returns an enumeration of the elements. Use the Enumeration methods 
  6872. // on the returned object to fetch the elements sequentially.
  6873. //   
  6874. //      Overrides:
  6875. //      elements in class Dictionary
  6876. //      See Also:
  6877. //      keys, Enumeration
  6878. //   
  6879. // 
  6880. DEF_ENDLIST
  6881. DEF_METHOD
  6882. public synchronized boolean contains(Object value)
  6883. //    Returns true if the specified object is an element of the hashtable.
  6884. // This operation is more expensive than the containsKey() method.
  6885. //   
  6886. //      Parameters:
  6887. //      value - the value that we are looking for
  6888. //      Throws: NullPointerException
  6889. //      If the value being searched 
  6890. // for is equal to null.
  6891. //      See Also:
  6892. //      containsKey
  6893. //   
  6894. // 
  6895. DEF_ENDLIST
  6896. DEF_METHOD
  6897. public synchronized boolean containsKey(Object key)
  6898. //    Returns true if the collection contains an element for the key.
  6899. //   
  6900. //      Parameters:
  6901. //      key - the key that we are looking for
  6902. //      See Also:
  6903. //      contains
  6904. //   
  6905. // 
  6906. DEF_ENDLIST
  6907. DEF_METHOD
  6908. public synchronized Object get(Object key)
  6909. //    Gets the object associated with the specified key in the 
  6910. // hashtable.
  6911. //   
  6912. //      Parameters:
  6913. //      key - the specified key
  6914. //      Returns:
  6915. //      s the element for the key or null if the key
  6916. //         is not defined in the hash table.
  6917. //      Overrides:
  6918. //      get in class Dictionary
  6919. //      See Also:
  6920. //      put
  6921. //   
  6922. // 
  6923. DEF_ENDLIST
  6924. DEF_METHOD
  6925. protected void rehash()
  6926. //    Rehashes the content of the table into a bigger table.
  6927. // This method is called automatically when the hashtable's
  6928. // size exceeds the threshold.
  6929. // 
  6930. DEF_ENDLIST
  6931. DEF_METHOD
  6932. public synchronized Object put(Object key,
  6933.                                Object value)
  6934. //    Puts the specified element into the hashtable, using the specified
  6935. // key.  The element may be retrieved by doing a get() with the same key.
  6936. // The key and the element cannot be null.
  6937. //   
  6938. //      Parameters:
  6939. //      key - the specified key in the hashtable
  6940. //      value - the specified element
  6941. //      Returns:
  6942. //      the old value of the key, or null if it did not have one.
  6943. //      Throws: NullPointerException
  6944. //      If the value of the element 
  6945. // is equal to null.
  6946. //      Overrides:
  6947. //      put in class Dictionary
  6948. //      See Also:
  6949. //      get
  6950. //   
  6951. // 
  6952. DEF_ENDLIST
  6953. DEF_METHOD
  6954. public synchronized Object remove(Object key)
  6955. //    Removes the element corresponding to the key. Does nothing if the
  6956. // key is not present.
  6957. //   
  6958. //      Parameters:
  6959. //      key - the key that needs to be removed
  6960. //      Returns:
  6961. //      the value of key, or null if the key was not found.
  6962. //      Overrides:
  6963. //      remove in class Dictionary
  6964. //   
  6965. // 
  6966. DEF_ENDLIST
  6967. DEF_METHOD
  6968. public synchronized void clear()
  6969. //    Clears the hash table so that it has no more elements in it.
  6970. // 
  6971. DEF_ENDLIST
  6972. DEF_METHOD
  6973. public synchronized Object clone()
  6974. //    Creates a clone of the hashtable. A shallow copy is made,
  6975. // the keys and elements themselves are NOT cloned. This is a
  6976. // relatively expensive operation.
  6977. //   
  6978. //      Overrides:
  6979. //      clone in class Object
  6980. //   
  6981. // 
  6982. DEF_ENDLIST
  6983. DEF_METHOD
  6984. public synchronized String toString()
  6985. //    Converts to a rather lengthy String.
  6986. //   
  6987. //      Overrides:
  6988. //      toString in class Object
  6989. //   
  6990. // 
  6991. DEF_ENDLIST
  6992. DEF_ENDCOMPONENT
  6993.