All Packages  Class Hierarchy  This Package  Previous  Next  Index

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

Object
   |
   +----PlugInView
           |
           +----PlugInWindow
                   |
                   +----com.symantec.itools.vcafe.openapi.plugin.PlugInFrame

public abstract class PlugInFrame

extends PlugInWindow

ID_EDIT_CLEAR

ID_EDIT_CLEAR_ALL

ID_EDIT_COPY

ID_EDIT_CUT

ID_EDIT_FIND

ID_EDIT_PASTE

ID_EDIT_PASTE_LINK

ID_EDIT_PASTE_SPECIAL

ID_EDIT_REDO

ID_EDIT_REPEAT

ID_EDIT_REPLACE

ID_EDIT_SELECT_ALL

ID_EDIT_UNDO

PLUGIN_MENU_BEGIN_ID

PLUGIN_MENU_END_ID

com.symantec.itools.vcafe.openapi.plugin.PlugInFrame()

This method is called by the framework to construct an instance of the plug in view.

destroyOnClose()

This method is called by the framework to find if the plug in view should be destroyed when the window is closed.

getContextWinHelpId(int)

This method is called by the framework to obtain the help id of a menuitem in the plug in view menu(s).

getPlugInMenu()

This method is called by the framework to obtain the menu(s) to append to Visual Cafe's menubar.

getVisualObjectAt(int, int)

Locates the VisualObject that contains the x,y position.

getVisualObjectBounds(VisualObject)

Returns the bounding rectangle of the given VisualObject

isDockingView()

This method is called by the framework to find if the plug in view should have docking functionality.

isGlobalView()

This method is called by the framework to find if the plug in view exists as a global view or a local view.

onActivateWindow(boolean)

This method is called by the framework when the host window is being made active or inactive.

onPlugInMenuCommand(int)

This method is called by the framework when a menuitem in the plug in view menu(s) is selected.

onPlugInMenuCommandUpdate(int)

This method is called by the framework to obtain the state of a menuitem in the plug in view menu(s).

onVisualCafeMenuCommand(int)

This method is called by the framework when a menuitem in Visual Cafe menu(s) is selected.

onVisualCafeMenuCommandUpdate(int)

This method is called by the framework to obtain the state of a menuitem in Visual Cafe menu(s).

restoreState(InputStream)

This method is called by the framework before opening the plug in view.

saveState(OutputStream)

This method is called by the framework before closing the plug in view.

public static final int ID_EDIT_CLEAR

public static final int ID_EDIT_CLEAR_ALL

public static final int ID_EDIT_COPY

public static final int ID_EDIT_CUT

public static final int ID_EDIT_FIND

public static final int ID_EDIT_PASTE

public static final int ID_EDIT_PASTE_LINK

public static final int ID_EDIT_PASTE_SPECIAL

public static final int ID_EDIT_REDO

public static final int ID_EDIT_REPEAT

public static final int ID_EDIT_REPLACE

public static final int ID_EDIT_SELECT_ALL

public static final int ID_EDIT_UNDO

public static final int PLUGIN_MENU_BEGIN_ID

public static final int PLUGIN_MENU_END_ID

public PlugInFrame()

This method is called by the framework to construct an instance of the plug in view. The default implementation of this method is empty. A plug in view might perform some initialization tasks by overriding this method.

public boolean destroyOnClose()

This method is called by the framework to find if the plug in view should be destroyed when the window is closed. By default a global view is hidden when the window is closed. The default implementation returns false.

Returns:

true to destroy the plug in view, false otherwise

public int getContextWinHelpId(int id)

This method is called by the framework to obtain the help id of a menuitem in the plug in view menu(s). The default implementation returns 0, meaning the id returned by getWinHelpId will be used.

Parameters:

id - the id of the selected menuitem

Returns:

the help id to use for this menuitem

public java.awt.MenuBar getPlugInMenu()

This method is called by the framework to obtain the menu(s) to append to Visual Cafe's menubar. The default implementation of this method returns a null.

Returns:

the menu(s) to add in frame window of Visual Cafe environment

public com.symantec.itools.vcafe.openapi.VisualObject getVisualObjectAt(int x,
                                                                        int y)

Locates the VisualObject that contains the x,y position.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

null if there is no visual object containing position.

public java.awt.Rectangle getVisualObjectBounds(VisualObject vo)

Returns the bounding rectangle of the given VisualObject

Parameters:

vo - the VisualObject

public boolean isDockingView()

This method is called by the framework to find if the plug in view should have docking functionality. The default implementation returns false.

Returns:

true for docking window and false for regular window style

public boolean isGlobalView()

This method is called by the framework to find if the plug in view exists as a global view or a local view. A global view exists across various invocations of projects. A local view exists on a per project basis. The default implementation returns true.

Returns:

true for global views and false for local views

public void onActivateWindow(boolean bActive)

This method is called by the framework when the host window is being made active or inactive.

Parameters:

bActive - It is true if the window is being activated It is false if the window is being made inactive

public void onPlugInMenuCommand(int id)

This method is called by the framework when a menuitem in the plug in view menu(s) is selected. The default implementation does nothing.

Parameters:

id - the id of the selected menuitem

public boolean onPlugInMenuCommandUpdate(int id)

This method is called by the framework to obtain the state of a menuitem in the plug in view menu(s). The default implementation returns false.

Parameters:

id - the id of the menuitem which needs an update

Returns:

enable/disable the menuitem

public void onVisualCafeMenuCommand(int id)

This method is called by the framework when a menuitem in Visual Cafe menu(s) is selected. The default implementation does nothing.

Parameters:

id - the id of the selected menuitem

public boolean onVisualCafeMenuCommandUpdate(int id)

This method is called by the framework to obtain the state of a menuitem in Visual Cafe menu(s). The default implementation returns false.

Parameters:

id - the id of the menuitem which needs an update

Returns:

enable/disable the menuitem

public void restoreState(InputStream is)

This method is called by the framework before opening the plug in view. A plug in view might want to read any state information it might have saved when it was closed in an earlier instantiation.

Parameters:

is - the input stream from which to read the data

public void saveState(OutputStream os)

This method is called by the framework before closing the plug in view. A plug in view might want to save any state information it might have to the disk. This information can be read back when the plug in view is instantiated again.

Parameters:

os - the output stream to which data will be written

All Packages  Class Hierarchy  This Package  Previous  Next  Index