au.edu.swin.synergy.plugin.packager
Class BPackagePlugin

java.lang.Object
  |
  +--au.edu.swin.synergy.kernel.BPlugin
        |
        +--au.edu.swin.synergy.plugin.packager.BPackagePlugin

public class BPackagePlugin

extends BPlugin

class BPackagePlugin Main controller for the packager plugin. This plugin allows the user to create and edit packages for use with the modeller plugin.

Author:

Imron Alston

Copyright Belongs To:

Field Summary

static String	kArcTab
static String	kNodeTab
BString	kPkgExtension
static String	kTerminatorTab

Fields inherited from class au.edu.swin.synergy.kernel.BPlugin

kernel

Constructor Summary

BPackagePlugin()

Method Summary

void	doAddPNode(String metaNodeName, BScalarPoint pt)
void	doAddTerminator(String name)
BPackageModel	doCreateNewPackage(String name, String metaModelFileName) This will create a new package, with the specified name using the specified metamodel
void	doDialect() Go through all classes and change dialect according to locale.
protected void	doDisplay() This will be called to show all of the Package Editor interface components, primarily when the user selects the package editor from the Package menu or when the user creates a new package.
void	doEditPackage()
void	doEditPackage(String packageFileName) Edits the package specified by the packageFileName
protected void	doHide() This will be called to remove all of the Package Editor interface components, primarily when the user clicks on the close window button in the top right hand corner of the window.
void	doNewPackage()
void	doSavePackage()
BStringList	getDependancies() Return a list of plugin dependancies
void	onBCommandEvent(Object source, BCommandEvent event) Please complete the missing tags for onBCommandEvent
void	setup(BStringList params) This is called by the Kernel when the package plugin is first loaded.

Methods inherited from class au.edu.swin.synergy.kernel.BPlugin

dispatchEvent, dispatchEventAndWait, dispatchEventServer, dispatchEventServerAndWait, dispatchEventTo, dispatchEventToAndWait, getKernel, setKernel, setup, unload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kNodeTab

public static final String kNodeTab

kArcTab

public static final String kArcTab

kTerminatorTab

public static final String kTerminatorTab

kPkgExtension

public BString kPkgExtension

Constructor Detail

BPackagePlugin

public BPackagePlugin()

Method Detail

setup

public void setup(BStringList params)

This is called by the Kernel when the package plugin is first loaded. It will register the main menu items for the user to invoke.

Overrides:

setup in class BPlugin

Pre Condition:

The plugin has been loaded

Post Condition:

The menus and menu items are registered with the window manager (if it's loaded)

getDependancies

public BStringList getDependancies()

Return a list of plugin dependancies

Returns:

a list of plugins such as "au.edu.swin.synergy.plugin.mod13.BWindowManager" or null if there are no dependancies

Overrides:

getDependancies in class BPlugin

doHide

protected void doHide()

This will be called to remove all of the Package Editor interface components, primarily when the user clicks on the close window button in the top right hand corner of the window.

doDisplay

protected void doDisplay()

This will be called to show all of the Package Editor interface components, primarily when the user selects the package editor from the Package menu or when the user creates a new package.

onBCommandEvent

public void onBCommandEvent(Object source,
                            BCommandEvent event)

Please complete the missing tags for onBCommandEvent

Parameters:

-

Returns:

Overrides:

onBCommandEvent in class BPlugin

Pre Condition:

Post Condition:

doDialect

public void doDialect()

Go through all classes and change dialect according to locale.

doCreateNewPackage

public BPackageModel doCreateNewPackage(String name,
                                        String metaModelFileName)

This will create a new package, with the specified name using the specified metamodel

Parameters:

String - name - the name of the package

String - metaModelFile - the file containing the metamodel

Returns:

reference to a new package, or null if there was an error

doSavePackage

public void doSavePackage()

doNewPackage

public void doNewPackage()

doEditPackage

public void doEditPackage()

doEditPackage

public void doEditPackage(String packageFileName)

Edits the package specified by the packageFileName

Parameters:

String - packageFileName - the file name of the package to edit

doAddPNode

public void doAddPNode(String metaNodeName,
                       BScalarPoint pt)

doAddTerminator

public void doAddTerminator(String name)