at.spardat.xma.page
Interface IDialogPage

All Superinterfaces:
at.spardat.xma.boot.component.IDialog, IEmbeddable, at.spardat.xma.boot.component.IXMAControl
All Known Subinterfaces:
IAppShell
All Known Implementing Classes:
AppShell, DialogPage

public interface IDialogPage
extends at.spardat.xma.boot.component.IDialog, IEmbeddable

The interface for all DialogPages.

Since:
1.3.0

Method Summary
 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.
 boolean hasValidationError(org.eclipse.swt.widgets.Widget widget)
          Determines if a validation error currently exists for a given widget.
 void overrideErrorsFromModel()
          Resets all widgets containing values with validation errors to their valid value from the model.
 void setFocus(org.eclipse.swt.widgets.Control control)
          Sets the focus to the given control.
 void setInfo(org.eclipse.swt.widgets.Widget widget, java.lang.String infoText)
          Sets an info for the given widget.
 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.
 
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

setFocus

public void setFocus(org.eclipse.swt.widgets.Control control)
Sets the focus to the given control.

Parameters:
control - the Control to set the focus to.

clearValidationErrorImpl

public void clearValidationErrorImpl(org.eclipse.swt.widgets.Widget widget)
Removes a validation error for a particular widget. This method is for internal use only. Calling it causes undefined behaviour!

Parameters:
widget - the widget where to clear the error state.

setValidationErrorImpl

public void setValidationErrorImpl(org.eclipse.swt.widgets.Widget widget,
                                   java.lang.String errorText)
Sets a validation error for a particular widget. This method is for internal use only. Calling it causes undefined behaviour!

Parameters:
widget - the widget where the error occured
errorText - indicates the error

overrideErrorsFromModel

public void overrideErrorsFromModel()
Resets all widgets containing values with validation errors to their valid value from the model.


hasValidationError

public boolean hasValidationError(org.eclipse.swt.widgets.Widget widget)
Determines if a validation error currently exists for a given widget. Note that validation is disabled automatically for readonly widgets, so readonly widgets never have validation errors.

Parameters:
widget - to search for validation errors
Returns:
true if the validator reported an error for the given widget. false otherwise.

setWarning

public void setWarning(org.eclipse.swt.widgets.Widget widget,
                       java.lang.String warningText)
Sets an warning for the given widget. The warning is shown in the status line, if currently no error has to be shown. Only one error or warning can be shown at a time. The precedence rules are:
1) any error of any widget (see IDialog.setError(Widget, String)
2) the warning of the widget owning the focus
3) the warning of the next widget in the tab order containing a warning
4) the warning set for the null-widget.

Parameters:
widget - the widget the warning is associated with. Null is allowed.
warningText - indicates the warning

clearWarning

public void clearWarning(org.eclipse.swt.widgets.Widget widget)
Removes the warning for the given widget.

Parameters:
widget - the widget where to clear the warning.

setInfo

public void setInfo(org.eclipse.swt.widgets.Widget widget,
                    java.lang.String infoText)
Sets an info for the given widget. The info is shown in the status line, if currently no error or warning has to be shown. Only one error, warning or info can be shown at a time. The precedence rules are:
1) any error or warning of any widget (see setWarning(Widget, String)
2) the info of the widget owning the focus
3) the info of the next widget in the tab order containing a warning
4) the info set for the null-widget.

Parameters:
widget - the widget the info is associated with. Null is allowed.
infoText - indicates the info

clearInfo

public void clearInfo(org.eclipse.swt.widgets.Widget widget)
Removes the info for the given widget.

Parameters:
widget - the widget where to clear the info.