com.altair.hwm.toolkit.event
Class HWMToolkitEvent

java.lang.Object
  java.util.EventObject
      com.altair.hwm.toolkit.event.HWMToolkitEvent

All Implemented Interfaces:

java.io.Serializable

public class HWMToolkitEvent
extends java.util.EventObject

Title: HWMToolkitEvent

Description: A generic event object that contains information about what generated the event, the event type, and arbitrary information about the event

Company: Altair Engineering, Inc.

See Also:

Serialized Form

Field Summary

static int	BEAN_DELETED Fired when a bean is deleted Original src - HWMPage Data - HWMBeanInstance
static int	BEAN_SELECTED Fired when a bean is selected Original src - HWMPage Data - HWMBeanWrapper
static int	BEAN_SHOWPOPUP Fired when user clicks the right mouse btn on the selected bean Original src - HWMBeanWrapper Data - MouseEvent
static int	BINDING_ADDED
static int	BINDING_DELETED
static int	CONTROLS_ENABLED Fired when the controls are enabled/disabled Original src = HWMDsgnPageMgrModel Data - Boolean.
static int	IHWMFRAMEWORK_APPENDTITLE Fired when a suffix needs to be attached to the title Original src = IHWMFrameWork Data - String - The suffix to append to the title
static int	IHWMFRAMEWORK_BRINGFRONT Fired when the app should be sent to back or brought to front Original src = IHWMFrameWork or any source Data - Boolean If true, the view is brought to front else sent to back
static int	IHWMFRAMEWORK_CLOSE Fired when the instance should be closed without saving Original src = IHWMFrameWork Data - NONE
static int	IHWMFRAMEWORK_EXIT Fired when the app should exit without saving Original src = IHWMFrameWork or any source Data - null
static int	IHWMFRAMEWORK_LOGSTATUS Fired when a status should be logged Original src = IHWMFrameWork or any source Data - String - The message to be logged.
static int	IHWMFRAMEWORK_NEWPROJECT Fired when a new project needs to be created.
static int	IHWMFRAMEWORK_OPENPROJECT Fired when a project needs to be opened.
static int	IHWMFRAMEWORK_SAVE Fired when the current project needs to be saved.
static int	IHWMFRAMEWORK_SAVEANDCLOSE Fired when the instance should be saved and closed.
static int	IHWMFRAMEWORK_SAVEANDEXIT Fired when the app should exit with saving Original src = IHWMFrameWork or any source Data - Boolean.
static int	IHWMFRAMEWORK_SHOWVIEW Fired when the app should be shown/hidden Original src = IHWMFrameWork or any source Data - Boolean If true, the view is shown else hidden
static int	PAGE_ADDED Fired when a page is added Original src - HWMPageMgrModel Data - HWMPage
static int	PAGE_DELETED Fired when a page is added Original src - HWMPageMgrModel Data - HWMPage
static int	PAGE_SELECTED Fired when a page is selected Original src - HWMPageMgrView Data - HWMPage
static int	SHOW_HELP Fired when a task with a help is selected.
static int	WORKFLOW_NODE_ADDED Fired when a node is added to the workflow Original src = HWMWorkflowPopupMenuMgr Data - HWMWorkflowNode that was aded
static int	WORKFLOW_NODE_DELETED Fired when a node is removed from the workflow Original src = HWMWorkflowPopupMenuMgr Data - HWMWorkflowNode that was remove
static int	WORKFLOW_NODE_MOVED Fired when a node is moved within the workflow Original src = HWMWorkflowPopupMenuMgr Data - HWMWorkflowNode that was moved
static int	WORKFLOW_REPLAY_COMPLETED Fired when replay mode ends Original src = HWMWorkflowModel Data - NULL
static int	WORKFLOW_SELECTED
static int	WORKFLOW_UPDATED Fired by the workflow tree when a node is updated and the property panel needs to update its values Original src = JTree Data = HWMWorkflowNode - The workflow node being updated

Constructor Summary

HWMToolkitEvent(java.lang.Object objSource, int nEventID, java.lang.Object objEventData)
Constructor

HWMToolkitEvent(java.lang.Object objSource, java.lang.Object objOrgSrc, int nEventID, java.lang.Object objEventData)
Constructor

Method Summary

java.lang.Object	GetEventData() Returns the eventData if any
int	GetEventID() Returns the type of the event
java.lang.Object	GetOriginalSrc(java.lang.Object objOrgSrc) Returns the propogation object
void	SetOriginalSrc(java.lang.Object objOrgSrc) Sets the original source object
void	SetSource(java.lang.Object objSrc) Set the src for the event

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BEAN_SELECTED

public static final int BEAN_SELECTED

Fired when a bean is selected Original src - HWMPage Data - HWMBeanWrapper

See Also:

Constant Field Values

PAGE_SELECTED

public static final int PAGE_SELECTED

Fired when a page is selected Original src - HWMPageMgrView Data - HWMPage

See Also:

Constant Field Values

PAGE_ADDED

public static final int PAGE_ADDED

Fired when a page is added Original src - HWMPageMgrModel Data - HWMPage

See Also:

Constant Field Values

PAGE_DELETED

public static final int PAGE_DELETED

Fired when a page is added Original src - HWMPageMgrModel Data - HWMPage

See Also:

Constant Field Values

WORKFLOW_SELECTED

public static final int WORKFLOW_SELECTED

See Also:

Constant Field Values

BINDING_ADDED

public static final int BINDING_ADDED

See Also:

Constant Field Values

BINDING_DELETED

public static final int BINDING_DELETED

See Also:

Constant Field Values

BEAN_SHOWPOPUP

public static final int BEAN_SHOWPOPUP

Fired when user clicks the right mouse btn on the selected bean Original src - HWMBeanWrapper Data - MouseEvent

See Also:

Constant Field Values

BEAN_DELETED

public static final int BEAN_DELETED

Fired when a bean is deleted Original src - HWMPage Data - HWMBeanInstance

See Also:

Constant Field Values

SHOW_HELP

public static final int SHOW_HELP

Fired when a task with a help is selected. Original src = HWMWorkflowView Data - HWMWorkflowNode the node to show help for

See Also:

Constant Field Values

WORKFLOW_NODE_ADDED

public static final int WORKFLOW_NODE_ADDED

Fired when a node is added to the workflow Original src = HWMWorkflowPopupMenuMgr Data - HWMWorkflowNode that was aded

See Also:

Constant Field Values

WORKFLOW_NODE_DELETED

public static final int WORKFLOW_NODE_DELETED

Fired when a node is removed from the workflow Original src = HWMWorkflowPopupMenuMgr Data - HWMWorkflowNode that was remove

See Also:

Constant Field Values

WORKFLOW_NODE_MOVED

public static final int WORKFLOW_NODE_MOVED

Fired when a node is moved within the workflow Original src = HWMWorkflowPopupMenuMgr Data - HWMWorkflowNode that was moved

See Also:

Constant Field Values

IHWMFRAMEWORK_SHOWVIEW

public static final int IHWMFRAMEWORK_SHOWVIEW

Fired when the app should be shown/hidden Original src = IHWMFrameWork or any source Data - Boolean If true, the view is shown else hidden

See Also:

Constant Field Values

IHWMFRAMEWORK_BRINGFRONT

public static final int IHWMFRAMEWORK_BRINGFRONT

Fired when the app should be sent to back or brought to front Original src = IHWMFrameWork or any source Data - Boolean If true, the view is brought to front else sent to back

See Also:

Constant Field Values

IHWMFRAMEWORK_LOGSTATUS

public static final int IHWMFRAMEWORK_LOGSTATUS

Fired when a status should be logged Original src = IHWMFrameWork or any source Data - String - The message to be logged. Can be null

See Also:

Constant Field Values

IHWMFRAMEWORK_EXIT

public static final int IHWMFRAMEWORK_EXIT

Fired when the app should exit without saving Original src = IHWMFrameWork or any source Data - null

See Also:

Constant Field Values

IHWMFRAMEWORK_SAVEANDEXIT

public static final int IHWMFRAMEWORK_SAVEANDEXIT

Fired when the app should exit with saving Original src = IHWMFrameWork or any source Data - Boolean. If true, the user should be prompted whether he/she wants to save else save without prompting

See Also:

Constant Field Values

CONTROLS_ENABLED

public static final int CONTROLS_ENABLED

Fired when the controls are enabled/disabled Original src = HWMDsgnPageMgrModel Data - Boolean. True if enabled, False is disabled

See Also:

Constant Field Values

IHWMFRAMEWORK_CLOSE

public static final int IHWMFRAMEWORK_CLOSE

Fired when the instance should be closed without saving Original src = IHWMFrameWork Data - NONE

See Also:

Constant Field Values

IHWMFRAMEWORK_SAVEANDCLOSE

public static final int IHWMFRAMEWORK_SAVEANDCLOSE

Fired when the instance should be saved and closed. The flag indicates if the suer should be prompted Original src = IHWMFrameWork Data - Boolean - The user should be prompted or not

See Also:

Constant Field Values

IHWMFRAMEWORK_APPENDTITLE

public static final int IHWMFRAMEWORK_APPENDTITLE

Fired when a suffix needs to be attached to the title Original src = IHWMFrameWork Data - String - The suffix to append to the title

See Also:

Constant Field Values

IHWMFRAMEWORK_NEWPROJECT

public static final int IHWMFRAMEWORK_NEWPROJECT

Fired when a new project needs to be created. A file browser must be thrown to as the user to select the project file to create, and create a new instance Original src = IHWMFrameWork, HWPMInteraction

See Also:

Constant Field Values

IHWMFRAMEWORK_OPENPROJECT

public static final int IHWMFRAMEWORK_OPENPROJECT

Fired when a project needs to be opened. A file browser must be thrown to as the user to select the project file, and open it Original src = IHWMFrameWork, HWPMInteraction

See Also:

Constant Field Values

IHWMFRAMEWORK_SAVE

public static final int IHWMFRAMEWORK_SAVE

Fired when the current project needs to be saved. Original src = IHWMFrameWork, HWPMInteraction

See Also:

Constant Field Values

WORKFLOW_UPDATED

public static final int WORKFLOW_UPDATED

Fired by the workflow tree when a node is updated and the property panel needs to update its values Original src = JTree Data = HWMWorkflowNode - The workflow node being updated

See Also:

Constant Field Values

WORKFLOW_REPLAY_COMPLETED

public static final int WORKFLOW_REPLAY_COMPLETED

Fired when replay mode ends Original src = HWMWorkflowModel Data - NULL

See Also:

Constant Field Values

Constructor Detail

HWMToolkitEvent

public HWMToolkitEvent(java.lang.Object objSource,
                       int nEventID,
                       java.lang.Object objEventData)

Constructor

Parameters:

objSource - The object that fired the event

nEventID - The type of event

objEventData - Extra information for the listening object

HWMToolkitEvent

public HWMToolkitEvent(java.lang.Object objSource,
                       java.lang.Object objOrgSrc,
                       int nEventID,
                       java.lang.Object objEventData)

Constructor

Parameters:

objSource - The object that fired the event

objOrgSrc - The object that originally fired the event. Can be used when events are propogated

nEventID - The type of event

objEventData - Extra information for the listening object

Method Detail

SetSource

public void SetSource(java.lang.Object objSrc)

Set the src for the event

Parameters:

objSrc - The object that fired the event

GetEventID

public int GetEventID()

Returns the type of the event

Returns:

int The event type. A constant defined in this class.

GetEventData

public java.lang.Object GetEventData()

Returns the eventData if any

Returns:

Object The eventData, null if no extra data was included

SetOriginalSrc

public void SetOriginalSrc(java.lang.Object objOrgSrc)

Sets the original source object

Parameters:

objOrgSrc - The original src of for the event

GetOriginalSrc

public java.lang.Object GetOriginalSrc(java.lang.Object objOrgSrc)

Returns the propogation object

Returns:

Object The original src of for the event