public interface IRichDialogContext
Modifier and Type | Method and Description |
---|---|
boolean |
addEventMapping(com.ulcjava.base.application.ULCComponent eventSource,
String eventStartProcessName)
Adds dynamically a event mapping to a process event start in the Rich
Dialog.
|
void |
clickDeferred(com.ulcjava.base.application.ULCButton button)
Use this method to invoke event process after a roundtrip to the client.
|
void |
disableUiEvents(UiEventKind... eventKinds)
Disables the execution of UI events of the given
event kinds on this rich dialog. |
void |
disableUiEventsTemporary(UiEventKind... eventKinds)
Disables the execution of UI events of the given
event kinds for this
rich dialog temporarily. |
void |
enableUiEvents(UiEventKind... eventKinds)
Enables the execution of UI events of the given
event kinds for this rich dialog. |
IRichDialogUserContextApi |
getContext()
Returns the Rich Dialog User Context of the current Rich Dialog, which allows access
to user context specific functionalities.
|
ch.ivyteam.ivy.ulc.server.validation.IValidator |
getValidator(com.ulcjava.base.application.ULCComponent widget)
Returns the validator for the given widget.
|
boolean |
isUiEventEnabled(UiEventKind... eventKinds)
Returns true if all given
UiEventKind are enabled. |
void |
setContext(IRichDialogUserContextApi contextApi)
A call to this method will throw an
IllegalAccessException . |
void |
startProcess(ProcessStartConfiguration startConfiguration)
Starts a process.
|
void |
startRichDialog(RichDialogStartConfiguration startConfiguration)
Starts a rich dialog asynchronously.
|
void |
startTask(TaskStartConfiguration startConfiguration)
Starts a task.
|
void |
subscribeToSystemEvents(SystemEventCategory category)
Registers the RichDialog to receive
SystemEvent s of the
given SystemEventCategory . |
void startTask(TaskStartConfiguration startConfiguration)
TaskStartConfiguration
to specify which
task should be started and where any encountered RichDialogs should be
loaded into.startConfiguration
- The start configurationvoid startProcess(ProcessStartConfiguration startConfiguration)
ProcessStartConfiguration
to specify
which process should be started and where any encountered RichDialogs
should be loaded into.startConfiguration
- The start configurationvoid startRichDialog(RichDialogStartConfiguration startConfiguration)
RichDialogStartConfiguration
to specify
which Rich Dialog should be started.
Example 1 starts a Rich Dialog in a new Window and calls the default start-method:
import ch.ivyteam.ivy.richdialog.exec.RichDialogStartConfiguration;
RichDialogStartConfiguration config = RichDialogStartConfiguration.create()
.forRichDialog("ch.foo.bar.MyRichDialog")
.toConfiguration();
ivy.rd.startRichDialog(config);
Example 2 starts the Rich Dialog in a defined display and calls a specified start-method:
import ch.ivyteam.ivy.richdialog.exec.RichDialogStartConfiguration;
RichDialogStartConfiguration config = RichDialogStartConfiguration.create()
.forRichDialog("ch.foo.bar.MyRichDialog")
.useStartMethod("start(String, foo.bar.MyUser)")
.loadInExistingDisplay("MyDisplayId")
.setParameter("text", "Started in a display")
.setParameter("user", in.myUser)
.toConfiguration();
ivy.rd.startRichDialog(config);
startConfiguration
- boolean addEventMapping(com.ulcjava.base.application.ULCComponent eventSource, String eventStartProcessName)
eventSource
- the event source. E.g. a RButton NOTE: the R-Component
must be added to its parent already. In order that the
mapping works, you must give here a R-Component (e.g. RButton)eventStartProcessName
- the name of the RichDialog's
event-process-start to map to.IllegalStateException
- if the preconditions are not fully fulfilled.IllegalArgumentException
- if one of the parameter is empty.void clickDeferred(com.ulcjava.base.application.ULCButton button)
Map a (hidden) button to an event process start, then call this method at the end of another event process or the start method. When the current request has returned to the client, the the button will be clicked, thus immediately triggering another roundtrip to the server and deferredly starting the associated event process.
button
- the button to click deferredvoid subscribeToSystemEvents(SystemEventCategory category)
SystemEvent
s of the
given SystemEventCategory
. Call this method multiple times
if the RichDialog should receive events of multiple categories.
All registered RichDialogs are automatically unregistered when they are unloaded.
category
- the SystemEventCategory
to register forch.ivyteam.ivy.ulc.server.validation.IValidator getValidator(com.ulcjava.base.application.ULCComponent widget)
widget
- the widget to receive the validator for. It must be either a IValidatableWidget or a
IRichContainer object.IllegalArgumentException
- if widget is not an IValidatableWidget or an IRichContainer instancevoid disableUiEvents(UiEventKind... eventKinds)
Disables the execution of UI events of the given event kinds
on this rich dialog.
Disabling of events will only disable the execution of event processes on this Rich Dialog. Other Rich Dialogs especially inner rich dialogs are not affected.
When called without parameters or null, all UiEventKind
are disabled.
eventKinds
- None, one or multiple UiEventKind
to disable.void enableUiEvents(UiEventKind... eventKinds)
event kinds
for this rich dialog.
When called without parameters or null, all UiEventKind
are enabled.eventKinds
- None, one or multiple UiEventKind
to enabled.void disableUiEventsTemporary(UiEventKind... eventKinds)
Disables the execution of UI events of the given event kinds
for this
rich dialog temporarily. The UI events are only disabled during the execution of the Rich
Dialog logic process from which this API method was called. As soon as the process reaches
its end, the temporarily disabled events for this process and rich dialog are re-enabled.
Note, that the data binding will be executed before this.
Note furthermore that UI events are disabled as well in processes that are called within the same process that disabled the UI events (i.e. called this method). Events in an outer process are evidently not affected as the disabling is nullified at the end of the process.
Disabling of events will only disable the execution of UI events for this Rich Dialog. Other Rich Dialogs especially embedded inner Rich Dialogs are not affected.
When called without parameters or null, all UiEventKind
are disabled.
eventKinds
- None, one or multiple UiEventKind
to disable.boolean isUiEventEnabled(UiEventKind... eventKinds)
Returns true if all given UiEventKind
are enabled. When called without
parameters or null, it returns true, when all events are enabled.
Temporary and permanent disabled events are considered.
Note that a event kind
is enabled if it is not disabled explicit (see IRichDialogContext.disableUiEvents(UiEventKind...)
or temporary (see IRichDialogContext.disableUiEventsTemporary(UiEventKind...)
eventKinds
- None, one or multiple UiEventKind
to validate.IRichDialogUserContextApi getContext()
IRichDialogUserContextApi
of the current Rich Dialogvoid setContext(IRichDialogUserContextApi contextApi) throws IllegalAccessException
IllegalAccessException
.
This is a read only property. Allows access to user context specific functionalities.contextApi
- IllegalAccessException
- thrown when the method is calledCopyright © 2024
AXON IVY AG
All Rights Reserved Documentation was generated
on April 28, 2024