com.altair.hwm.beans.hm
Class HMEvalTCLProc

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JButton
                      com.altair.hwm.beans.utils.HWMButton
                          com.altair.hwm.beans.hm.HMEvalTCLProc

All Implemented Interfaces:

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

public class HMEvalTCLProc
extends HWMButton
implements java.awt.event.ActionListener, java.io.Externalizable

Title: HMEvalTCLProc

Description: This bean allows the user to create a TCL procedure and execute it in HyperMesh

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_EVAL_TCL_PROC The id for the EvaluateTCLProc method
static java.lang.String	PROP_RESULT The name of the result property
static java.lang.String	PROP_SESSION_NAME The property name for the session name used to communicate with HyperMesh
static java.lang.String	PROP_TCL_PROCS The name of the TCL procedures property
static java.lang.String	VERSION The version ID for this component

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

BTNTYPE_APPLY, BTNTYPE_APPLY_AND_NEXT, BTNTYPE_CANCEL, BTNTYPE_GENERIC, BTNTYPE_NEXT, BTNTYPE_PREV

Fields inherited from class javax.swing.AbstractButton

BORDER_PAINTED_CHANGED_PROPERTY, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

HMEvalTCLProc()
Constructor

Method Summary

void	actionPerformed(java.awt.event.ActionEvent actionEvt) method of ActionListener interface.
void	EvaluateTCLProc() Creates and evaluates the TCL procedure defined
HMTCLProcInfo	GetProcedureInfo() Get the procedures info structure
java.lang.String	GetResult() Returns the result of executing the main procedure
java.lang.String	GetSessionName() Returns the session name for HM communication
void	readExternal(java.io.ObjectInput objInput) Loads the data for this bean
void	ReadProperties() Get the required properties from the datamodel and initialize self
void	SaveProperties() Save the required properties in the datamodel (so that they persist)
void	SetFrameWork(IHWMFrameWork hwmFrameWork) Overrides the IHWMControl's SetHWMFrameWork to create all the necessary hm bean's comm classes
void	SetProcedureInfo(HMTCLProcInfo hmProcInfo) Set the procedures info structure
void	SetSessionName(java.lang.String strSessionName) Sets the session name for HM communication
void	writeExternal(java.io.ObjectOutput objOutput) Saves the data for this bean

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

addHWMCmdEventListener, Disable, Enable, GetActionScript, GetBeanName, GetButtonType, GetFrameWork, GetImageAlignment, GetImageFilename, GetImageVisibilityStatus, getToolTipText, HWMEventCallback, OnAction, OnExit, Play, propertyChange, removeHWMCmdEventListener, Run, SetActionScript, SetBeanName, SetButtonType, SetButtonType, setEnabled, SetIconOnButton, SetImageAlignment, SetImageFilename, SetImageFilename, SetImageVisibilityStatus, setPreferredSize, setSize, setText, setToolTipText, setVisible, TCLCreateAdditionalEventProcs, TCLCreateExec, TCLCreateGetDataFromDataModel, TCLCreateMemberVariables, TCLCreateOnDataModelChanged, TCLCreateSetDataInDataModel, TCLCreateUI

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, doClick, doClick, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setUI, setVerticalAlignment, setVerticalTextPosition

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, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setTransferHandler, setVerifyInputWhenFocusTarget, 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, 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, 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, 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 property name for the session name used to communicate with HyperMesh

See Also:

Constant Field Values

PROP_TCL_PROCS

public static final java.lang.String PROP_TCL_PROCS

The name of the TCL procedures property

See Also:

Constant Field Values

PROP_RESULT

public static final java.lang.String PROP_RESULT

The name of the result property

See Also:

Constant Field Values

METH_EVAL_TCL_PROC

public static final int METH_EVAL_TCL_PROC

The id for the EvaluateTCLProc method

See Also:

Constant Field Values

Constructor Detail

HMEvalTCLProc

public HMEvalTCLProc()

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 HWMButton

Parameters:

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

actionPerformed

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

method of ActionListener interface. Invoked when this button is clicked

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class HWMButton

Parameters:

actionEvt - The ActionEvent object (See java docs for more help)

EvaluateTCLProc

public void EvaluateTCLProc()

Creates and evaluates the TCL procedure defined

SaveProperties

public void SaveProperties()

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

Overrides:

SaveProperties in class HWMButton

ReadProperties

public void ReadProperties()

Get the required properties from the datamodel and initialize self

Overrides:

ReadProperties in class HWMButton

writeExternal

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

Saves the data for this bean

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class HWMButton

Parameters:

objOutput - The ObjectOutput stream used to save data

Throws:

java.io.IOException

readExternal

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

Loads the data for this bean

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class HWMButton

Parameters:

objInput - The ObjectInput stream used to load data

Throws:

IOException, - ClassNotFoundException

java.io.IOException

java.lang.ClassNotFoundException

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

GetResult

public java.lang.String GetResult()

Returns the result of executing the main procedure

Returns:

String Result of executing the main procedure

SetProcedureInfo

public void SetProcedureInfo(HMTCLProcInfo hmProcInfo)

Set the procedures info structure

Parameters:

hmProcInfo - Structure that will contain the procedures defns as a map of procedure names to its definitions and a main proc name

GetProcedureInfo

public HMTCLProcInfo GetProcedureInfo()

Get the procedures info structure

Parameters:

HMTCLProcInfo - Structure that will contain the procedures defns as a map of procedure names to its definitions and a main proc name