home *** CD-ROM | disk | FTP | other *** search
/ Boot Disc 13 / boot-disc-1997-09.iso / HyprWire / DATA.Z / VisualRunService.java < prev    next >
Text File  |  1997-01-21  |  5KB  |  148 lines
  1. package kinetix.hyperc1.runtime;
  2.  
  3. /********************************************************************************\
  4. **                                                                              **
  5. **  (C) Copyright 1997 by Autodesk, Inc.                                        **
  6. **                                                                              **
  7. **  This program is copyrighted by Autodesk, Inc. and is licensed to you under  **
  8. **  the following conditions.  You may not distribute or publish the source     **
  9. **  code of this program in any form.  You may incorporate this code in object  **
  10. **  form in derivative works provided such derivative works are (i.) are de-    **
  11. **  signed and intended to work solely with Autodesk, Inc. products, and (ii.)  **
  12. **  contain Autodesk's copyright notice "(C) Copyright 1997 by Autodesk, Inc."  **
  13. **                                                                              **
  14. **  AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.  AUTODESK SPE-  **
  15. **  CIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR  **
  16. **  A PARTICULAR USE.  AUTODESK, INC.  DOES NOT WARRANT THAT THE OPERATION OF   **
  17. **  THE PROGRAM WILL BE UNINTERRUPTED OR ERROR FREE.                            **
  18. **                                                                              **
  19. \********************************************************************************/
  20.  
  21. import java.awt.Event;
  22. import java.awt.Rectangle;
  23. import java.awt.Point;
  24. import java.awt.Graphics;
  25. import java.awt.image.ImageObserver;
  26.  
  27. /** System service interface for all visual plug-ins.
  28. * This provides general utility methods, and queries
  29. * for properties maintained internally by the system
  30. * for all visual plug-ins
  31. */
  32. public interface VisualRunService extends BasicRunService
  33. {
  34.     /** siGenerateMouseDownEvent **
  35.     * Fire the wires connected to the Button Down port
  36.     * for this plug-in instance 
  37.     */
  38.     public void siGenerateMouseDownEvent(Event evt, int x, int y)
  39.         throws HwException;
  40.  
  41.     /** siGenerateClickedEvent **
  42.     * Fire the wires connected to the Button Up port
  43.     * for this plug-in instance
  44.     */
  45.     public void siGenerateClickedEvent(Event evt, int x, int y)
  46.         throws HwException;
  47.  
  48.     /** siGetAbsRect **
  49.     * Returns the bounding rectangle for the plug-in relative
  50.     * only to the surrounding applet, not to any intermediary
  51.     * visual containers
  52.     */
  53.     public Rectangle siGetAbsRect();
  54.  
  55.     /** siGetImageObserver **
  56.     * Returns the implementer of this interface, cast to an
  57.     * ImageObserver. This is primarily for plug-ins which must
  58.     * handle asynchronous image loading and don't wan't to write
  59.     * an imageUpdate callback method
  60.     */
  61.     public ImageObserver siGetImageObserver();
  62.  
  63.     /** siGetIsClickable **
  64.     * Returns true if the plug-in instance is currently clickable, 
  65.     * false otherwise
  66.     */
  67.     public boolean siGetIsClickable();
  68.  
  69.     /** siGetLastPosition **
  70.     * Returns the previous position of the plug-in
  71.     */
  72.     public Point siGetLastPosition();
  73.  
  74.     /** siGetPosition **
  75.     * Returns the current position of the plug-in
  76.     */
  77.     public Point siGetPosition();
  78.  
  79.     /** siGetRelativeRect **
  80.     * Returns the bounding rectangle of the plug-in relative to
  81.     * its immediate parent
  82.     */
  83.     public Rectangle siGetRelativeRect();
  84.  
  85.     /** siGetScreenRect **
  86.     * Returns the bounding rectangle of the plug-in relative only
  87.     * to the entire screen
  88.     */
  89.     public Rectangle siGetScreenRect();
  90.  
  91.     /** siGetIsSelectable **
  92.     * Returns true if the plug-in instance is currently selectable
  93.     * false otherwise
  94.     */
  95.     public boolean siGetIsSelectable();
  96.  
  97.     /** siGetIsVisible **
  98.     * Returns the current effective visibility of the plug-in. The
  99.     * effective visibility is the logical AND of the plug-in's
  100.     * requested visibility and the visibility of the hierarchy
  101.     * above the plug-in
  102.     */
  103.     public boolean siGetIsVisible();
  104.  
  105.     /** siGetIsMoveable **
  106.     * Returns true if the plug-in is currently moveable, false otherwise
  107.     */
  108.     public boolean siGetIsMoveable();
  109.  
  110.     /** siPaintRect **
  111.     * Paints the portion of the applet specified by aRect (coordinates
  112.     * are relative only to the applet, not any intermediate visual
  113.     * containers). If aRect == null, the bounding rectangle of the 
  114.     * plug-in is painted. 
  115.     */ 
  116.     public void siPaintRect(Rectangle aRect);
  117.     public void siPaintRect();
  118.  
  119.     /** siSetAbsRect **
  120.     * Sets the new bounding rectangle for the plug-in relative only to
  121.     * the applet
  122.     */
  123.     public void siSetAbsRect(Rectangle aRect);
  124.  
  125.     /** siSetIsClickable **
  126.     * Sets the current clickable state of the plug-in
  127.     */
  128.     public void siSetIsClickable(boolean aValue);
  129.  
  130.     /** siSetPosition **
  131.     * Sets the current position of the plug-in
  132.     */
  133.     public void siSetPosition(Point aPos)
  134.         throws HwException;
  135.  
  136.     /** siSetIsSelectable **
  137.     * Sets the current selectable state of the plug-in
  138.     */
  139.     public void siSetIsSelectable(boolean aValue);
  140.  
  141.     /** siSetIsVisible **
  142.     * Sets the current requested visible state of the plug-in. If the plug-in 
  143.     * is a visual container this may change the effective visibility
  144.     * of its children
  145.     */
  146.     public void siSetIsVisible(boolean aValue);
  147. }
  148.