com.altair.hwm.beans.hm
Class HMSelect

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.HMSelect

All Implemented Interfaces:

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

public class HMSelect
extends HWMBasePanel
implements java.awt.event.ActionListener, java.io.Externalizable

Title: HMSelect

Description: This bean allows the user to select a given entity 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 java.lang.String	ENTITY_ELEMENTS The type of entity to select is "elements"
static java.lang.String	ENTITY_NODES The type of entity to select is "nodes"
static java.lang.String	ENTITY_SURFACES The type of entity to select is "surfaces"
static int	METH_SELECT Methods ids that fire HWMCmdEvent
static java.lang.String	PROP_ENTITY_TYPE The name for the entity type property
static java.lang.String	PROP_RESULT_STR The name for the result (all selected entities represented as a single line of text) property
static java.lang.String	PROP_RESULT_VECT The name for the result (as a vector of Strings with each entity selected represented as a string ) property
static java.lang.String	PROP_SELECTION_SCOPE The name for the selection scope property
static java.lang.String	PROP_SELECTION_TYPE The name for the selection type property
static java.lang.String	PROP_SESSION_NAME The property name for the session name used to communicate with HyperMesh
static java.lang.String	SELECT_ALL The scope for selection is "all".
static java.lang.String	SELECT_DISPLAYED The scope for selection is "displayed".
static java.lang.String	SELECT_USER The scope for selection is "selected".
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

HMSelect()
Constructor

Method Summary

void	actionPerformed(java.awt.event.ActionEvent actionEvt) Handler for the event fired when the "Select" btn is clicked or when the entity type is selected in the combo box
void	Disable() Disables the UI
void	Enable() Enables the UI
java.lang.String	GetEntityLabel() Gets the label for "Entity type" combo box
java.lang.String	GetEntityType() Gets the selected entity type.
java.util.Vector	GetParsedResult() Returns the parsed result
java.lang.String	GetResult() Returns the result received from Hypermesh as is
java.lang.String	GetSelectBtnLabel() Gets the label for the select button
java.lang.String	GetSelectionLabel() Gets the the label "Selection type" combo box
java.lang.String	GetSelectionType() Gets the selection type.
java.lang.String	GetSessionName() Returns the session name for HM communication
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	SaveProperties() Save the required properties in the datamodel (so that they persist)
void	Select() Sends a command to scale and then queries for selected items
void	setEnabled(boolean bEnable) Enables/disable the UI
void	SetEntityLabel(java.lang.String strLabelName) Sets the label for "Entity type" combo box
void	SetEntityType(java.lang.String strEntityName) Sets entity type.
void	SetFrameWork(IHWMFrameWork hwmFrameWork) Overrides the IHWMControl's SetHWMFrameWork to create all the necessary hm bean's comm classes
void	SetSelectBtnLabel(java.lang.String strLabelName) Sets the label for the select button
void	SetSelectionLabel(java.lang.String strLabelName) Sets the the label "Selection type" combo box
void	SetSelectionType(java.lang.String strScope) Sets the selection type.
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 property name for the session name used to communicate with HyperMesh

See Also:

Constant Field Values

PROP_SELECTION_TYPE

public static final java.lang.String PROP_SELECTION_TYPE

The name for the selection type property

See Also:

Constant Field Values

PROP_SELECTION_SCOPE

public static final java.lang.String PROP_SELECTION_SCOPE

The name for the selection scope property

See Also:

Constant Field Values

PROP_ENTITY_TYPE

public static final java.lang.String PROP_ENTITY_TYPE

The name for the entity type property

See Also:

Constant Field Values

PROP_RESULT_STR

public static final java.lang.String PROP_RESULT_STR

The name for the result (all selected entities represented as a single line of text) property

See Also:

Constant Field Values

PROP_RESULT_VECT

public static final java.lang.String PROP_RESULT_VECT

The name for the result (as a vector of Strings with each entity selected represented as a string ) property

See Also:

Constant Field Values

METH_SELECT

public static final int METH_SELECT

Methods ids that fire HWMCmdEvent

See Also:

Constant Field Values

SELECT_ALL

public static final java.lang.String SELECT_ALL

The scope for selection is "all". i.e. All surfaces/components/elements will be selected

See Also:

Constant Field Values

SELECT_DISPLAYED

public static final java.lang.String SELECT_DISPLAYED

The scope for selection is "displayed". i.e. All displayed surfaces/ components/elements will be selected

See Also:

Constant Field Values

SELECT_USER

public static final java.lang.String SELECT_USER

The scope for selection is "selected". i.e. The user will select the surfaces/elements/components

See Also:

Constant Field Values

ENTITY_SURFACES

public static final java.lang.String ENTITY_SURFACES

The type of entity to select is "surfaces"

See Also:

Constant Field Values

ENTITY_ELEMENTS

public static final java.lang.String ENTITY_ELEMENTS

The type of entity to select is "elements"

See Also:

Constant Field Values

ENTITY_NODES

public static final java.lang.String ENTITY_NODES

The type of entity to select is "nodes"

See Also:

Constant Field Values

Constructor Detail

HMSelect

public HMSelect()

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

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

Select

public void Select()

Sends a command to scale and then queries for selected items

actionPerformed

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

Handler for the event fired when the "Select" btn is clicked or when the entity type is selected in the combo box

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

actionEvt - The action event object(See java docs for help)

GetParsedResult

public java.util.Vector GetParsedResult()

Returns the parsed result

Returns:

Vector The vector has the tokens received from Hypermesh

GetResult

public java.lang.String GetResult()

Returns the result received from Hypermesh as is

Returns:

String The result received from Hypermesh

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

SetEntityType

public void SetEntityType(java.lang.String strEntityName)

Sets entity type. Can be ENTITY_SURFACES, ENTITY_NODES or ENTITY_ELEMENTS

Parameters:

strEntityName - The entity type to select

GetEntityType

public java.lang.String GetEntityType()

Gets the selected entity type. Can be ENTITY_SURFACES, ENTITY_NODES or ENTITY_ELEMENTS

Returns:

String Entity type to select

SetSelectionType

public void SetSelectionType(java.lang.String strScope)

Sets the selection type. Can be SELECT_ALL, SELECT_DISPLAYED or SELECT_USER

Parameters:

strScope - selection type

GetSelectionType

public java.lang.String GetSelectionType()

Gets the selection type. Can be SELECT_ALL, SELECT_DISPLAYED or SELECT_USER

Returns:

String selection type

SetEntityLabel

public void SetEntityLabel(java.lang.String strLabelName)

Sets the label for "Entity type" combo box

Parameters:

strLabelName - Label for "Entity type" combo box

GetEntityLabel

public java.lang.String GetEntityLabel()

Gets the label for "Entity type" combo box

Returns:

String Label for "Entity type" combo box

SetSelectionLabel

public void SetSelectionLabel(java.lang.String strLabelName)

Sets the the label "Selection type" combo box

Parameters:

strLabelName - Label "Selection type" combo box

GetSelectionLabel

public java.lang.String GetSelectionLabel()

Gets the the label "Selection type" combo box

Returns:

String label for "Selection type" combo box

SetSelectBtnLabel

public void SetSelectBtnLabel(java.lang.String strLabelName)

Sets the label for the select button

Parameters:

strLabelName - Label for the select button

GetSelectBtnLabel

public java.lang.String GetSelectBtnLabel()

Gets the label for the select button

Returns:

String Label for the select button

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