com.altair.hwm.interfaces
Interface IHWMFrame

All Known Implementing Classes:

HWMAppFrameView, HWMDsgnFrameView

public interface IHWMFrame

Title: IHWMFrame

Description: The frame interface allows clients to call New, Open, Close, Save, Exit and SetDefaultTemplate. These functions are implemented as stubs for Studio mode.

Company: Altair Engineering, Inc.

Method Summary

void	AddMessageToDebugLog(java.lang.String strMessage) Add the specified message to the debug message log
void	AddMessageToMessageLog(java.lang.String strMessage) Add the specified message to the message log
void	CloseInstance(boolean bSave, boolean bAskUser) Close the currently active process instance.
void	CloseTemplate() Close the template //This is only used for ProcessManager
void	CloseTemplate(boolean bSave, boolean bPromptUser) Close the template
void	CopyInstance() Create a new instance as a copy of an existing instance
void	CreateInstance() Create a new process instance.
void	CreateInstance(java.lang.String strProjectFile) Create a new process instance in the given location.
void	Exit() Exit the application.
java.awt.Component	GetMainFrame() Get the main component (Frame or Window) for this application
void	OpenInstance() Open an existing process instance.
void	OpenInstance(java.lang.String strProjectFile) Open the specified process instance.
void	SaveAsInstance(java.lang.String strNewPMInstance, boolean bShowNewOpenDialog) Save the current active instance as a new one.
void	SaveInstance() Save an existing process instance.
void	SetDefaultTemplate(java.lang.String strNewPMTemplate, boolean bShowNewOpenDialog) Set the default template as strNewPMTemplate.
void	ShowMessageLog() Show the message log window

Method Detail

CreateInstance

void CreateInstance()
                    throws java.lang.Exception

Create a new process instance. NOTE: When the template is of "todo" type i.e. does not require saving of instance data, this call is ignored

Throws:

java.lang.Exception

CreateInstance

void CreateInstance(java.lang.String strProjectFile)
                    throws java.lang.Exception

Create a new process instance in the given location. If a file already exists, it will be overwritten NOTE: When the template is of "todo" type i.e. does not require saving of instance data, this call is ignored

Parameters:

strProjectFile - The project file name

Throws:

java.lang.Exception

OpenInstance

void OpenInstance()
                  throws java.lang.Exception

Open an existing process instance. NOTE: When the template is of "todo" type i.e. does not require saving of instance data, this call is ignored

Throws:

java.lang.Exception

OpenInstance

void OpenInstance(java.lang.String strProjectFile)
                  throws java.lang.Exception

Open the specified process instance.

Parameters:

strProjectFile - The full path to the instance file to open

Throws:

java.lang.Exception

SaveInstance

void SaveInstance()
                  throws java.lang.Exception

Save an existing process instance. NOTE: When the template is of "todo" type i.e. does not require saving of instance data, this call is ignored

Throws:

java.lang.Exception

CloseInstance

void CloseInstance(boolean bSave,
                   boolean bAskUser)
                   throws java.lang.Exception

Close the currently active process instance. NOTE: When the template is of "todo" type i.e. does not require saving of instance data, this call is closed

Throws:

java.lang.Exception

CloseTemplate

void CloseTemplate()
                   throws java.lang.Exception

Close the template //This is only used for ProcessManager

Throws:

java.lang.Exception

CloseTemplate

void CloseTemplate(boolean bSave,
                   boolean bPromptUser)
                   throws java.lang.Exception

Close the template

Parameters:

bSave - If true, the prj is saved. It is ignored when the user needs to be prompted

bPromptUser - Prompt the user with a save dialog

Throws:

java.lang.Exception

Exit

void Exit()
          throws java.lang.Exception

Exit the application.

Throws:

java.lang.Exception

SetDefaultTemplate

void SetDefaultTemplate(java.lang.String strNewPMTemplate,
                        boolean bShowNewOpenDialog)
                        throws java.lang.Exception

Set the default template as strNewPMTemplate.

Parameters:

strNewPMTemplate - The new process manager template to use.

bShowNewOpenDialog - If true, the dialog to create a project or open a project is shown

Throws:

java.lang.Exception

GetMainFrame

java.awt.Component GetMainFrame()

Get the main component (Frame or Window) for this application

Returns:

Component main component (Frame or Window) for this application

ShowMessageLog

void ShowMessageLog()

Show the message log window

AddMessageToMessageLog

void AddMessageToMessageLog(java.lang.String strMessage)

Add the specified message to the message log

Parameters:

strMessage - The message to add

AddMessageToDebugLog

void AddMessageToDebugLog(java.lang.String strMessage)

Add the specified message to the debug message log

Parameters:

strMessage - The message to add

SaveAsInstance

void SaveAsInstance(java.lang.String strNewPMInstance,
                    boolean bShowNewOpenDialog)
                    throws java.lang.Exception

Save the current active instance as a new one.

Throws:

java.lang.Exception

CopyInstance

void CopyInstance()

Create a new instance as a copy of an existing instance