Modules reahl.domainui.workflow and reahl.domainui.bootstrap.workflow¶
Note
These modules have identical APIs.
The old version (reahl.domainui.workflow)¶
A User interface that allows a user to monitor tasks allocated to the user’s queues and to complete those tasks.
InboxUI¶
-
class
reahl.domainui.workflow.InboxUI(parent_ui, relative_base_path, slot_map, for_bookmark, name, **ui_arguments)¶ A user-facing UserInterface for monitoring an
reahl.systemaccountmodel.Inbox. It allows a user to work on tasks.- Slots:
- main_slot: All UI elements are put into this Slot for any View in this UserInterface.
- Views
Call
AccountUI.get_bookmark()passing one of these relative URLs as the relative_url kwarg in order to get a Bookmark for the View listed below:- /
- The inbox itself.
TaskWidget¶
-
class
reahl.domainui.workflow.TaskWidget(view, task)¶ The Widget used to display a particular
reahl.workflowdomain.Task.Programmers need to create a subclass of TaskWidget to display a particular Task, also written by the programmer. Such a Widget should display whatever a user needs to see to complete the Task, including the relevant Buttons for deferring, or releasing the Task.
Register each of your TaskWidget subclasses in your .reahlproject file as a class on the entrypoint ‘reahl.workflowui.task_widgets’. For example:
<export entrypoint="reahl.workflowui.task_widgets" name="TaskWidget" locator="reahl.domainui.workflow:TaskWidget"/>
-
classmethod
displays(task)¶ Override this method, and let it return True only if cls is the correct Widget for displaying the given task instance.
-
classmethod
The Bootstrap-styled version (reahl.domainui.bootstrap.workflow)¶
New in version 3.2.
A User interface that allows a user to monitor tasks allocated to the user’s queues and to complete those tasks.
This (experimental) version is based on the new bootstrap-based Widgets (reahl.web.bootstrap).
InboxUI¶
-
class
reahl.domainui.bootstrap.workflow.InboxUI(parent_ui, relative_base_path, slot_map, for_bookmark, name, **ui_arguments)¶ A user-facing UserInterface for monitoring an
reahl.systemaccountmodel.Inbox. It allows a user to work on tasks.- Slots:
- main_slot: All UI elements are put into this Slot for any View in this UserInterface.
- Views
Call
AccountUI.get_bookmark()passing one of these relative URLs as the relative_url kwarg in order to get a Bookmark for the View listed below:- /
- The inbox itself.
TaskWidget¶
-
class
reahl.domainui.bootstrap.workflow.TaskWidget(view, task)¶ The Widget used to display a particular
reahl.workflowdomain.Task.Programmers need to create a subclass of TaskWidget to display a particular Task, also written by the programmer. Such a Widget should display whatever a user needs to see to complete the Task, including the relevant Buttons for deferring, or releasing the Task.
Register each of your TaskWidget subclasses in your .reahlproject file as a class on the entrypoint ‘reahl.workflowui.task_widgets’. For example:
<export entrypoint="reahl.workflowui.task_widgets" name="TaskWidget" locator="reahl.domainui.workflow:TaskWidget"/>
-
classmethod
displays(task)¶ Override this method, and let it return True only if cls is the correct Widget for displaying the given task instance.
-
classmethod