Package org.eclnt.ccaddons.pbc

Class CCAsynchronousJobProtocol

java.lang.Object
org.eclnt.jsfserver.pagebean.PageBean
org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase
org.eclnt.jsfserver.pagebean.component.PageBeanComponent
org.eclnt.ccaddons.pbc.CCAsynchronousJobProtocol
All Implemented Interfaces:
Serializable, org.eclnt.jsfserver.elements.IConfiguredByLayout, org.eclnt.jsfserver.pagebean.component.IPageBeanComponent, org.eclnt.jsfserver.pagebean.IPageBean, org.eclnt.jsfserver.util.valuemgmt.IDynamicContentBindingObject
public class CCAsynchronousJobProtocol extends org.eclnt.jsfserver.pagebean.component.PageBeanComponent implements Serializable
See Also:

  • Constructor Details

    • CCAsynchronousJobProtocol

      public CCAsynchronousJobProtocol()

  • Method Details

    • getInfoPaneImage

      public String getInfoPaneImage()

    • setInfoPaneImage

      public void setInfoPaneImage(String value)

    • getRootExpressionUsedInPage

      public String getRootExpressionUsedInPage()
      Specified by:
      getRootExpressionUsedInPage in interface org.eclnt.jsfserver.pagebean.IPageBean
      Specified by:
      getRootExpressionUsedInPage in class org.eclnt.jsfserver.pagebean.PageBean

    • openAsBlockingPopup

      public static CCAsynchronousJobProtocol.OpenPopupResult openAsBlockingPopup(String title, org.eclnt.jsfserver.pagebean.IPageBean caller)

    • openAsBlockingPopup

      public static CCAsynchronousJobProtocol.OpenPopupResult openAsBlockingPopup(String title, org.eclnt.jsfserver.pagebean.IPageBean caller, CCAsynchronousJobProtocol.IListener listener)
      Parameters:
      title -
      caller -
      listener - Listener that is called in the UI thread after the processing has finished.
      Returns:

    • processLongOperation

      public static void processLongOperation(CCAsynchronousJobProtocol asynchronousJobProtocol, Runnable longOpepration)

    • processLongOperation

      public static void processLongOperation(CCAsynchronousJobProtocol asynchronousJobProtocol, Runnable longOpepration, Runnable finishedOperation)
      Parameters:
      title -
      longOpepration - Long lasting operation that is output in parallel thread.
      finishedOperation - Operation after finishing the long lasting operation. This opeartion is executed in the UI thread!
      caller -

    • prepare

      public void prepare(org.eclnt.jsfserver.pagebean.IPageBean caller, CCAsynchronousJobProtocol.IListener listener)

    • getGrid

      public org.eclnt.jsfserver.elements.impl.FIXGRIDListBinding<CCAsynchronousJobProtocol.GridItem> getGrid()

    • getRenderProgressbar

      public boolean getRenderProgressbar()
      Decision if to render the progress bar or not. Default: true.

    • setRenderProgressbar

      public void setRenderProgressbar(boolean value)

    • getProgressValue

      public int getProgressValue()

    • setProgressValue

      public void setProgressValue(int value)

    • getTitle

      public String getTitle()
      Title that is shown.

    • setTitle

      public void setTitle(String value)

    • getFinishedClosePopup

      public boolean getFinishedClosePopup()
      If set to true then the protocol popup is closed directly after the long operation has ended. Otherwise the user has to close the popup him/herself.

    • setFinishedClosePopup

      public void setFinishedClosePopup(boolean finishedClosePopup)

    • getFinishedClosePopupDelay

      public long getFinishedClosePopupDelay()
      If the popup is set to be closed after finishing then you may define a certain delay in addition. Result: the popup does not immediately disappear but is shown to the user a certain while. The delay is passed as number of milliseconds. Default is -1 (no delay).

    • setFinishedClosePopupDelay

      public void setFinishedClosePopupDelay(long finishedClosePopupDelay)

    • getWidthTitleColumn

      public String getWidthTitleColumn()
      Width of the title column. May be set to 0 if you do not want to show it.

    • setWidthTitleColumn

      public void setWidthTitleColumn(String value)

    • getInfoPaneWidth

      public String getInfoPaneWidth()
      Image that is shown inside the info pane. Requires setWithInfoPane(boolean) to be called with "true".

    • setInfoPaneWidth

      public void setInfoPaneWidth(String value)

    • getWithInfoPane

      public boolean getWithInfoPane()
      If set to true then some info area is shown on the left of the protocol area. In the info area you can place an image byu sing setInfoPaneImage(String).

    • setWithInfoPane

      public void setWithInfoPane(boolean value)

    • getTriggerClose

      public org.eclnt.jsfserver.elements.util.Trigger getTriggerClose()

    • getRenderedFooter

      public boolean getRenderedFooter()

    • onPollingAction

      public void onPollingAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event)

    • onTriggeredCloseAction

      public void onTriggeredCloseAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event)

    • getPollingURL

      public String getPollingURL()

    • addProtocolItemFromAsynchronousProcessing

      public void addProtocolItemFromAsynchronousProcessing(CCAsynchronousJobProtocol.ProtocolItem pi)

    • closeFromAsynchronousProcessing

      public void closeFromAsynchronousProcessing()
      Notifies end of long lasting operation - and closes the popup.

    • finishFromAsynchronousProcessing

      public void finishFromAsynchronousProcessing()
      Notifies end of long lasting operation. The popup is continued to be shown so that the user can close by pressing ok.

    • onOKAction

      public void onOKAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event)

    • getEnabledExport

      public boolean getEnabledExport()

    • getEnabledOK

      public boolean getEnabledOK()