com.ibm.tivoli.maximo.skd.applet

Class SKDViewerApplet

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

com.ibm.tivoli.maximo.skd.applet.SKDViewerApplet

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer

Direct Known Subclasses:

ASNViewerApplet

public class SKDViewerApplet
extends javax.swing.JApplet

Main applet class for display the Gantt and Resource View. Prepares the view, sets and gets models to and from backend service and its changes

Since:

Scheduler 7.1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SKDViewerApplet.ListenerHelper Simple class to manage the model listeners
static class	SKDViewerApplet.LoggableRunnable
class	SKDViewerApplet.skdSortCombo Combo Box popup for the Horizontal and Vertical ScrollBar

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTRAINT_TYPES_SEPARATOR Contraint type seprator "\u00a7"
static java.lang.String	currentProjectId
static boolean	enableDebugMenus
static SKDViewerApplet.ListenerHelper	listenerHelper

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

Constructors

Constructor and Description
SKDViewerApplet()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdvancedSearchToToolbar(javax.swing.JToolBar toolbar) Adds advanced search and clear filters icons to the toolbar
void	addOnLoadListener(java.lang.Runnable onload, java.lang.String msg) Adds a Runnable task to the OnLoad list.
static void	addZoomFunctionsToToolbar(Viewer viewer, javax.swing.JToolBar toolbar, ilog.views.gantt.IlvTimeScrollController timeScroll) Creates and adds the Zoom functions (zoom in, out, zoom to week, and goto day, etc) to the JToolBar.
void	clearState()
void	copyGanttModel(ilog.views.gantt.IlvGanttModel model) Copy the Gantt Model and store a reference, in case we need to quickly reload the unchanged model.
javax.swing.JMenu	createEditMenu() Creates edit menu
javax.swing.JMenu	createFileMenu() Creates File menu
javax.swing.JMenuBar	createMenuBar() Creates menu bar
void	destroy() Standard applet destory method
static void	disableEvents()
void	disableSendingActivityChangesToServer() Disables sending the activity changes to the server.
void	editConstraint(java.lang.String newValues) Called from java script to set changed properties of the constraint being edited
static void	enableEvents()
void	enableSendingActivityChangesToServer() Enables sending activity changes to the server.
static <RequestType,ReplyType> ReplyType	fetchAndWait(SerializedDataManager<RequestType,ReplyType> manager, RequestType request)
java.awt.Frame	findParentFrame()
java.lang.String[]	getAppAndProjId() Get's the Scheduler app ID and proj ID
static java.lang.String	getAppletBuildVersion()
SimpleMessageBus	getAppletEventBus() Returns the SimpleMessageBus instance that other components can use to register event listeners when they need to listen for events that originate from the Maximo server.
AppletGanttModel	getAppletGanttModel()
java.awt.Container	getApplicationContainer() returns the main container for the applet ui
java.lang.String	getAppName() Get's teh Scheduler app ID
java.awt.Container	getContentPane()
java.lang.String[][]	getCookies() Return the JSESSION Cookie data as a string array where each array element contains the cookie name and value in positions 0 and 1 of the array element
ilog.views.gantt.IlvGanttModel	getGanttModelCopy()
AppHeaderView	getHeaderView() Returns the AppHeaderView component that holds the toolbars and title
ilog.views.gantt.IlvJScrollGanttSheet	getJScrollGanttSheet(GanttAndResourceUsageView grView)
java.lang.String	getName() Standard applet getName method
java.lang.String	getProjectid() Standard applet getName method
java.lang.String	getServerHost()
java.util.Date	getServerTime()
java.lang.String	getSKDServletURLBase()
ISKDUIInfo	getSKDUIInfo()
SKDUserLocaleData	getSKDUserLocaleData()
SortGanttModel	getSortAndFilterGanttModel() Gets sort and filter gantt model
ilog.views.gantt.graphic.timeindicator.IlvFixedTimeIndicator	getStartTimeIndicator() Returns fixed time indicator that was created here in applet init
java.lang.String	getUISessionId() Returns the current Maximo UI Session id
Viewer	getViewer()
void	handleAppletEvent(java.lang.String eventName, java.lang.String eventData, boolean decode) Handles the applet event and dispatches the event name and event args to the SimpleMessageBus so that other components can be notified about the event.
void	hideGlass() Hides the glass pane.
void	init() Standard applet init method.
void	init(java.awt.Container container) Called when applet is launched as an app from within IED.
void	initApp(java.lang.String projectid, java.lang.String serverhost, java.lang.String serverport) Called when applet is launched as an application
void	initProjectDataModel(java.lang.String scenarioprojectsString) Gets model data for the current project and sets it to the filterMode, Viewer and appletmodel.
boolean	isLaunchedAsApp() Returns with applet was launched as app.
static boolean	isProjectLoaded()
static void	main(java.lang.String[] args) the arguments arg[0] for projectID and arg[1] for this host name info for testing
void	resize(int width, int height) Small hack to disable divider events during resize
static boolean	resizedRecently()
ilog.views.gantt.IlvGanttModel	retrieveProjectDataModel(java.lang.String projectId)
ISKDUIInfo	retrieveSKDUIInfo()
ISKDUIInfo	retrieveSKDUIInfoProjId()
void	sendActivityChangesToServer()
void	sendActivityChangesToServerOnly()
void	sendConfigChangesRemote(GanttConfigChanges configChanges)
void	sendModelChangesRemote(GanttModelChanges modelChanges)
void	setBoundScrolling(ilog.views.gantt.IlvGanttChart chart, boolean enabled)
void	setConstraintForEdit(ilog.views.gantt.model.general.IlvGeneralConstraint constraint) Stores the reference of the constraint being edited
static void	setEventState(boolean state)
void	setLookAndFeel() Sets the default look and feel neded for the application.
void	setSKDActivityQBE(java.lang.String strSKDActivityQBE) Sets skdActivityQBE
void	setSKDServletURLBase(java.lang.String skdServletURLBase) Sets servlet URL base
void	setUISessionId(java.lang.String uiSessionId) Sets servlet UI Session Id
void	showCompliance(boolean showCompliance)
void	showGlass(java.lang.String string) Show Glass shows a darkened Glass Panel over the main main component with a message.
void	start() Standard applet start method
void	stop() Standard applet stop method
void	switchCompliance()
void	viewScenario(java.lang.String eventName, java.lang.Object data)
void	visibilityCallback(boolean visible) Called from Javascript from the library.js (showObjs/hideObjs) when Applet is hidden/shown.

Methods inherited from class javax.swing.JApplet

getAccessibleContext, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update

Methods inherited from class java.applet.Applet

getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, setStub, showStatus

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

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

Methods inherited from class java.lang.Object

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

Field Detail

enableDebugMenus

public static boolean enableDebugMenus

currentProjectId

public static java.lang.String currentProjectId

CONTRAINT_TYPES_SEPARATOR

public static final java.lang.String CONTRAINT_TYPES_SEPARATOR

Contraint type seprator "\u00a7"

See Also:

Constant Field Values

listenerHelper

public static SKDViewerApplet.ListenerHelper listenerHelper

Constructor Detail

SKDViewerApplet

public SKDViewerApplet()

Method Detail

getCookies

public java.lang.String[][] getCookies()

Return the JSESSION Cookie data as a string array where each array element contains the cookie name and value in positions 0 and 1 of the array element

init

public void init()

Standard applet init method. But this is the main entry point for the code.

Overrides:

init in class java.applet.Applet

getAppletBuildVersion

public static java.lang.String getAppletBuildVersion()

getName

public java.lang.String getName()

Standard applet getName method

Overrides:

getName in class java.awt.Component

getProjectid

public java.lang.String getProjectid()

Standard applet getName method

destroy

public void destroy()

Standard applet destory method

Overrides:

destroy in class java.applet.Applet

start

public void start()

Standard applet start method

Overrides:

start in class java.applet.Applet

stop

public void stop()

Standard applet stop method

Overrides:

stop in class java.applet.Applet

getContentPane

public java.awt.Container getContentPane()

Specified by:

getContentPane in interface javax.swing.RootPaneContainer

Overrides:

getContentPane in class javax.swing.JApplet

initApp

public void initApp(java.lang.String projectid,
           java.lang.String serverhost,
           java.lang.String serverport)

Called when applet is launched as an application

init

public void init(java.awt.Container container)

Called when applet is launched as an app from within IED. This is mainly for testing purposes

Parameters:

container -

getAppletGanttModel

public AppletGanttModel getAppletGanttModel()

findParentFrame

public java.awt.Frame findParentFrame()

addAdvancedSearchToToolbar

public void addAdvancedSearchToToolbar(javax.swing.JToolBar toolbar)

Adds advanced search and clear filters icons to the toolbar

Parameters:

toolbar -

getApplicationContainer

public java.awt.Container getApplicationContainer()

returns the main container for the applet ui

Returns:

addZoomFunctionsToToolbar

public static void addZoomFunctionsToToolbar(Viewer viewer,
                             javax.swing.JToolBar toolbar,
                             ilog.views.gantt.IlvTimeScrollController timeScroll)

Creates and adds the Zoom functions (zoom in, out, zoom to week, and goto day, etc) to the JToolBar.

Parameters:

toolbar -

getJScrollGanttSheet

public ilog.views.gantt.IlvJScrollGanttSheet getJScrollGanttSheet(GanttAndResourceUsageView grView)

setBoundScrolling

public void setBoundScrolling(ilog.views.gantt.IlvGanttChart chart,
                     boolean enabled)

createMenuBar

public javax.swing.JMenuBar createMenuBar()

Creates menu bar

Returns:

JMenuBar

createFileMenu

public javax.swing.JMenu createFileMenu()

Creates File menu

Returns:

JMenu

createEditMenu

public javax.swing.JMenu createEditMenu()

Creates edit menu

Returns:

JMenu

getViewer

public Viewer getViewer()

getSKDUserLocaleData

public SKDUserLocaleData getSKDUserLocaleData()

getSKDUIInfo

public ISKDUIInfo getSKDUIInfo()

disableSendingActivityChangesToServer

public void disableSendingActivityChangesToServer()

Disables sending the activity changes to the server. This would be helpful to minimize the network calls and for operations that modify lot of properties/activities in bulk. NOTE: Make sure to use a try...finally block to enable this, otherwise the activity changes will never be sent.

enableSendingActivityChangesToServer

public void enableSendingActivityChangesToServer()

Enables sending activity changes to the server.

sendActivityChangesToServer

public void sendActivityChangesToServer()

sendActivityChangesToServerOnly

public void sendActivityChangesToServerOnly()

initProjectDataModel

public void initProjectDataModel(java.lang.String scenarioprojectsString)

Gets model data for the current project and sets it to the filterMode, Viewer and appletmodel. This is called from the javascript portion of the control.

Parameters:

scenarioprojectsString -

isProjectLoaded

public static boolean isProjectLoaded()

addOnLoadListener

public void addOnLoadListener(java.lang.Runnable onload,
                     java.lang.String msg)

Adds a Runnable task to the OnLoad list. If the UI has already been initialized, then it is run immediately. But if the UI is still waiting to be initialized, then it will be added to the On Load list and run once the UI is finally initialized.

setSKDServletURLBase

public void setSKDServletURLBase(java.lang.String skdServletURLBase)

Sets servlet URL base

Parameters:

skdServletURLBase -

getSKDServletURLBase

public java.lang.String getSKDServletURLBase()

getServerHost

public java.lang.String getServerHost()

setUISessionId

public void setUISessionId(java.lang.String uiSessionId)

Sets servlet UI Session Id

Parameters:

skdServletURLBase -

getUISessionId

public java.lang.String getUISessionId()

Returns the current Maximo UI Session id

Returns:

getAppName

public java.lang.String getAppName()

Get's teh Scheduler app ID

Parameters:

APPNAME - webclientsession.getCurrentApp.GetID()

getAppAndProjId

public java.lang.String[] getAppAndProjId()

Get's the Scheduler app ID and proj ID

setSKDActivityQBE

public void setSKDActivityQBE(java.lang.String strSKDActivityQBE)

Sets skdActivityQBE

Parameters:

skdActivityQBE -

editConstraint

public void editConstraint(java.lang.String newValues)

Called from java script to set changed properties of the constraint being edited

Parameters:

constraint -

main

public static void main(java.lang.String[] args)

the arguments arg[0] for projectID and arg[1] for this host name info for testing

setConstraintForEdit

public void setConstraintForEdit(ilog.views.gantt.model.general.IlvGeneralConstraint constraint)

Stores the reference of the constraint being edited

Parameters:

constraint -

isLaunchedAsApp

public boolean isLaunchedAsApp()

Returns with applet was launched as app.

Returns:

getStartTimeIndicator

public ilog.views.gantt.graphic.timeindicator.IlvFixedTimeIndicator getStartTimeIndicator()

Returns fixed time indicator that was created here in applet init

Returns:

getSortAndFilterGanttModel

public SortGanttModel getSortAndFilterGanttModel()

Gets sort and filter gantt model

Returns:

fetchAndWait

public static <RequestType,ReplyType> ReplyType fetchAndWait(SerializedDataManager<RequestType,ReplyType> manager,
                                             RequestType request)

getServerTime

public java.util.Date getServerTime()

retrieveProjectDataModel

public ilog.views.gantt.IlvGanttModel retrieveProjectDataModel(java.lang.String projectId)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

hideGlass

public void hideGlass()

Hides the glass pane.

showGlass

public void showGlass(java.lang.String string)

Show Glass shows a darkened Glass Panel over the main main component with a message. For this to work correctly, it has to be run on the main UI thread.

Parameters:

string -

retrieveSKDUIInfo

public ISKDUIInfo retrieveSKDUIInfo()
                             throws java.lang.Exception

Throws:

java.lang.Exception

retrieveSKDUIInfoProjId

public ISKDUIInfo retrieveSKDUIInfoProjId()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

sendModelChangesRemote

public void sendModelChangesRemote(GanttModelChanges modelChanges)

sendConfigChangesRemote

public void sendConfigChangesRemote(GanttConfigChanges configChanges)

setLookAndFeel

public void setLookAndFeel()

Sets the default look and feel neded for the application.

switchCompliance

public void switchCompliance()

showCompliance

public void showCompliance(boolean showCompliance)

handleAppletEvent

public void handleAppletEvent(java.lang.String eventName,
                     java.lang.String eventData,
                     boolean decode)

Handles the applet event and dispatches the event name and event args to the SimpleMessageBus so that other components can be notified about the event. This the bridge between the Maximo server and the applet for pushing events to the applet. For example the following code, executed on the server causes the message and it's args to be delivered to the Applet

                WebClientEvent appletEvent = new WebClientEvent(BaseViewerControl.APPLET_EVENT_NAME, (String) app.get("asnviewerId"), args, clientSession);
      appletEvent.addParameter(BaseViewerControl.APPLET_EVENT_TARGET_EVENT_NAME, "compare_scenarios");
      clientSession.queueEvent(appletEvent);
 

The above code will fire a "compare_scenarios" event in the Applet, passing the args as the event parameters

Parameters:

eventName - name of event to dispatch

eventData - data to dispatch

decode - if true, the data will be Base64Decoded, and converted to a Java Object before being put on the event bus

viewScenario

public void viewScenario(java.lang.String eventName,
                java.lang.Object data)

getAppletEventBus

public SimpleMessageBus getAppletEventBus()

Returns the SimpleMessageBus instance that other components can use to register event listeners when they need to listen for events that originate from the Maximo server.

Returns:

getHeaderView

public AppHeaderView getHeaderView()

Returns the AppHeaderView component that holds the toolbars and title

copyGanttModel

public void copyGanttModel(ilog.views.gantt.IlvGanttModel model)

Copy the Gantt Model and store a reference, in case we need to quickly reload the unchanged model.

getGanttModelCopy

public ilog.views.gantt.IlvGanttModel getGanttModelCopy()

visibilityCallback

public void visibilityCallback(boolean visible)

Called from Javascript from the library.js (showObjs/hideObjs) when Applet is hidden/shown.

Parameters:

visible - currently visibility state

disableEvents

public static void disableEvents()

enableEvents

public static void enableEvents()

setEventState

public static void setEventState(boolean state)

resize

public void resize(int width,
          int height)

Small hack to disable divider events during resize

Overrides:

resize in class java.applet.Applet

clearState

public void clearState()

resizedRecently

public static boolean resizedRecently()