Package org.zkoss.zkmax.ui.util

Class LoadingbarControl

java.lang.Object
org.zkoss.zkmax.ui.util.LoadingbarControl
public class LoadingbarControl extends Object
Utilities to control Loadingbar from server side. Note: this class makes accessing 'client-side' more directly.
Since:
9.0.0
Author:
leon
See Also:

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    LoadingbarControl(String id, Integer animationSpeed)
    The constructor of LoadingbarControl.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    finish()
    Finish the Loadingbar.
    String
    getId()
    Get the Loadingbar id.
    void
    start()
    Display a Loadingbar(value is 0) on the top of browser window.
    void
    start(int value)
    Display a Loadingbar on the top of browser window.
    void
    start(int value, String position)
    Display a Loadingbar.
    void
    start(int value, String position, boolean indeterminate)
    Display a Loadingbar.
    void
    update(boolean indeterminate)
    Set indeterminate to the Loadingbar.
    void
    update(int value)
    Set the value to the Loadingbar.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LoadingbarControl

      protected LoadingbarControl(String id, Integer animationSpeed)
      The constructor of LoadingbarControl.
      Parameters:
      id - the Loadingbar id.

  • Method Details

    • getId

      public String getId()
      Get the Loadingbar id.

    • start

      public void start()
      Display a Loadingbar(value is 0) on the top of browser window. see start(int)

    • start

      public void start(int value)
      Display a Loadingbar on the top of browser window.
      Parameters:
      value - the current value of the Loadingbar.

      Range: 0~100, default 0. see start(int, String)

    • start

      public void start(int value, String position)
      Display a Loadingbar.
      Parameters:
      value - the current value of the Loadingbar.

      Range: 0~100, default 0.

      position - predefined positions. Available options are "top", "bottom" default "top". see start(int, String, boolean)

    • start

      public void start(int value, String position, boolean indeterminate)
      Display a Loadingbar.
      Parameters:
      value - the current value of the Loadingbar.

      Range: 0~100, default 0.

      position - predefined positions. Available options are "top", "bottom" default "top".
      indeterminate - whether to start the indeterminate animation or not, default false.

    • update

      public void update(int value)
      Set the value to the Loadingbar. Once the value is set to 100, the Loadingbar will be detached after the animation.
      Parameters:
      value - the current value of the Loadingbar.

      Range: 0~100, default 0.

    • update

      public void update(boolean indeterminate)
      Set indeterminate to the Loadingbar.
      Parameters:
      indeterminate - whether to start the indeterminate animation or not, default false.

    • finish

      public void finish()
      Finish the Loadingbar. The Loadingbar will be detached after the animation.