|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Interface for AppShell. An application shell is the window opened at startup
of the client side application. It stays open during the whole user session. It typically contains
a header area showing some context information, a menu area containing the menu tree of the
application and a client area showing the currently active component.
| Method Summary | |
void |
callMenu(IMenuItem item)
Calls the action associated which the given MenuItem. |
void |
callMenu(java.lang.String menuId)
Calls the action associated which the named MenuItem. |
void |
clearClientArea()
Removes the embedded page or componet form the client area. |
void |
contextStringChanged(at.spardat.xma.boot.component.IXMAControl source,
java.lang.String newText)
Notifies the AppShell of a change in the context-string of a component or page. |
ITask |
createTask(java.lang.String name)
Creates the Task with the given name. |
ITask |
getTopTask()
Get the task on top of the call stack. |
boolean |
hasWidgets()
Determine if the AppShell still contains widgets. |
void |
lockMenu()
Locks and disables the menu. |
void |
markMenu(java.lang.String menuId)
Visibly marks the named MenuItem as selected. |
void |
pushClientComponent(at.spardat.xma.boot.component.IXMAControl newClient,
boolean modal)
Pushes the given Component or Page on top of the call stack. |
void |
registerMenu(IMenuItem item)
Register the given MenuItem at the AppShell. |
void |
selectMenu(java.lang.String menuId)
Selects the named MenuItem. |
void |
setClientArea(at.spardat.xma.boot.component.IXMAControl newClient)
Replaces the embedded page or component in the client area. |
void |
showContextStack()
Show the contextStrings of all Tasks, Components and Pages on the call stack. |
void |
unlockMenu()
Unlocks the menu. |
void |
unregisterMenu(IMenuItem item)
Unregister the given MenuItem fromt the AppShell. |
| Methods inherited from interface at.spardat.xma.page.IDialogPage |
clearInfo, clearValidationErrorImpl, clearWarning, hasValidationError, overrideErrorsFromModel, setFocus, setInfo, setValidationErrorImpl, setWarning |
| Methods inherited from interface at.spardat.xma.boot.component.IDialog |
clearError, closeCancel, closeOK, getErrorCount, getFocusControl, getShell, setError, setFocusControl, updateErrorStatus |
| Methods inherited from interface at.spardat.xma.boot.component.IXMAControl |
createComposite, enterBase, getComposite, initGUI, leaveBase, removeModel, removeWidgetsBase, stateChangedBase |
| Methods inherited from interface at.spardat.xma.page.IEmbeddable |
determineStateBase, getContextString, getDialog, setDialog, setEventsEnabled, stateChangedBaseImpl, stateChangedExtend |
| Method Detail |
public void pushClientComponent(at.spardat.xma.boot.component.IXMAControl newClient,
boolean modal)
newClient - the component or page to embedd.modal - if modal is true this method blocks util newClient is finished
if modla if false this method reuturns imediatly.
public void contextStringChanged(at.spardat.xma.boot.component.IXMAControl source,
java.lang.String newText)
source - the component or page which changed its context string.newText - the new context string of the source.public void showContextStack()
public void setClientArea(at.spardat.xma.boot.component.IXMAControl newClient)
newClient - the new page or component to embedd.public void clearClientArea()
public ITask getTopTask()
public void lockMenu()
public void unlockMenu()
public boolean hasWidgets()
public void callMenu(IMenuItem item)
item - the MenuItem to call.public void callMenu(java.lang.String menuId)
menuId - the name of the MenuItem to call.public void selectMenu(java.lang.String menuId)
menuId - the name of the MenuItem to select.public void markMenu(java.lang.String menuId)
menuId - the name of the MenuItem to mark as selected.public void registerMenu(IMenuItem item)
item - public void unregisterMenu(IMenuItem item)
item - public ITask createTask(java.lang.String name)
name - unique name for the task within the client side application.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||