com.altair.hwm.beans.hm
Class HMEvalTCL

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.altair.hwm.beans.utils.HWMBasePanel
                      com.altair.hwm.beans.hm.HMEvalTCL

All Implemented Interfaces:

HWMEventListener, IHWMControl, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Externalizable, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class HMEvalTCL
extends HWMBasePanel
implements java.io.Externalizable, java.awt.event.ActionListener, java.beans.PropertyChangeListener

Title: HMEvalTCL

Description: This bean allows a TCL script to be specified and evaluated

Company: Altair Engineering, Inc.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	METH_EVALTCL Method ID for which HWMCmdEvent will be fired
static java.lang.String	PROP_SESSION_NAME The session name property name
static java.lang.String	PROP_TCL_FILENAME The TCL file property name
static java.lang.String	VERSION The version ID for this component

Fields inherited from class com.altair.hwm.beans.utils.HWMBasePanel

BASE_VERSION

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

HMEvalTCL()
Constructor

Method Summary

void	actionPerformed(java.awt.event.ActionEvent actionEvt) Handler for the event fired when the "Evaluate" btn is clicked
void	Disable() Disables the UI
void	Enable() Enables the UI
void	EvalTCL() Sends a eval tcl script command to HM vis HWMComm layer
java.lang.String	GetBrosweBtnLabel() Sets the name for the label "Browse" btn
java.lang.String	GetEvalBtnLabel() Sets the name for the label "Evaluate" btn
java.lang.String	GetScriptFileName() Returns the TCL script file name to be evaluated by HM
java.lang.String	GetScriptNameLabel() Sets the name for the label "Script Name" display field
java.lang.String	GetSessionName() Returns the session name for HM communication
void	propertyChange(java.beans.PropertyChangeEvent propChangeEvt) This is called when the file browser has a file selected for evaluation
void	readExternal(java.io.ObjectInput objInput) Loads the version and then calls the appropriate read function for the version
void	ReadProperties() Get the required properties from the datamodel and initialize self
void	ReadVersion1_0(java.io.ObjectInput objInput) Load the properties that were saved for version 1.0
void	SaveProperties() Save the required properties in the datamodel (so that they persist)
void	SetBrosweBtnLabel(java.lang.String strLabelName) Sets the name for the label "Browse" btn
void	setEnabled(boolean bEnable) Enables/disable the UI
void	SetEvalBtnLabel(java.lang.String strLabelName) Sets the name for the label "Evaluate" btn
void	SetFrameWork(IHWMFrameWork hwmFrameWork) Overrides the IHWMControl's SetHWMFrameWork to create all the necessary hm bean's comm classes
void	SetScriptFileName(java.lang.String strFName) Sets the TCL script file name to be evaluated by HM
void	SetScriptNameLabel(java.lang.String strLabelName) Sets the name for the label "Script Name" display field
void	SetSessionName(java.lang.String strSessionName) Sets the session name for HM communication
void	writeExternal(java.io.ObjectOutput objOutput) Save the persistent properties

Methods inherited from class com.altair.hwm.beans.utils.HWMBasePanel

addHWMCmdEventListener, GetBeanName, GetFrameWork, HWMEventCallback, OnExit, Play, removeHWMCmdEventListener, Run, setBackground, SetBeanName, setFont, setForeground

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

The version ID for this component

See Also:

Constant Field Values

PROP_SESSION_NAME

public static final java.lang.String PROP_SESSION_NAME

The session name property name

See Also:

Constant Field Values

PROP_TCL_FILENAME

public static final java.lang.String PROP_TCL_FILENAME

The TCL file property name

See Also:

Constant Field Values

METH_EVALTCL

public static final int METH_EVALTCL

Method ID for which HWMCmdEvent will be fired

See Also:

Constant Field Values

Constructor Detail

HMEvalTCL

public HMEvalTCL()

Constructor

Method Detail

SetFrameWork

public void SetFrameWork(IHWMFrameWork hwmFrameWork)

Overrides the IHWMControl's SetHWMFrameWork to create all the necessary hm bean's comm classes

Specified by:

SetFrameWork in interface IHWMControl

Overrides:

SetFrameWork in class HWMBasePanel

Parameters:

hwmFrameWork - The interface which allows the communication between beans and the container frame

SaveProperties

public void SaveProperties()

Save the required properties in the datamodel (so that they persist)

Overrides:

SaveProperties in class HWMBasePanel

ReadProperties

public void ReadProperties()

Get the required properties from the datamodel and initialize self

Overrides:

ReadProperties in class HWMBasePanel

writeExternal

public void writeExternal(java.io.ObjectOutput objOutput)
                   throws java.io.IOException

Save the persistent properties

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class HWMBasePanel

Parameters:

objOutput - The stream to which data will be written

Throws:

java.io.IOException

ReadVersion1_0

public void ReadVersion1_0(java.io.ObjectInput objInput)
                    throws java.lang.ClassNotFoundException,
                           java.io.IOException

Load the properties that were saved for version 1.0

Parameters:

objInput - The stream from which data will be read

Throws:

IOException, - ClassNotFoundException

java.lang.ClassNotFoundException

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput objInput)
                  throws java.lang.ClassNotFoundException,
                         java.io.IOException

Loads the version and then calls the appropriate read function for the version

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class HWMBasePanel

Parameters:

ObjInput - The stream from which data will be read

Throws:

IOException, - ClassNotFoundException

java.lang.ClassNotFoundException

java.io.IOException

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent propChangeEvt)

This is called when the file browser has a file selected for evaluation

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

propChangeEvt - See PropertyChangeListener in Java docs for help

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent actionEvt)

Handler for the event fired when the "Evaluate" btn is clicked

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

actionEvt - The action event object (See ActionListener in Java docs for help)

EvalTCL

public void EvalTCL()

Sends a eval tcl script command to HM vis HWMComm layer

SetSessionName

public void SetSessionName(java.lang.String strSessionName)

Sets the session name for HM communication

Parameters:

strSessionName - The session name for HM Comm

GetSessionName

public java.lang.String GetSessionName()

Returns the session name for HM communication

Returns:

String The session name for HM Comm

SetScriptFileName

public void SetScriptFileName(java.lang.String strFName)

Sets the TCL script file name to be evaluated by HM

Parameters:

strFName - The TCL script file name to be evaluated by HM

GetScriptFileName

public java.lang.String GetScriptFileName()

Returns the TCL script file name to be evaluated by HM

Returns:

String The TCL script file name to be evaluated by HM

SetScriptNameLabel

public void SetScriptNameLabel(java.lang.String strLabelName)

Sets the name for the label "Script Name" display field

Parameters:

strLabelName - Name for the label "Script Name" display field

GetScriptNameLabel

public java.lang.String GetScriptNameLabel()

Sets the name for the label "Script Name" display field

Returns:

String Name for label for "Script Name" display field

SetBrosweBtnLabel

public void SetBrosweBtnLabel(java.lang.String strLabelName)

Sets the name for the label "Browse" btn

Parameters:

strLabelName - Name for the label "Browse" btn

GetBrosweBtnLabel

public java.lang.String GetBrosweBtnLabel()

Sets the name for the label "Browse" btn

Returns:

String Name for label for "Browse" btn

SetEvalBtnLabel

public void SetEvalBtnLabel(java.lang.String strLabelName)

Sets the name for the label "Evaluate" btn

Parameters:

String - Name for the label "Evaluate" btn

GetEvalBtnLabel

public java.lang.String GetEvalBtnLabel()

Sets the name for the label "Evaluate" btn

Returns:

String Name for label for "Evaluate" btn

Enable

public void Enable()

Enables the UI

Overrides:

Enable in class HWMBasePanel

Disable

public void Disable()

Disables the UI

Overrides:

Disable in class HWMBasePanel

setEnabled

public void setEnabled(boolean bEnable)

Enables/disable the UI

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

bEnable - If true the UI is enabled else disabled