|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.AbstractButton
javax.swing.JButton
com.altair.hwm.beans.utils.HWMButton
public class HWMButton
Title: HWMButton
Description: A button bean. Very similar to the JButton
Company: Altair Engineering, Inc.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
javax.swing.JComponent.AccessibleJComponent |
Field Summary | |
---|---|
static java.lang.String |
BTNTYPE_APPLY
|
static java.lang.String |
BTNTYPE_APPLY_AND_NEXT
|
static java.lang.String |
BTNTYPE_CANCEL
|
static java.lang.String |
BTNTYPE_GENERIC
The list of button types |
static java.lang.String |
BTNTYPE_NEXT
|
static java.lang.String |
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 | |
---|---|
HWMButton()
Creates a button with no set text or icon. |
|
HWMButton(javax.swing.Icon icon)
Creates a button with initial icon. |
|
HWMButton(java.lang.String strText)
Creates a button with initial text only. |
|
HWMButton(java.lang.String strText,
javax.swing.Icon icon)
Creates a button with initial text and an icon. |
Method Summary | |
---|---|
void |
actionPerformed(java.awt.event.ActionEvent event)
|
void |
addHWMCmdEventListener(HWMCmdEventListener hwmCmdEventListener)
Adds the listener to the vector of listeners |
void |
Disable()
Providing "Disable" method rather than overriding java's "disable" method because of the following reasons: 1> disable is deprecated 2> It does nothing visually for some controls like button 3> setEnabled calls enable/disable in the base class once it changes the UI. |
void |
Enable()
Providing "Enable" method rather than overriding java's "enable" method because of the following reasons: 1> enable is deprecated 2> It does nothing visually for some controls like button 3> setEnabled calls enable/disable in the base class once it changes the UI. |
HWMActionScript |
GetActionScript()
Get the Java Script |
java.lang.String |
GetBeanName()
Get the name of this bean (the name was assigned by the EPIC framework) |
java.lang.String |
GetButtonType()
Getter method for the button type |
IHWMFrameWork |
GetFrameWork()
Returns the interface using which a bean can communicate directly with the HWM application. |
java.lang.String |
GetImageAlignment()
|
java.lang.String |
GetImageFilename()
|
java.lang.String |
GetImageVisibilityStatus()
|
java.lang.String |
getToolTipText()
Returns the tooltip for the button. |
void |
HWMEventCallback(HWMEvent hwmEvent)
This method is called when the execution of a method succeeds |
void |
OnAction()
Callback when this button is pressed |
void |
OnExit()
Invoked by the HWM application when the bean is being destroyed. |
void |
Play()
The play method needs to execute the functionaliy. |
void |
propertyChange(java.beans.PropertyChangeEvent evt)
This method gets called when a bound property is changed. |
void |
readExternal(java.io.ObjectInput objInput)
Read the data back again and update the UI too |
void |
ReadProperties()
Get the required properties from the datamodel and initialize self |
void |
removeHWMCmdEventListener(HWMCmdEventListener hwmCmdEventListener)
Removes the listener from the vector of listeners |
void |
Run()
Invoked by the HWM application when all the beans are loaded and the application can run. |
void |
SaveProperties()
Save the required properties in the datamodel (so that they persist) |
void |
SetActionScript(HWMActionScript hwmScript)
Set the Java Script |
void |
SetBeanName(java.lang.String strBeanName)
Set the name of the bean |
void |
SetButtonType(java.lang.String strType)
Setter method for the button type |
void |
SetButtonType(java.lang.String strType,
boolean bUpdateDataModel)
Setter method for the button type |
void |
setEnabled(boolean bEnableState)
Enables the combo box so that items can be selected. |
void |
SetFrameWork(IHWMFrameWork hwmFrameWork)
This method is called by the HWM Application to set the interface with which a bean can communicate directly with the HWM application. |
void |
SetIconOnButton(java.lang.String fileName)
|
void |
SetImageAlignment(java.lang.String bImageAlignment)
|
void |
SetImageFilename(java.lang.String imageFilename)
|
void |
SetImageFilename(java.lang.String imageFilename,
boolean bUpdateDataModel)
|
void |
SetImageVisibilityStatus(java.lang.String bImageStatus)
|
void |
setPreferredSize(java.awt.Dimension dim)
Set the preferred size |
void |
setSize(int nWidth,
int nHeight)
|
void |
setText(java.lang.String strText)
Set the text on the button |
void |
setToolTipText(java.lang.String strToolTip)
Sets the tooltip for the button. |
void |
setVisible(boolean bVisibleState)
Makes the component visible or invisible. |
java.lang.String |
TCLCreateAdditionalEventProcs()
This method rerurns the TCL statement string for any additional procedures that is requred for the bean. |
java.lang.String |
TCLCreateExec()
This method returns the TCL statement string that performs the execution of script associated with the bean. |
java.lang.String |
TCLCreateGetDataFromDataModel()
This method returns the TCL statement string that gets the data in the datamodel. |
java.lang.String |
TCLCreateMemberVariables()
This method returns the TCL statement string for all the memeber variables referred by the bean in question. |
java.lang.String |
TCLCreateOnDataModelChanged()
This method returns the TCL statement string that implements the functionlaity requred to handle the "OnDataModelChanged" event. |
java.lang.String |
TCLCreateSetDataInDataModel()
This method returns the TCL statement string that sets the data in the datamodel. |
java.lang.String |
TCLCreateUI()
This method returns the TCL statement string for creating the GUI for the bean in question. |
void |
writeExternal(java.io.ObjectOutput objOutput)
Save the data |
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 |
---|
public static final java.lang.String BTNTYPE_GENERIC
public static final java.lang.String BTNTYPE_APPLY
public static final java.lang.String BTNTYPE_APPLY_AND_NEXT
public static final java.lang.String BTNTYPE_CANCEL
public static final java.lang.String BTNTYPE_NEXT
public static final java.lang.String BTNTYPE_PREV
Constructor Detail |
---|
public HWMButton()
public HWMButton(java.lang.String strText, javax.swing.Icon icon)
strText
- - the text of the button.icon
- - the Icon image to display on the button.public HWMButton(java.lang.String strText)
strText
- - the text of the button.public HWMButton(javax.swing.Icon icon)
icon
- - the Icon image to display on the button.Method Detail |
---|
public void SetIconOnButton(java.lang.String fileName)
public void propertyChange(java.beans.PropertyChangeEvent evt)
propertyChange
in interface java.beans.PropertyChangeListener
evt
- - A PropertyChangeEvent object describing the event source
and the property that has changed.public HWMActionScript GetActionScript()
public void SetActionScript(HWMActionScript hwmScript)
hwmScript
- The ActionScript instancepublic void SetButtonType(java.lang.String strType)
public void SetButtonType(java.lang.String strType, boolean bUpdateDataModel)
public java.lang.String GetButtonType()
public java.lang.String GetImageAlignment()
public void SetImageAlignment(java.lang.String bImageAlignment)
public java.lang.String GetImageVisibilityStatus()
public void SetImageVisibilityStatus(java.lang.String bImageStatus)
public java.lang.String GetImageFilename()
public void SetImageFilename(java.lang.String imageFilename)
public void SetImageFilename(java.lang.String imageFilename, boolean bUpdateDataModel)
public java.lang.String getToolTipText()
getToolTipText
in class javax.swing.JComponent
public void setToolTipText(java.lang.String strToolTip)
setToolTipText
in class javax.swing.JComponent
strToolTip
- Tooltip for the buttonpublic void setEnabled(boolean bEnableState)
setEnabled
in class javax.swing.AbstractButton
bEnableState
- - a boolean value, where true enables the component
and false disables itpublic void setVisible(boolean bVisibleState)
setVisible
in class javax.swing.JComponent
bVisibleState
- - true to make the component visiblepublic void Enable()
public void Disable()
public void setPreferredSize(java.awt.Dimension dim)
setPreferredSize
in class javax.swing.JComponent
public void setText(java.lang.String strText)
setText
in class javax.swing.AbstractButton
strText
- The text to set on the buttonpublic void OnAction() throws java.lang.Exception
java.lang.Exception
public void SaveProperties()
public void ReadProperties()
public void writeExternal(java.io.ObjectOutput objOutput) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput objInput) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
public void removeHWMCmdEventListener(HWMCmdEventListener hwmCmdEventListener)
hwmCmdEventListener
- The listener object to removepublic void addHWMCmdEventListener(HWMCmdEventListener hwmCmdEventListener)
hwmCmdEventListener
- The listener object to addpublic void HWMEventCallback(HWMEvent hwmEvent)
HWMEventCallback
in interface HWMEventListener
hwmEvent
- The event object that contains the event informationpublic void SetFrameWork(IHWMFrameWork hwmFrameWork)
SetFrameWork
in interface IHWMControl
hwmFrameWork
- The interface with which a bean can communicate with
the HWM application.public IHWMFrameWork GetFrameWork()
public void SetBeanName(java.lang.String strBeanName)
SetBeanName
in interface IHWMControl
strBeanName
- The name of this bean as the framework knows it to be.
Will be useful, if the bean chooses to scope its data in the datamodel -
especially if multiple instances of the same bean appear in the processpublic java.lang.String GetBeanName()
public void OnExit()
OnExit
in interface IHWMControl
public void Run()
Run
in interface IHWMControl
public void Play() throws java.lang.Exception
Play
in interface IHWMControl
java.lang.Exception
public java.lang.String TCLCreateUI()
TCLCreateUI
in interface ITCLCodeCreator
public java.lang.String TCLCreateMemberVariables()
TCLCreateMemberVariables
in interface ITCLCodeCreator
public java.lang.String TCLCreateSetDataInDataModel()
TCLCreateSetDataInDataModel
in interface ITCLCodeCreator
public java.lang.String TCLCreateGetDataFromDataModel()
TCLCreateGetDataFromDataModel
in interface ITCLCodeCreator
public java.lang.String TCLCreateExec()
TCLCreateExec
in interface ITCLCodeCreator
public java.lang.String TCLCreateAdditionalEventProcs()
TCLCreateAdditionalEventProcs
in interface ITCLCodeCreator
public java.lang.String TCLCreateOnDataModelChanged()
TCLCreateOnDataModelChanged
in interface ITCLCodeCreator
public void setSize(int nWidth, int nHeight)
setSize
in class java.awt.Component
public void actionPerformed(java.awt.event.ActionEvent event)
actionPerformed
in interface java.awt.event.ActionListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |