Package com.evolveum.midpoint.gui.impl.page.admin.task.component

Class SmartTaskProgressPanel

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
com.evolveum.midpoint.gui.api.component.BasePanel<TaskType>
com.evolveum.midpoint.gui.impl.page.admin.task.component.SmartTaskProgressPanel
All Implemented Interfaces:
Popupable, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable
public abstract class SmartTaskProgressPanel extends BasePanel<TaskType> implements Popupable
Popup panel that displays progress of a running task.

Shows a title/subtitle, current task status, elapsed time, and progress information. The panel periodically refreshes itself and updates footer buttons (stop / show results). When the task is finished, the auto-refresh is stopped and the "Show results" action becomes enabled.

The "Stop task" action requests cancellation of the underlying task via SmartIntegrationService. The "See results" action is abstract and should be implemented by concrete subclasses.

See Also:

  • Field Summary

    Fields inherited from class org.apache.wicket.markup.html.panel.Panel

    PANEL

    Fields inherited from class org.apache.wicket.Component

    ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

    Fields inherited from interface com.evolveum.midpoint.web.component.dialog.Popupable

    ID_CONTENT, ID_FOOTER

  • Constructor Summary

    Constructors
    Constructor
    Description
    SmartTaskProgressPanel(String id, org.apache.wicket.model.IModel<String> titleModel, org.apache.wicket.model.IModel<String> subtitleModel, org.apache.wicket.model.IModel<TaskType> taskModel)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.wicket.Component
    getContent()
     
    @NotNull org.apache.wicket.Component
    getFooter()
     
    int
    getHeight()
     
    String
    getHeightUnit()
     
    protected IconWithLabel
    getIconWithLabel()
     
    protected org.apache.wicket.Component
    getProgressBarComponent()
     
    protected org.apache.wicket.model.IModel<String>
    getStopButtonLabel()
     
    org.apache.wicket.model.IModel<String>
    getTitle()
     
    int
    getWidth()
     
    String
    getWidthUnit()
     
    protected boolean
    isShowResultsEnable()
     
    protected void
    onInitialize()
     
    protected abstract void
    onShowResults(org.apache.wicket.ajax.AjaxRequestTarget target)
    Action performed when the "Show results" button is clicked.
    protected void
    onStop(org.apache.wicket.ajax.AjaxRequestTarget target)
     
    protected boolean
    showResultAfterCompletion()
     

    Methods inherited from class com.evolveum.midpoint.gui.api.component.BasePanel

    createComponentPath, createModel, createStringResource, createStringResource, createStringResource, createStringResource, createStringResource, createStringResource, createStringResource, getBrowserTabSessionStorage, getFeedbackPanel, getMidpointConfiguration, getModel, getModelObject, getPageBase, getParentPage, getPrismContext, getRegistry, getSchemaService, getSession, getSessionStorage, getString, getString, getSubscriptionState, getWebApplicationConfiguration, showResult

    Methods inherited from class org.apache.wicket.markup.html.panel.Panel

    getRegionMarkup, newMarkupSourcingStrategy

    Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

    getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

    Methods inherited from class org.apache.wicket.MarkupContainer

    add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

    Methods inherited from class org.apache.wicket.Component

    add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.wicket.IQueueRegion

    dequeue, newDequeueContext

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface com.evolveum.midpoint.web.component.dialog.Popupable

    getCssClassForDialog, getTitleComponent, getTitleIconClass

  • Constructor Details

    • SmartTaskProgressPanel

      public SmartTaskProgressPanel(String id, org.apache.wicket.model.IModel<String> titleModel, org.apache.wicket.model.IModel<String> subtitleModel, org.apache.wicket.model.IModel<TaskType> taskModel)

  • Method Details

    • onInitialize

      protected void onInitialize()
      Overrides:
      onInitialize in class org.apache.wicket.MarkupContainer

    • showResultAfterCompletion

      protected boolean showResultAfterCompletion()

    • getProgressBarComponent

      protected org.apache.wicket.Component getProgressBarComponent()

    • getIconWithLabel

      protected IconWithLabel getIconWithLabel()

    • getStopButtonLabel

      protected org.apache.wicket.model.IModel<String> getStopButtonLabel()

    • getFooter

      @NotNull public @NotNull org.apache.wicket.Component getFooter()
      Specified by:
      getFooter in interface Popupable

    • isShowResultsEnable

      protected boolean isShowResultsEnable()

    • onStop

      protected void onStop(org.apache.wicket.ajax.AjaxRequestTarget target)

    • onShowResults

      protected abstract void onShowResults(org.apache.wicket.ajax.AjaxRequestTarget target)
      Action performed when the "Show results" button is clicked. The button is enabled when the task is finished.

    • getWidth

      public int getWidth()
      Specified by:
      getWidth in interface Popupable

    • getHeight

      public int getHeight()
      Specified by:
      getHeight in interface Popupable

    • getWidthUnit

      public String getWidthUnit()
      Specified by:
      getWidthUnit in interface Popupable

    • getHeightUnit

      public String getHeightUnit()
      Specified by:
      getHeightUnit in interface Popupable

    • getTitle

      public org.apache.wicket.model.IModel<String> getTitle()
      Specified by:
      getTitle in interface Popupable

    • getContent

      public org.apache.wicket.Component getContent()
      Specified by:
      getContent in interface Popupable