Examples of er.coolcomponents.CCAjaxLongResponsePage

er.coolcomponents.CCAjaxLongResponsePage
A generic long response page that controls the execution of and provides user feedback on a long running task. This is designed to be really easy, and flexible, for the developer to re-use.
The common case of running a task and automatically returning to the same originating page is really simple and requires just a few lines of code, for example:
```
  public WOActionResults runLongTask() { Runnable task = new LongRunningTask(); CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class); nextPage.setLongRunningRunnable(task); return nextPage; }  
```
Usage:
1. Create a {@link Runnable} task, or a {@link Callable} task, that returns some result.
  1. Optionally implement the {@link IERXStatus} interface (just one method to return status message) to have the task's status displayed in the long response page.
  2. Optionally implement the {@link IERXPercentComplete} interface (just one method to return percentage complete)to have a progress bar and a percentage complete automatically displayed in the long response page.
  3. Optionally implement the {@link IERXStoppable} interface to allow stopping of the task by the user.
2. If you don't just want the originating page to be returned (default behavior) then
  1. Create a simple class that implements @link {@link er.extensions.appserver.IERXPerformWOActionForResult} interface, or use {@link er.extensions.appserver.ERXNextPageForResultWOAction}, which provides a fairly generic implementation of that interface
  2. This controller class will get the result pushed into it when the task is complete. If the task threw an uncaught error during execution, then the error is pushed in as the result.
  3. The nextPage method of this controller class can do whatever it needs to do with the result and return a new page according to your logic in {@link IERXPerformWOActionForResult#performAction()}.
3. In your component action, simply create an instance of this long response page just as you would create any other page.
4. Push in an instance of your Runnable (or Callable) task into the long response page using {@link #setTask(Object)}
5. Optionally push in your custom next page controller for execution when the task is finished using {@link #setNextPageForResultController(IERXPerformWOActionForResult)}
6. Just return the long response page in your action method
Customizing the CCAjaxLongResponsePage for your Application

This long response page can be easily customized using a custom CSS style sheet and a few system properties.
Customizing the Appearance with CSS

You can create a custom CSS style sheet, place it in any framework (or your app) and set the following two properties to have it used instead of the default CSS style-sheet:

er.coolcomponents.CCAjaxLongResponsePage.stylesheet.framework

Set this the name of the framework that contains the custom css style sheet, or set it to "app" if the style-sheet is in the application bundle.

er.coolcomponents.CCAjaxLongResponsePage.stylesheet.filename

Set this to the filename of the css style sheet.

er.coolcomponents.CCAjaxLongResponsePage.stayOnLongResponsePageIndefinitely

As a convenience for CSS style sheet development, you can temporarily set this property to true to prevent ajax refresh on the long response page and to keep the page open indefinitely even after the task has completed. The property is ignored in deployment mode.

Further Configuration Options

The following properties can be used to implement additional custom behavior:

er.coolcomponents.CCAjaxLongResponsePage.defaultStatus

This determines the default status text when the task does not implement {@link IERXStatus}

er.coolcomponents.CCAjaxLongResponsePage.refreshInterval

This value in seconds determines a custom refresh interval for the update container on the page. The default is 2 seconds

er.coolcomponents.CCAjaxLongResponsePage.nextPageForErrorResultControllerClassName

Defines a custom subclass of IERXPerformWOActionForResult as the default controller class, other than the hard-coded default, for handling task errors for the application. Note that if you declare a constructor that takes a single WOComponent argument, that constructor will be used and the originating page will be passed in as the constructor argument for you to use as you please in your custom error handling logic.

@author kieran

  }
  
  public WOActionResults processFactorials() {
    T06EOFFactorialUpdateTask task = new T06EOFFactorialUpdateTask(taskInfo());
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setTask(task);
    return nextPage;
  }

View Full Code Here

   * @return long response page running the same task in a long response page allowing user to wait and know when it is complete.
   */
  public WOActionResults dispatchBackgroundTaskInLongRsponsePage() {
    Runnable task = new T01T02SimpleBackgroundTask();
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setTask(task);
    
    return nextPage;
  }

View Full Code Here

   * @return long response page running a task that implements {@link IERXStatus}, {@link IERXPercentComplete} and {@link IERXStoppable} interfaces.
   */
  public WOActionResults dispatchBackgroundTaskWithLongResponsePageFeedback() {
    Runnable task = new T03BackgroundTaskWithProgressFeedback();
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setTask(task);
    
    return nextPage;
  }

View Full Code Here

    IERXPerformWOActionForResult controller = new ERXNextPageForResultWOAction(pageWithName(TaskInfoPage.class), "taskInfo");
    
    Callable<EOGlobalID> task = new T04SimpleEOFTask();
    
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setNextPageForResultController(controller);
    nextPage.setTask(task);
    
    return nextPage;
  }

View Full Code Here

    // Set up the controller for the end of task action
    ERXNextPageForResultWOAction controller = new ERXNextPageForResultWOAction(pageWithName(TaskInfoPage.class), "taskInfo");
    
    Callable<EOGlobalID> task = new T05MultiThreadedEOFTask();
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setNextPageForResultController(controller);
    nextPage.setTask(task);
    
    return nextPage;
  }

View Full Code Here

    // Set up the controller for the end of task action
    ERXNextPageForResultWOAction controller = new ERXNextPageForResultWOAction(pageWithName(TaskInfoPage.class), "taskInfo");
    
    Callable<EOGlobalID> task = new T07EOFTaskWithSubTasks();
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setNextPageForResultController(controller);
    nextPage.setTask(task);
    
    return nextPage;
  }

View Full Code Here

   * @return result of an error in a Callable task.
   */
  public WOActionResults dispatchCallableWithSimulatedError() {
    T08CallableWithSimulatedError task = new T08CallableWithSimulatedError();
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setTask(task);
    
    return nextPage;
  }

View Full Code Here

   * @return result of an error in a Runnable task.
   */
  public WOActionResults dispatchRunnableWithSimulatedError() {
    T09RunnableWithSimulatedError task = new T09RunnableWithSimulatedError();
    
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    nextPage.setTask(task);
    
    return nextPage;
  }

View Full Code Here

    
    // Create the task
    Callable<File> reportTask = Reports.createStudioRevenueReportTask();
    
    // Create the long response page
    CCAjaxLongResponsePage nextPage = pageWithName(CCAjaxLongResponsePage.class);
    
    // Push the task into the long response page
    nextPage.setTask(reportTask);
    
    // Controller for handling the Callable result in the long response page
    FileTaskDownloadController nextPageController = new FileTaskDownloadController();
    
    // Hyperlink text on the "Your file is downloaded page" to get back here
    nextPageController.setReturnLinkText("Reports Menu");
    
    // The filename for the download
    nextPageController.setDownloadFileNameForClient("StudioRevenueReport.pdf");
    
    nextPage.setNextPageForResultController(nextPageController);
    
    return nextPage;
    
  }

View Full Code Here

TOP

Related Classes of er.coolcomponents.CCAjaxLongResponsePage

com.webobjects.appserver.WOActionResults

er.extensions.appserver.ERXNextPageForResultWOAction

er.extensions.appserver.IERXPerformWOActionForResult

er.extensions.concurrency.IERXStoppable

er.extensions.foundation.ERXStopWatch

er.jrexample.components.Main

wowodc.background.components.Main

wowodc.background.components.TaskInfoPage

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of er.coolcomponents.CCAjaxLongResponsePage

Usage:

Customizing the CCAjaxLongResponsePage for your Application

Customizing the Appearance with CSS

Further Configuration Options

Related Classes of er.coolcomponents.CCAjaxLongResponsePage