Class besiex.FrIJDE.AbstractClasses.FrIJDETool
All Packages Class Hierarchy This Package Previous Next Index
Class besiex.FrIJDE.AbstractClasses.FrIJDETool
java.lang.Object
|
+----besiex.FrIJDE.AbstractClasses.FrIJDETool
- public class FrIJDETool
- extends Object
All FrIJDETools are extended from this class. This class defines all the most basic requirements of a FrIJDETool.
- Version:
- 1.00, 21 February 1996
Changes from last version
- Author:
- Benjamin "Quincy" Cabell V, Besiex Software
-
aboutMenuItem
- The MenuItem to be added to the FrIJDEMainFrame About menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
-
frijdeMainFrame
- A handle to the FrIJDEMainFrame.
-
helpMenuItem
- The MenuItem to be added to the FrIJDEMainFrame Help menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
-
menusOnMainMenuBar
- A FrIJDETool can request that it have additional Menus placed on the FrIJDEMainFrame MenuBar.
-
preferencesMenuItem
- The MenuItem to be added to the FrIJDEMainFrame Preferences menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
-
toolBarButtons
- A FrIJDETool can request that it have Components placed on the FrIJDEMainFrame FrIJDEBasicToolBar.
-
toolMenuItem
- The MenuItem to be added to the FrIJDEMainFrame Tools menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
-
FrIJDETool()
-
-
Close()
- When the FrIJDEMainFrame receives a request to exit it must check with all of the loaded tools.
-
GetFrIJDEMainFrame()
- FrIJDETools will often have supporting classes.
-
Init(FrIJDEMainFrame)
- Once a FrIJDETool is instantiated, it must be initialized via this method.
-
SetFrIJDEMainFrame(FrIJDEMainFrame)
- The FrIJDEToolLoader will need to be be able to set the FrIJDEMainFrame handle once each tool
is instantiated.
frijdeMainFrame
public FrIJDEMainFrame frijdeMainFrame
- A handle to the FrIJDEMainFrame.
helpMenuItem
public MenuItem helpMenuItem
- The MenuItem to be added to the FrIJDEMainFrame Help menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
preferencesMenuItem
public MenuItem preferencesMenuItem
- The MenuItem to be added to the FrIJDEMainFrame Preferences menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
toolMenuItem
public MenuItem toolMenuItem
- The MenuItem to be added to the FrIJDEMainFrame Tools menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
aboutMenuItem
public MenuItem aboutMenuItem
- The MenuItem to be added to the FrIJDEMainFrame About menu (the menu item must be able to handle
its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
menusOnMainMenuBar
public Menu menusOnMainMenuBar[]
- A FrIJDETool can request that it have additional Menus placed on the FrIJDEMainFrame MenuBar. These Menus
are stored in this array where they will be included by the FrIJDEToolLoader. Each Menu and its MenuItems
must handle their selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
toolBarButtons
public Component toolBarButtons[]
- A FrIJDETool can request that it have Components placed on the FrIJDEMainFrame FrIJDEBasicToolBar. These Components
are stored in this array where they will be included by the FrIJDEToolLoader. Each Component
must handle its selection via some form of callback mechanism, such as the
awtExt and sysExt Package).
The MightyButtonWithCallback can
be used to create tool bar buttons.
FrIJDETool
public FrIJDETool()
SetFrIJDEMainFrame
public void SetFrIJDEMainFrame(FrIJDEMainFrame theMainFrame)
- The FrIJDEToolLoader will need to be be able to set the FrIJDEMainFrame handle once each tool
is instantiated. Setting the FrIJDEMainFrame is done through this method.
- Parameters:
- theMainFrame - The handle this tool will set as the FrIJDEMainFrame handle.
GetFrIJDEMainFrame
public FrIJDEMainFrame GetFrIJDEMainFrame()
- FrIJDETools will often have supporting classes. Many of these supporting classes may need to be able
to get a handle to the FrIJDEMainFrame. These supporting classes can use this method for that purpose.
- Parameters:
- theMainFrame - The handle this tool will set as the FrIJDEMainFrame handle.
- Returns:
- The handle to the FrIJDEMainFrame.
Init
public boolean Init(FrIJDEMainFrame theFrIJDEMainFrame)
- Once a FrIJDETool is instantiated, it must be initialized via this method. This method returns true if the
initialization was usuccessful, false otherwise.
- Parameters:
- theFrIJDEMainFrame - The handle this tool will set as the FrIJDEMainFrame handle.
- Returns:
- The handle to the FrIJDEMainFrame.
Close
public abstract boolean Close()
- When the FrIJDEMainFrame receives a request to exit it must check with all of the loaded tools.
Each tool has the opportunity save/close open files/settings or exit threads, etc. If this method returns
true then the FrIJDEMainFrame is free to close, otherwise it should not.
- Returns:
- True if it is safe for the FrIJDEMainFrame to close (according to this tool). False otherwise.
All Packages Class Hierarchy This Package Previous Next Index