Apache Zeta Components Manual :: Docs For Class ezcConsoleDialog
ConsoleTools::ezcConsoleDialog
Interface ezcConsoleDialog
Interface that every console dialog class must implement.
Console dialogs can either be used on their own or using the ezcConsoleDialogViewer (recommended). In the dialog viewer, a dialog is instanciated and displayed in a loop, until it receives a valid result value.
Source for this file: /ConsoleTools/src/interfaces/dialog.php
| Version: | //autogen// |
Method Summary
| public void |
display(
)
Displays the dialog. |
| public mixed |
getResult(
)
Returns the result retrieved. |
| public bool |
hasValidResult(
)
Returns if the dialog retrieved a valid result. |
| public void |
reset(
)
Resets the dialog to its initial state. |
Methods
display
Displays the dialog.
Displays the dialog. Dialogs will most propably block the application until the user took some interaction.
getResult
Returns the result retrieved.
If no valid result was retreived, yet, this method should throw an ezcDialogNoValidResultException. Otherwise this method returns the result.
Exceptions:
| Type | Description |
|---|---|
ezcDialogNoValidResultException |
if this method is called without a valid result being retrieved by the object. Use hasValidResult() to avoid this exception. |
hasValidResult
Returns if the dialog retrieved a valid result.
Typically a dialog is displayed in a loop until he received a valid result. What a valid result is, is determined by the dialog itself.
reset
Resets the dialog to its initial state.
Resets the dialog to its orginal state in respect to its internal changes. Note: Any changes you made to the options are kept in tact.