home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / PluginFrame.java < prev    next >
Text File  |  1998-10-25  |  3KB  |  146 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi.pluginapi;
  6.  
  7. import java.awt.MenuBar;
  8. import java.awt.Rectangle;
  9. import java.io.InputStream;
  10. import java.io.OutputStream;
  11. import symantec.itools.vcafe.plugin.BasePluginFrame;
  12. import com.symantec.itools.vcafe.openapi.VisualObject;
  13.  
  14. /**
  15.  * The API used to integrate a frame window into Visual Cafe
  16.  * @see Plugin
  17.  *
  18.  * @author Symantec Internet Tools Division
  19.  * @version 1.0
  20.  * @since VCafe 3.0
  21.  */
  22. public class PluginFrame extends BasePluginFrame
  23. {
  24.     /**
  25.      * Constructor to create a frame
  26.      */
  27.     public PluginFrame()
  28.     {
  29.         this("");
  30.     }
  31.  
  32.     /**
  33.      * Create a frame with the given title
  34.      *
  35.      * @param title        The title on the frame
  36.      */
  37.     public PluginFrame(String title)
  38.     {
  39.         super(title);
  40.     }
  41.  
  42.     /**
  43.      * Enable/Disable docking of a frame. The default implementation doesnot use
  44.      * docking.
  45.      *
  46.      * @param b            true for docking window and false for regular window style
  47.      */
  48.     public void setDocking(boolean b)
  49.     {
  50.         docking = b;
  51.         super.setDocking(docking);
  52.     }
  53.  
  54.     /**
  55.      * Set the menu(s) to append to Visual Cafe's menubar. The menu(s) show up only
  56.      * when this frame is active.
  57.      *
  58.      * @param m      the menu(s) to add to Visual Cafe's menubar
  59.      */
  60.     public void setMergeMenu(MenuBar m)
  61.     {
  62.         menubar = m;
  63.         super.setMergeMenu(menubar);
  64.     }
  65.  
  66.     /**
  67.      * Get the merge menu(s) being used by this frame
  68.      *
  69.      * @return m      the merge menu(s) being used by this frame
  70.      */
  71.     public MenuBar getMergeMenu()
  72.     {
  73.         return menubar;
  74.     }
  75.  
  76.     /**
  77.      * Set the help id for this frame. Pressing F1 on an active plug in frame will
  78.      * invoke online help displaying the link specified by the given id.
  79.      *
  80.      * @param id     the help id to use for this view
  81.      */
  82.     public void setHelpId(int id)
  83.     {
  84.         helpId = id;
  85.         super.setHelpId(id);
  86.     }
  87.  
  88.     /**
  89.      * Get the help id used by this frame.
  90.      *
  91.      * @return      the help id being used by this frame
  92.      */
  93.     public int getHelpId()
  94.     {
  95.         return helpId;
  96.     }
  97.  
  98.     /**
  99.      * Frame persistence.
  100.      * Save this frame window information such as size/location/docking etc.
  101.      *
  102.      * @param os        the output stream to which data will be written
  103.      */
  104.     public void save(OutputStream os)
  105.     {
  106.         super.save(os);
  107.     }
  108.  
  109.     /**
  110.      * Frame persistence.
  111.      * Restore this frame window information such as size/location/docking etc.
  112.      *
  113.      * @param is            the input stream from which to read the data
  114.      */
  115.     public void restore(InputStream is)
  116.     {
  117.         super.restore(is);
  118.     }
  119.  
  120.     /**
  121.      * Locates the VisualObject that contains the x,y position.
  122.      *
  123.      * @param x                the <i>x</i> coordinate
  124.      * @param y                the <i>y</i> coordinate
  125.      *
  126.      * @return                null if there is no visual object containing position.
  127.      */
  128.     public VisualObject getVisualObjectAt(int x, int y)
  129.     {
  130.         return null;
  131.     }
  132.  
  133.     /**
  134.      * Returns the bounding rectangle of the given VisualObject
  135.      *
  136.      * @param vo            the VisualObject
  137.      */
  138.     public Rectangle getVisualObjectBounds(VisualObject vo)
  139.     {
  140.         return null;
  141.     }
  142.  
  143.     private int helpId = 0;
  144.     private MenuBar menubar;
  145.     private boolean docking = false;
  146. }