|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectat.spardat.xma.page.Page
at.spardat.xma.page.PageClient
at.spardat.xma.page.DialogPage
at.spardat.xma.appshell.AppShell
Base class for application shells in XMA. 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.
| Field Summary | |
protected MenuItem |
rootMenu
The root of the menu tree. |
protected ITask |
rootTask
The task at the very bottom of the call stack. |
| Fields inherited from class at.spardat.xma.page.DialogPage |
statusBar, statusBarComposite |
| Fields inherited from class at.spardat.xma.page.PageClient |
composite |
| Constructor Summary | |
AppShell(ComponentClient component,
boolean stateless,
int style)
Initializes the application shell. |
|
| Method Summary | |
abstract void |
attachMenu(IMenuItem item)
Attach the given MenuItem to its viusal representation. |
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. |
protected boolean |
close()
This method will be called every time the Shell is tried to be closed. |
void |
closeCancel()
Closes the component or page on top of the call stack. |
void |
closeOK()
Closes the component or page on top of the call stack. |
protected boolean |
closeTasks(IMenuItem item)
Closes all tasks on the call stack which are outside the given MenuItem. |
abstract ITask |
createRootTask(IMenuItem rootMenu)
Create the MenuItem which will serve as root of all other MenuItems. |
ITask |
createTask(java.lang.String name)
Creates the Task with the given name. |
abstract void |
detachMenu(IMenuItem item)
Detach the MenuItem from its visual representation. |
void |
exit()
Closes the AppShell. |
abstract org.eclipse.swt.widgets.Composite |
getClientComposite()
Get the SWT-composite where client pages or composites can be embedded. |
IMenuItem |
getMenu(java.lang.String menuId)
Get the MenuItem registered under the given menuId. |
protected abstract java.util.ResourceBundle |
getMenuResource()
Get the ResourceBundle containing the labels for all menu items. |
ITask |
getTopTask()
Get the task on top of the call stack. |
boolean |
hasWidgets()
Determine if the AppShell still contains widgets. |
boolean |
invoke()
Method called to start the AppShell. |
void |
leaveBase()
Notify the AppShell, all Tasks and all Subpages, that the Page no longer is visible. |
void |
lockMenu()
Locks and disables the menu. |
abstract 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. |
abstract 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. |
protected abstract void |
setMenuEnabled(boolean enabled)
Completely enable/disable the menu. |
void |
unlockMenu()
Unlocks the menu. |
void |
unregisterMenu(IMenuItem item)
Unregister the given MenuItem fromt the AppShell. |
| Methods inherited from class at.spardat.xma.page.DialogPage |
clearError, clearInfo, clearValidationErrorImpl, clearWarning, createComposite, getDialog, getErrorCount, getExitstatus, getFocusControl, getShell, hasValidationError, initGUI, isVisible, overrideErrorsFromModel, removeWidgetsBase, setError, setFocus, setFocusControl, setInfo, setRerunStateChanched, setValidationErrorImpl, setWarning, stateChangedBase, updateErrorStatus |
| Methods inherited from class at.spardat.xma.page.Page |
changed, commit, describe, display, equalsCS, externalize, getId, getNumWModels, getTypeId, getWModel, getWModels, internalize, isAtServer, isStateless, randomlyChange, rollback, toString |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface at.spardat.xma.appshell.IAppShell |
contextStringChanged, showContextStack |
| 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, getErrorCount, getFocusControl, getShell, setError, setFocusControl, updateErrorStatus |
| Methods inherited from interface at.spardat.xma.boot.component.IXMAControl |
createComposite, enterBase, getComposite, initGUI, removeModel, removeWidgetsBase, stateChangedBase |
| Methods inherited from interface at.spardat.xma.page.IEmbeddable |
determineStateBase, getContextString, getDialog, setDialog, setEventsEnabled, stateChangedBaseImpl, stateChangedExtend |
| Field Detail |
protected MenuItem rootMenu
protected ITask rootTask
| Constructor Detail |
public AppShell(ComponentClient component,
boolean stateless,
int style)
component - the Component containing the DialogPage.stateless - indicating if this page is stateless on the server.style - The SWT-Style for the Shell of the DialogPage.
java.lang.IllegalArgumentException - if comonent is null.| Method Detail |
public void setClientArea(at.spardat.xma.boot.component.IXMAControl newClient)
setClientArea in interface IAppShellnewClient - the new page or component to embedd.public void clearClientArea()
clearClientArea in interface IAppShellpublic abstract org.eclipse.swt.widgets.Composite getClientComposite()
public abstract ITask createRootTask(IMenuItem rootMenu)
public ITask createTask(java.lang.String name)
createTask in interface IAppShellname - unique name for the task within the client side application.public void lockMenu()
lockMenu in interface IAppShellpublic void unlockMenu()
unlockMenu in interface IAppShellprotected abstract void setMenuEnabled(boolean enabled)
enabled - true: enable, false: disable.public abstract void attachMenu(IMenuItem item)
item - to attachpublic abstract void detachMenu(IMenuItem item)
item - to removepublic void registerMenu(IMenuItem item)
registerMenu in interface IAppShellitem - to registerpublic void unregisterMenu(IMenuItem item)
unregisterMenu in interface IAppShellitem - to removepublic void callMenu(IMenuItem item)
callMenu in interface IAppShellitem - the MenuItem to call.public void callMenu(java.lang.String menuId)
callMenu in interface IAppShellmenuId - the name of the MenuItem to call.public IMenuItem getMenu(java.lang.String menuId)
menuId - the name of the MenuItem you want.
public abstract void selectMenu(java.lang.String menuId)
selectMenu in interface IAppShellmenuId - the name of the MenuItem to select.public abstract void markMenu(java.lang.String menuId)
markMenu in interface IAppShellmenuId - the name of the MenuItem to mark as selected.protected abstract java.util.ResourceBundle getMenuResource()
public boolean invoke()
invoke in class DialogPagepublic ITask getTopTask()
getTopTask in interface IAppShell
public void pushClientComponent(at.spardat.xma.boot.component.IXMAControl newClient,
boolean modal)
pushClientComponent in interface IAppShellnewClient - 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 closeOK()
closeOK in interface at.spardat.xma.boot.component.IDialogcloseOK in class DialogPagepublic void closeCancel()
closeCancel in interface at.spardat.xma.boot.component.IDialogcloseCancel in class DialogPagepublic void leaveBase()
leaveBase in interface at.spardat.xma.boot.component.IXMAControlleaveBase in class PageClientpublic void exit()
protected boolean close()
close in class DialogPageprotected boolean closeTasks(IMenuItem item)
item - the menu item outside which all tasks should be closed.
public boolean hasWidgets()
hasWidgets in interface IAppShell
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||