com.altair.hwm.toolkit.frame
Class HWMFrameView

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      com.jidesoft.docking.DefaultDockableHolder
                          com.jidesoft.action.DefaultDockableBarDockableHolder
                              com.jidesoft.templates.SampleFrame
                                  com.altair.hwm.guilibrary.AltairJFrame
                                      com.altair.hwm.toolkit.frame.HWMFrameView

All Implemented Interfaces:

HWMToolkitEventListener, com.jidesoft.action.DockableBarDockableHolder, com.jidesoft.action.DockableBarHolder, com.jidesoft.docking.DockableHolder, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

HWMAppFrameView, HWMDsgnFrameView

public abstract class HWMFrameView
extends AltairJFrame
implements HWMToolkitEventListener

Title: HWMFrameView

Description: This is the frame for the App and designer modes of EPIC/HWM application.

Company: Altair Engineering, Inc.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

HWMFrameView()
Constructor

Method Summary

void	AddMessageToDebugLog(java.lang.String strMessage) Add the specified message to the DEBUG MESSAGES log
void	AddMessageToMessageLog(java.lang.String strMessage) Add the specified message to the message log
void	BringToFront(boolean bFront) This gets the application's view to the front/back
void	ClearAll()
void	ClearDebugLog() Clear the message log window
void	ClearMessageLog() Clear the message log window
void	EventPerformed(HWMToolkitEvent eventToolkit) The toolkit event listener
HWMFrameModel	GetFrameModel() Get the FrameModel associated with this view
javax.swing.ImageIcon	getImageFullPath(java.lang.String imageName)
java.lang.String	getImageIconDir()
void	InitializeView(java.lang.String[] arrstrArgs) Initialize the UI
void	LogStatus(java.lang.String strMsg) This displays the given message in the status bar for the application
boolean	OnExit(java.lang.Object objSrc, boolean bSave, boolean bPromptUser) Callback for the File-Exit button.
void	OnStart() This is called if the application needs to something special.
void	ShowHelpForWorkflow() Displays help for the current workflow node Adding a title to the title bar i.e.
void	ShowMessageLog() Show the message log window
void	ShowView(boolean bShow) This shows/hides the application's view

Methods inherited from class com.jidesoft.templates.SampleFrame

load, load, main

Methods inherited from class com.jidesoft.action.DefaultDockableBarDockableHolder

dispose, getDockableBarManager, getJMenuBar, getLayoutPersistence

Methods inherited from class com.jidesoft.docking.DefaultDockableHolder

getDockingManager, setLayout

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.docking.DockableHolder

getDockingManager

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

HWMFrameView

public HWMFrameView()

Constructor

Method Detail

InitializeView

public void InitializeView(java.lang.String[] arrstrArgs)

Initialize the UI

Parameters:

arrstrArgs - The cmd line arguments for the app mode

ShowMessageLog

public void ShowMessageLog()

Show the message log window

AddMessageToMessageLog

public void AddMessageToMessageLog(java.lang.String strMessage)

Add the specified message to the message log

Parameters:

strMessage - The message to add

ClearMessageLog

public void ClearMessageLog()

Clear the message log window

AddMessageToDebugLog

public void AddMessageToDebugLog(java.lang.String strMessage)

Add the specified message to the DEBUG MESSAGES log

Parameters:

strMessage - The message to add

ClearDebugLog

public void ClearDebugLog()

Clear the message log window

GetFrameModel

public HWMFrameModel GetFrameModel()

Get the FrameModel associated with this view

OnStart

public void OnStart()
             throws java.lang.Exception

This is called if the application needs to something special. For example: In PM studio mopde, we need to check out license. The default implementation will not do anything.

Throws:

java.lang.Exception

OnExit

public boolean OnExit(java.lang.Object objSrc,
                      boolean bSave,
                      boolean bPromptUser)

Callback for the File-Exit button. Implemented by derived classes.

Parameters:

objSrc - The src for this call. If its the PM interaction class, then we need to send an ack which will tell if its quitting or not[In case the user selects to cancel the close operation. Else we need to send PmgrCloseInstance signal to it

bSave - If true the pmt/prj saved

bPromptUser - If true, the user is prompted whether he wants to save the project/process definition and the bSave flag is ignored.

Returns:

boolean If the user chose to cancel the operation - false is returned else true

LogStatus

public void LogStatus(java.lang.String strMsg)

This displays the given message in the status bar for the application

Parameters:

strMsg - The message to show. If null, then the default msg is shown

ShowView

public void ShowView(boolean bShow)

This shows/hides the application's view

Parameters:

bShow - If true, the view is shown else hidden

BringToFront

public void BringToFront(boolean bFront)

This gets the application's view to the front/back

Parameters:

bFront - If true, view is brought to front else back

ShowHelpForWorkflow

public void ShowHelpForWorkflow()

Displays help for the current workflow node Adding a title to the title bar i.e. "Help for Task 1"

EventPerformed

public void EventPerformed(HWMToolkitEvent eventToolkit)

The toolkit event listener

Specified by:

EventPerformed in interface HWMToolkitEventListener

Parameters:

eventToolkit - The event object for toolkit events

ClearAll

public void ClearAll()

getImageIconDir

public java.lang.String getImageIconDir()

getImageFullPath

public javax.swing.ImageIcon getImageFullPath(java.lang.String imageName)