Class com.symantec.itools.vcafe.openapi.plugin.PlugInWindow 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.plugin.PlugInWindow 

Object
   |
   +----PlugInView
           |
           +----com.symantec.itools.vcafe.openapi.plugin.PlugInWindow
public abstract class PlugInWindow
extends PlugInView
PlugInWindow is the base class containing methods required to integrate a window into Visual Cafe environment.

Variable Index

o BREAKPOINTS
o CALLS
o CLASSES
o CLASS_BROWSER_CLASSES_PANE_POPUP
o CLASS_BROWSER_EDITOR_PANE_POPUP
o CLASS_BROWSER_MEMBERS_PANE_POPUP
o COMP_LIBRARY_POPUP
o DATABASE
o EDIT
o EDITOR_POPUP
o FILE
Predefined Visual Cafe menu names.
o FILE_VIEW_TAB_POPUP
o FORM_EDITOR_POPUP
o HELP
o HIERARCHY
o INSERT
o LAYOUT
o NEW
o OBJECT
o OBJECT_VIEW_TAB_POPUP
Predefined contextual menu names.
o PACKAGE_VIEW_TAB_POPUP
o PROJECT
o SEARCH
o SOURCE
o THREADS
o TOOLS
o VARIABLES
o VIEW
o WINDOW

Constructor Index

o com.symantec.itools.vcafe.openapi.plugin.PlugInWindow()

Method Index

o getBounds()
Returns the bounding rectangle of the plug in view window
o getContextualMenu(String, Vector)
This method is called by the framework every time a contextual menu is ready to be shown.
o getHostMenuName()
This method is called by the framework to find the name of the menu in Visual Cafe which is going to contain a menu item for this plug in view.
o getMaximumSize()
This method is called by the framework to obtain the maximum size for the plug in view.
o getMenuItemHelpId()
This method is called by the framework to obtain the help id for the menuitem which starts this plug in view.
o getMinimumSize()
This method is called by the framework to obtain the minimum size for the plug in view.
o getPreferredLocation()
This method is called by the framework to find the coordinates where the the plug in view should be placed.
o getPreferredSize()
This method is called by the framework to obtain the width and height to use when the plug in view is first displayed.
o isResizable()
This method is called by the framework to find if the plug in view should be resizable The default implementation returns true.
o setNewColors(Color, Color, Color, Color)
This method is called by the framework when the user changes the colors to be used in a plug in view.
o setNewFont(Font)
This method is called by the framework when the user changes the font to be used in the plug in view.
o toFront()
Brings the plug in view window to the front.

Variables

o BREAKPOINTS 
public static java.lang.String BREAKPOINTS
o CALLS 
public static java.lang.String CALLS
o CLASSES 
public static java.lang.String CLASSES
o CLASS_BROWSER_CLASSES_PANE_POPUP 
public static final java.lang.String CLASS_BROWSER_CLASSES_PANE_POPUP
o CLASS_BROWSER_EDITOR_PANE_POPUP 
public static final java.lang.String CLASS_BROWSER_EDITOR_PANE_POPUP
o CLASS_BROWSER_MEMBERS_PANE_POPUP 
public static final java.lang.String CLASS_BROWSER_MEMBERS_PANE_POPUP
o COMP_LIBRARY_POPUP 
public static final java.lang.String COMP_LIBRARY_POPUP
o DATABASE 
public static java.lang.String DATABASE
o EDIT 
public static java.lang.String EDIT
o EDITOR_POPUP 
public static final java.lang.String EDITOR_POPUP
o FILE 
public static java.lang.String FILE
Predefined Visual Cafe menu names.

o FILE_VIEW_TAB_POPUP 
public static final java.lang.String FILE_VIEW_TAB_POPUP
o FORM_EDITOR_POPUP 
public static final java.lang.String FORM_EDITOR_POPUP
o HELP 
public static java.lang.String HELP
o HIERARCHY 
public static java.lang.String HIERARCHY
o INSERT 
public static java.lang.String INSERT
o LAYOUT 
public static java.lang.String LAYOUT
o NEW 
public static java.lang.String NEW
o OBJECT 
public static java.lang.String OBJECT
o OBJECT_VIEW_TAB_POPUP 
public static final java.lang.String OBJECT_VIEW_TAB_POPUP
Predefined contextual menu names. These names are internal names. Use these constants for comparison in getContextualMenu only.

o PACKAGE_VIEW_TAB_POPUP 
public static final java.lang.String PACKAGE_VIEW_TAB_POPUP
o PROJECT 
public static java.lang.String PROJECT
o SEARCH 
public static java.lang.String SEARCH
o SOURCE 
public static java.lang.String SOURCE
o THREADS 
public static java.lang.String THREADS
o TOOLS 
public static java.lang.String TOOLS
o VARIABLES 
public static java.lang.String VARIABLES
o VIEW 
public static java.lang.String VIEW
o WINDOW 
public static java.lang.String WINDOW

Constructors

o PlugInWindow 
public PlugInWindow()

Methods

o getBounds 
public java.awt.Rectangle getBounds()
Returns the bounding rectangle of the plug in view window

Returns:
the bounding rectangle
o getContextualMenu 
public java.awt.Menu getContextualMenu(String menuName,
                                       Vector selection)
This method is called by the framework every time a contextual menu is ready to be shown. The user should add any required ActionListener to the returned Menu or MenuItems in order to be notified of actions.

Parameters:
menuName - the name of the contextual menu
selection - the selection of objects on which the menu operates
Returns:
a menu containing the menu items to display
o getHostMenuName 
public static java.lang.String getHostMenuName()
This method is called by the framework to find the name of the menu in Visual Cafe which is going to contain a menu item for this plug in view. The default implementation returns the TOOLS menu.

Returns:
name of a Visual Cafe menu
o getMaximumSize 
public java.awt.Dimension getMaximumSize()
This method is called by the framework to obtain the maximum size for the plug in view. The default implementation returns width=MAX_VALUE and height=MAX_VALUE.

Returns:
the Dimension to use for this view
o getMenuItemHelpId 
public static int getMenuItemHelpId()
This method is called by the framework to obtain the help id for the menuitem which starts this plug in view. Pressing F1 on the menuitem will invoke online help displaying the link specified by the given id. The default implementation of this method returns 0, meaning no help is available. The reason this method is static is because the plug in view may not created yet.

Returns:
the help id to use for the menuitem which starts this plug in view
o getMinimumSize 
public java.awt.Dimension getMinimumSize()
This method is called by the framework to obtain the minimum size for the plug in view. The default implementation returns width=0 and height=0.

Returns:
the Dimension to use for this view
o getPreferredLocation 
public java.awt.Point getPreferredLocation()
This method is called by the framework to find the coordinates where the the plug in view should be placed. The default implementation returns (0,0).

Returns:
x,y coordinate
o getPreferredSize 
public java.awt.Dimension getPreferredSize()
This method is called by the framework to obtain the width and height to use when the plug in view is first displayed. The default implementation of this method returns width=50 and height=50.

Returns:
the Dimension to use for this view
o isResizable 
public boolean isResizable()
This method is called by the framework to find if the plug in view should be resizable The default implementation returns true.

Returns:
true for resizable and false otherwise
o setNewColors 
public void setNewColors(Color text,
                         Color backGround,
                         Color selText,
                         Color selBackGround)
This method is called by the framework when the user changes the colors to be used in a plug in view. A plug in view may update its user interface with the new colors.

Parameters:
text - the color of the text display in plug in view
backGround - the background color shown in plug in view
selText - the color of text to use when highlighted
selBackGround - the background color when text is highlighted
o setNewFont 
public void setNewFont(Font f)
This method is called by the framework when the user changes the font to be used in the plug in view. A plug in view may update the window with new font.

Parameters:
f - the new font object
o toFront 
public void toFront()
Brings the plug in view window to the front. Places this window at the top of the stacking order and shows it in front of any other windows. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index