com.irisel.oms.guiom.interfaces

Interface CLDesktop

All Known Implementing Classes:

CLGuiom, CLGuiomBase, CLWSGuiom

public interface CLDesktop

Method Summary

Modifier and Type	Method and Description
void	addFrame(CLInternalFrame cli)
void	addToolbar(Instance menu)
void	addToolbar(javax.swing.JToolBar tb)
void	clearStatusMsg()
void	defaultCursor()
java.lang.String	exec(java.lang.String string, java.lang.Object[] strings)
SvcContext	execSvc(SvcContext ctx)
void	exit()
void	exitFullScreen()
void	frontIfUp(int clid)
CLBrowser	getBrowser()
java.lang.String	getClientMode()
ComponentMapper	getComponentMapper()
PackageConfiguration	getConfig()
Console	getConsole()
OMSEventListener	getController() Returns the UI central controller
Instance	getEmployee()
Instance	getEmployeeGroup()
CLInternalFrame	getFrame(int frameId) Returns a frame given its key.
java.util.Set<java.lang.Integer>	getFrameKeySet() Returns the set of keys for existing frames.
java.lang.String	getLang()
java.awt.Frame	getMainFrame()
int	getMode()
SecurityManager	getSecMgr()
Session	getSession()
javax.swing.JToolBar	getToolbar(java.lang.String tbName)
java.lang.String	getUser()
Instance	getUserInstance()
void	goFullScreen(boolean enable)
void	notifyUser(java.lang.String mesg)
void	refresh()
void	refresh(int frameid, int panelid)
void	refreshMenu(CLInternalFrame clInternalFrame)
void	removeAllToolbars()
void	removeFrame(CLInternalFrame cli)
void	removeToolbar(javax.swing.JToolBar tb)
void	reset()
void	restoreCursor()
void	saveConfig()
void	send(int type, java.lang.String name, java.lang.Object value) Creates an OMSEvent using type, name & values and notifies the central UI controller (OMSEventListener).
void	send(int type, java.lang.String name, java.lang.Object[] value) Creates an OMSEvent using type, name & values and notifies the central UI controller (OMSEventListener).
void	send(OMSAction action) Sends the action received as arguments to the central UI controller (OMSEventListener) encapsulated in an OMSEvent.
void	send(OMSEvent evt) Sends the event received as arguments to the central UI controller (OMSEventListener).
void	sendAllFrames(OMSAction action)
void	sendAllFrames(OMSEvent evt)
void	sendAllFrames(java.lang.String action)
void	sendAllFrames(java.lang.String action, java.lang.Object value)
void	sendAllFrames(java.lang.String action, java.lang.Object[] value)
void	sendFrame(int frameKey, int panelKey, OMSAction action)
void	sendFrame(int frameKey, int panelKey, OMSEvent evt)
void	sendFrame(int frameKey, int panelKey, java.lang.String action)
void	sendFrame(int frameKey, int panelKey, java.lang.String action, java.lang.Object value)
void	sendFrame(int frameKey, int panelKey, java.lang.String action, java.lang.Object[] value)
void	setConsole(Console console)
void	setLang(java.lang.String lang)
void	setMode(int mode)
void	setModule(java.lang.String actionCommand)
void	setStatusMsg(java.lang.String mesg)
void	toggleFullScreen()
void	waitCursor()

Method Detail

getBrowser

CLBrowser getBrowser()

addFrame

void addFrame(CLInternalFrame cli)

removeFrame

void removeFrame(CLInternalFrame cli)
          throws GuiException

Throws:

GuiException

getFrame

CLInternalFrame getFrame(int frameId)

Returns a frame given its key.

Returns:

getFrameKeySet

java.util.Set<java.lang.Integer> getFrameKeySet()

Returns the set of keys for existing frames.

Returns:

getMainFrame

java.awt.Frame getMainFrame()

Returns:

the main frame

send

void send(int type,
          java.lang.String name,
          java.lang.Object[] value)
   throws java.lang.Exception

Creates an OMSEvent using type, name & values and notifies the central UI controller (OMSEventListener). The type and name of the actions are used by the controller to manage / dispatch the event.

Parameters:

type -

name -

value -

Throws:

java.lang.Exception

send

void send(int type,
          java.lang.String name,
          java.lang.Object value)
   throws java.lang.Exception

Creates an OMSEvent using type, name & values and notifies the central UI controller (OMSEventListener). The type and name of the actions are used by the controller to manage / dispatch the event.

Parameters:

type - of the event

name - of the action of the event

value - array of values

Throws:

java.lang.Exception

send

void send(OMSEvent evt)
   throws java.lang.Exception

Sends the event received as arguments to the central UI controller (OMSEventListener).

Parameters:

evt -

Throws:

java.lang.Exception

send

void send(OMSAction action)
   throws java.lang.Exception

Sends the action received as arguments to the central UI controller (OMSEventListener) encapsulated in an OMSEvent.

Parameters:

evt -

Throws:

java.lang.Exception

getController

OMSEventListener getController()

Returns the UI central controller

Returns:

getConfig

PackageConfiguration getConfig()

setStatusMsg

void setStatusMsg(java.lang.String mesg)

clearStatusMsg

void clearStatusMsg()

notifyUser

void notifyUser(java.lang.String mesg)

getUser

java.lang.String getUser()

getUserInstance

Instance getUserInstance()

getMode

int getMode()

setMode

void setMode(int mode)

getLang

java.lang.String getLang()

setLang

void setLang(java.lang.String lang)

getConsole

Console getConsole()

setConsole

void setConsole(Console console)

frontIfUp

void frontIfUp(int clid)

refresh

void refresh()
      throws GuiException

Throws:

GuiException

refresh

void refresh(int frameid,
             int panelid)
      throws GuiException

Throws:

GuiException

reset

void reset()
    throws GuiException

Throws:

GuiException

sendFrame

void sendFrame(int frameKey,
               int panelKey,
               OMSEvent evt)

sendFrame

void sendFrame(int frameKey,
               int panelKey,
               OMSAction action)

sendFrame

void sendFrame(int frameKey,
               int panelKey,
               java.lang.String action)

sendFrame

void sendFrame(int frameKey,
               int panelKey,
               java.lang.String action,
               java.lang.Object value)

sendFrame

void sendFrame(int frameKey,
               int panelKey,
               java.lang.String action,
               java.lang.Object[] value)

sendAllFrames

void sendAllFrames(OMSEvent evt)

sendAllFrames

void sendAllFrames(OMSAction action)

sendAllFrames

void sendAllFrames(java.lang.String action)

sendAllFrames

void sendAllFrames(java.lang.String action,
                   java.lang.Object value)

sendAllFrames

void sendAllFrames(java.lang.String action,
                   java.lang.Object[] value)

getClientMode

java.lang.String getClientMode()

setModule

void setModule(java.lang.String actionCommand)

getEmployee

Instance getEmployee()

getEmployeeGroup

Instance getEmployeeGroup()

getComponentMapper

ComponentMapper getComponentMapper()

getSession

Session getSession()

getSecMgr

SecurityManager getSecMgr()

addToolbar

void addToolbar(Instance menu)

addToolbar

void addToolbar(javax.swing.JToolBar tb)

getToolbar

javax.swing.JToolBar getToolbar(java.lang.String tbName)

removeToolbar

void removeToolbar(javax.swing.JToolBar tb)

removeAllToolbars

void removeAllToolbars()

saveConfig

void saveConfig()
         throws java.io.IOException

Throws:

java.io.IOException

exec

java.lang.String exec(java.lang.String string,
                      java.lang.Object[] strings)
               throws java.lang.Exception

Throws:

java.lang.Exception

execSvc

SvcContext execSvc(SvcContext ctx)
            throws java.lang.Exception

Throws:

java.lang.Exception

goFullScreen

void goFullScreen(boolean enable)

exitFullScreen

void exitFullScreen()

toggleFullScreen

void toggleFullScreen()

exit

void exit()

refreshMenu

void refreshMenu(CLInternalFrame clInternalFrame)

waitCursor

void waitCursor()

defaultCursor

void defaultCursor()

restoreCursor

void restoreCursor()