Process UI Toolkit API

filenet.vw.toolkit.utils
Class VWBaseLaunchableApplication

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--filenet.vw.toolkit.utils.VWBaseLaunchableApplication
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, IVWAppLauncher, IVWFrameInterface, IVWLaunchableApp, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public abstract class VWBaseLaunchableApplication
extends javax.swing.JFrame
implements IVWLaunchableApp, IVWAppLauncher

This class provides basic functionality for our applications.

Since:
IWWS1.00
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Inner classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Inner classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
protected  java.awt.Container m_parentContainer
           
protected  VWSessionInfo m_sessionInfo
           
protected  filenet.vw.toolkit.utils.VWSession m_vwSession
           
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, 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
VWBaseLaunchableApplication()
           
 
Method Summary
protected  void abort()
          Closes the window
protected  void childWindowClosed()
          Called when a child window closes.
protected  boolean destroy()
          Destroys any resources that have been allocated.
protected  boolean hasChildren()
          Returns true if we are managing child applications
 void init(VWSessionInfo sessionInfo)
          Initialize the application.
protected  boolean logoff()
          Closes all of the active applications and logs off the session
 void registerApplication(IVWLaunchableApp childApp)
          Allows this class to keep track of the child applications.
 void setSession(filenet.vw.toolkit.utils.VWSession vwSession)
          Sets the session reference
protected  void updatePosition(int nAppWidth, int nAppHeight)
          Resize and reposition the frame
protected  boolean updatePosition(java.lang.String positionKey, java.lang.String sizeKey)
          Resize and reposition the frame
 void windowClosing(java.awt.event.WindowEvent event)
          Invoked when a window is in the process of being closed.
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

m_vwSession

protected filenet.vw.toolkit.utils.VWSession m_vwSession

m_parentContainer

protected java.awt.Container m_parentContainer

m_sessionInfo

protected VWSessionInfo m_sessionInfo
Constructor Detail

VWBaseLaunchableApplication

public VWBaseLaunchableApplication()
Method Detail

setSession

public void setSession(filenet.vw.toolkit.utils.VWSession vwSession)
Sets the session reference
Parameters:
vwSession - this should be set if this app logged on.
Since:
IWWS1.00

init

public void init(VWSessionInfo sessionInfo)
Initialize the application.
Specified by:
init in interface IVWLaunchableApp
Parameters:
sessionInfo - the session information
Since:
IWWS1.00

windowClosing

public void windowClosing(java.awt.event.WindowEvent event)
Invoked when a window is in the process of being closed. The close operation can be overridden at this point.
Specified by:
windowClosing in interface IVWFrameInterface
Parameters:
event - The window closing event.

registerApplication

public void registerApplication(IVWLaunchableApp childApp)
Allows this class to keep track of the child applications.
Specified by:
registerApplication in interface IVWAppLauncher
Parameters:
childApp - the child application
Since:
IWWS1.00

abort

protected void abort()
Closes the window
Since:
IWWS1.00

childWindowClosed

protected void childWindowClosed()
Called when a child window closes.
Since:
IWWS1.00

destroy

protected boolean destroy()
Destroys any resources that have been allocated.
Returns:
false if the application should not be destroyed
Since:
IWWS1.00

hasChildren

protected boolean hasChildren()
Returns true if we are managing child applications
Returns:
true if we are managing child applications
Since:
IWWS1.00

logoff

protected boolean logoff()
Closes all of the active applications and logs off the session
Returns:
true if the session has been logged off
Since:
IWWS1.00

updatePosition

protected void updatePosition(int nAppWidth,
                              int nAppHeight)
Resize and reposition the frame
Parameters:
nAppWidth - the width of the frame
nAppHeight - the height of the frame
Since:
IWWS1.00

updatePosition

protected boolean updatePosition(java.lang.String positionKey,
                                 java.lang.String sizeKey)
Resize and reposition the frame
Parameters:
positionKey - the key for retrieving the position of the window
sizeKey - the key for retrieving the width and height of the window
Returns:
true if successful
Since:
IWWS1.00


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.