|
||||||||||
| 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
This Class is the base class of all dialog Pages. It implements the main livecycle protocoll for the dialog and the handling of the corresponding SWT-Shell.
| Field Summary | |
protected StatusBar |
statusBar
The StatusBar of the Dialog. |
protected org.eclipse.swt.widgets.Composite |
statusBarComposite
The SWT-Composite serving as parent for the StatusBar |
| Fields inherited from class at.spardat.xma.page.PageClient |
composite |
| Constructor Summary | |
DialogPage(ComponentClient component,
boolean stateless,
int style)
Initializes a DialogPage inside a given Component. |
|
DialogPage(ComponentClient component,
org.eclipse.swt.widgets.Shell parentShell,
boolean stateless,
int style)
Initializes a DialogPage inside a given Component. |
|
DialogPage(PageClient parent,
boolean stateless,
int style)
Initializes a DialogPage inside the same Component as the parent PageClient. |
|
| Method Summary | |
void |
clearError(org.eclipse.swt.widgets.Widget widget)
Removes the error for the given widget. |
void |
clearInfo(org.eclipse.swt.widgets.Widget widget)
Removes the info for the given widget. |
void |
clearValidationErrorImpl(org.eclipse.swt.widgets.Widget widget)
Removes a validation error for a particular widget. |
void |
clearWarning(org.eclipse.swt.widgets.Widget widget)
Removes the warning for the given widget. |
protected boolean |
close()
This method will be called every time the Shell is tried to be closed. |
void |
closeCancel()
Closes the dialog with exitStatus false. |
void |
closeOK()
Closes the dialog with exitStatus true. |
org.eclipse.swt.widgets.Composite |
createComposite(org.eclipse.swt.widgets.Composite parentComp)
|
at.spardat.xma.boot.component.IDialog |
getDialog()
Get the DialogPage of this Page. |
int |
getErrorCount()
Returns the number of Errors in this dialog including its subpages. |
boolean |
getExitstatus()
Returns the exitStatus of the DialogPage. |
org.eclipse.swt.widgets.Control |
getFocusControl()
Gets the Control on the DialogPage or a Subpage of it, which currently has the focus. |
org.eclipse.swt.widgets.Shell |
getShell()
Get the SWT-Shell of the DialogPage. |
boolean |
hasValidationError(org.eclipse.swt.widgets.Widget widget)
Determines if a validation error currently exists for a given widget. |
void |
initGUI()
Creates the Widgets of the PageClient and all Subpages by calling PageClient.createWidgets() on the PageClient and all Subpages. |
boolean |
invoke()
Method called to start the DialogPage. |
boolean |
isVisible()
Indicates if the dialog is shown to the user. |
void |
overrideErrorsFromModel()
Resets all widgets containing values with validation errors to their last known valid value from the model. |
void |
removeWidgetsBase()
Notify the PageClient and all Subpages, that the Widgets are disposed by calling PageClient.removeWidgets() on all Subpages and the PageClient. |
void |
setError(org.eclipse.swt.widgets.Widget widget,
java.lang.String errorText)
Sets an error for the given widget. |
void |
setFocus(org.eclipse.swt.widgets.Control control)
Sets the focus to the given control. |
void |
setFocusControl(org.eclipse.swt.widgets.Control control)
Sets the Control on the DialogPage of a Subpage of it, which currently has the focus. |
void |
setInfo(org.eclipse.swt.widgets.Widget widget,
java.lang.String infoText)
Sets an info for the given widget. |
void |
setRerunStateChanched()
Requests another call to PageClient.determineState() and PageClient.stateChanged() if called within one of
these methods. |
void |
setValidationErrorImpl(org.eclipse.swt.widgets.Widget widget,
java.lang.String errorText)
Sets a validation error for a particular widget. |
void |
setWarning(org.eclipse.swt.widgets.Widget widget,
java.lang.String warningText)
Sets an warning for the given widget. |
void |
stateChangedBase()
Notify the PageClient and all Subpages of a possible Change in the PageModels by calling PageClient.determineState() and PageClient.stateChanged() on the PageClient
and all Subpages. |
void |
updateErrorStatus(org.eclipse.swt.widgets.Widget current)
Updates the error message in the StatusBar. |
| 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.boot.component.IXMAControl |
enterBase, getComposite, leaveBase, removeModel |
| Methods inherited from interface at.spardat.xma.page.IEmbeddable |
determineStateBase, getContextString, setDialog, setEventsEnabled, stateChangedBaseImpl, stateChangedExtend |
| Field Detail |
protected StatusBar statusBar
protected org.eclipse.swt.widgets.Composite statusBarComposite
| Constructor Detail |
public DialogPage(ComponentClient component,
boolean stateless,
int style)
component - the Component containing the DialogPage.style - The SWT-Style for the Shell of the DialogPage.stateless - indicating if this page is stateless on the server.
java.lang.IllegalArgumentException - if comonent is null.
public DialogPage(ComponentClient component,
org.eclipse.swt.widgets.Shell parentShell,
boolean stateless,
int style)
component - the Component containing the DialogPage.parentShell - the Shell which shall be the parent of the Shell of the DialogPage.style - The SWT-Style for the Shell of the DialogPage.stateless - indicating if this page is stateless on the server.
java.lang.IllegalArgumentException - if comonent is null.
public DialogPage(PageClient parent,
boolean stateless,
int style)
parent - the PageClient calling this DialogPage.stateless - indicating if this page is stateless on the server.style - The SWT-Style for the Shell of the DialogPage.| Method Detail |
public at.spardat.xma.boot.component.IDialog getDialog()
getDialog in interface IEmbeddablegetDialog in class PageClientpublic org.eclipse.swt.widgets.Shell getShell()
getShell in interface at.spardat.xma.boot.component.IDialogpublic void setFocus(org.eclipse.swt.widgets.Control control)
setFocus in interface IDialogPagecontrol - the Control to set the focus to.public org.eclipse.swt.widgets.Control getFocusControl()
getFocusControl in interface at.spardat.xma.boot.component.IDialogpublic void setFocusControl(org.eclipse.swt.widgets.Control control)
setFocusControl in interface at.spardat.xma.boot.component.IDialogcontrol - the Control with the focus.public org.eclipse.swt.widgets.Composite createComposite(org.eclipse.swt.widgets.Composite parentComp)
createComposite in interface at.spardat.xma.boot.component.IXMAControlpublic void initGUI()
PageClient.createWidgets() on the PageClient and all Subpages.
initGUI in interface at.spardat.xma.boot.component.IXMAControlinitGUI in class PageClientpublic boolean invoke()
public void stateChangedBase()
PageClient.determineState() and PageClient.stateChanged() on the PageClient
and all Subpages. My be repeated by calling setRerunStateChanched().
stateChangedBase in interface at.spardat.xma.boot.component.IXMAControlstateChangedBase in class PageClientpublic void setRerunStateChanched()
PageClient.determineState() and PageClient.stateChanged() if called within one of
these methods. It has no effect if called outside these methods.
public void closeOK()
closeOK in interface at.spardat.xma.boot.component.IDialogpublic void closeCancel()
closeCancel in interface at.spardat.xma.boot.component.IDialogpublic void removeWidgetsBase()
PageClient.removeWidgets() on all Subpages and the PageClient.
removeWidgetsBase in interface at.spardat.xma.boot.component.IXMAControlremoveWidgetsBase in class PageClientprotected boolean close()
public boolean isVisible()
public boolean getExitstatus()
public int getErrorCount()
getErrorCount in interface at.spardat.xma.boot.component.IDialogpublic void clearValidationErrorImpl(org.eclipse.swt.widgets.Widget widget)
clearValidationErrorImpl in interface IDialogPageclearValidationErrorImpl in class PageClientwidget - the widget where to clear the error state.
public void setValidationErrorImpl(org.eclipse.swt.widgets.Widget widget,
java.lang.String errorText)
setValidationErrorImpl in interface IDialogPagewidget - the widget where the error occurederrorText - indicates the errorpublic boolean hasValidationError(org.eclipse.swt.widgets.Widget widget)
hasValidationError in interface IDialogPagehasValidationError in class PageClientwidget - to search for validation errors
public void updateErrorStatus(org.eclipse.swt.widgets.Widget current)
updateErrorStatus in interface at.spardat.xma.boot.component.IDialogcurrent - the Widget which currently owns the focus.public void clearError(org.eclipse.swt.widgets.Widget widget)
clearError in interface at.spardat.xma.boot.component.IDialogclearError in class PageClientwidget - the widget where to clear the error state.
public void setError(org.eclipse.swt.widgets.Widget widget,
java.lang.String errorText)
setError in interface at.spardat.xma.boot.component.IDialogwidget - the widget where the error occured. Null is allowd if the error can not
be associated with a widget.errorText - indicates the errorpublic void overrideErrorsFromModel()
overrideErrorsFromModel in interface IDialogPage
public void setWarning(org.eclipse.swt.widgets.Widget widget,
java.lang.String warningText)
setError(Widget, String)
setWarning in interface IDialogPagewidget - the widget the warning is associated with. Null is allowed.warningText - indicates the warningpublic void clearWarning(org.eclipse.swt.widgets.Widget widget)
clearWarning in interface IDialogPagewidget - the widget where to clear the warning.
public void setInfo(org.eclipse.swt.widgets.Widget widget,
java.lang.String infoText)
setWarning(Widget, String)
setInfo in interface IDialogPagewidget - the widget the info is associated with. Null is allowed.infoText - indicates the infopublic void clearInfo(org.eclipse.swt.widgets.Widget widget)
clearInfo in interface IDialogPagewidget - the widget where to clear the info.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||