Studio Developer Manual / Version 2107
Table Of ContentsWithin Studio you have two options to visualize your jobs:
- Show your jobs within the BackgroundJobsWindow in the TabsPanel
- Show a progress load mask with the job's progress on a component
Visualize Jobs Within the BackgroundJobsWindow
If you want your jobs to be displayed in the BackgroundJobsWindow, which can be opened via the TabsPanel, your job needs to implement the interface com.coremedia.cms.editor.sdk.jobs.BackgroundJob
.
Show Progress of a Job on a Component
If you want to show the progress of a job on a component (for example a button) you can use the com.coremedia.cms.editor.sdk.jobs.TrackedJobLoadMask
.
It can be bound to a component to show the progress of a job in that component.
The following example shows how to bind the TrackedJobLoadMask
to an example component:
var loadMaskConfig:TrackedJobLoadMask = TrackedJobLoadMask({}); loadMaskConfig.target = exampleComponent; loadMaskConfig.trackedJob = trackedJob; var loadMask:TrackedJobLoadMask = new TrackedJobLoadMask(loadMaskConfig);
Example 5.20.
Note
Don't forget to destroy your load mask within the failure
, abort
and success
function of your job execution.