Package org.hippoecm.addon.workflow

Class ActionDescription

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
org.hippoecm.addon.workflow.ActionDescription
All Implemented Interfaces:
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, IWorkflowInvoker
Direct Known Subclasses:
StdWorkflow
public abstract class ActionDescription extends org.apache.wicket.markup.html.panel.Panel implements IWorkflowInvoker
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    ActionDescription.ActionDisplay
     

  • 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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActionDescription(String id)
     
    ActionDescription(String id, org.apache.wicket.model.IModel<?> model)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final org.apache.wicket.MarkupContainer
    add(org.apache.wicket.markup.html.panel.Fragment component)
     
    final org.apache.wicket.MarkupContainer
    add(ActionDescription.ActionDisplay component)
     
    String
    getCssClass()
     
    org.apache.wicket.Component
    getFragment(String id)
     
    String
    getSubMenu()
     
    protected abstract void
    invoke()
     
    void
    invokeAsPromise()
     
    void
    invokeWorkflow()
     
    boolean
    isFormSubmitted()
     
    void
    reject(String reason)
    If a workflow invocation has failed it can be rejected.
    void
    resolve(String result)
    After a workflow invocation has finished successfully it can be resolved.
    void
    run()
     

    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, onInitialize, 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, getSession, 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

  • Constructor Details

    • ActionDescription

      public ActionDescription(String id)

    • ActionDescription

      public ActionDescription(String id, org.apache.wicket.model.IModel<?> model)

  • Method Details

    • getSubMenu

      public String getSubMenu()

    • add

      public final org.apache.wicket.MarkupContainer add(org.apache.wicket.markup.html.panel.Fragment component)

    • add

      public final org.apache.wicket.MarkupContainer add(ActionDescription.ActionDisplay component)

    • getFragment

      public org.apache.wicket.Component getFragment(String id)

    • getCssClass

      public String getCssClass()

    • isFormSubmitted

      public boolean isFormSubmitted()

    • run

      public void run()

    • invoke

      protected abstract void invoke()

    • invokeWorkflow

      public void invokeWorkflow() throws Exception
      Specified by:
      invokeWorkflow in interface IWorkflowInvoker
      Throws:
      Exception

    • invokeAsPromise

      public void invokeAsPromise()

    • resolve

      public void resolve(String result)
      Description copied from interface: IWorkflowInvoker
      After a workflow invocation has finished successfully it can be resolved. This is introduced to allow workflow calls to be invoked from javascript via a promise API. For backwards compatibility this method has a default implementation.
      Specified by:
      resolve in interface IWorkflowInvoker
      Parameters:
      result - The result of a workflow call. Can be null.

    • reject

      public void reject(String reason)
      Description copied from interface: IWorkflowInvoker
      If a workflow invocation has failed it can be rejected. This is introduced to allow workflow calls to be invoked from javascript via a promise API. For backwards compatibility this method has a default implementation.
      Specified by:
      reject in interface IWorkflowInvoker
      Parameters:
      reason - The reason the workflow invocation failed. Can be null.