Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProgressIndicator

Hierarchy

  • ProgressIndicator

Index

Methods

Methods

endSession

  • endSession(): void

incValue

  • incValue(): Boolean

  • automatically increments the value of the current element for the ProgressIndicator object

    Returns Boolean

setMax

  • setMax(numElements: Number): void

  • dynamically modifies the maximum number of elements whose processing must be shown by the ProgressIndicator object

    Parameters

    • numElements: Number

    Returns void

setMessage

  • setMessage(sessionName: String): void

  • dynamically modifies the name of the execution session for the ProgressIndicator object

    Parameters

    • sessionName: String

    Returns void

setValue

  • setValue(curValue: Number): Boolean

  • sets a current element value for the ProgressIndicator object

    Parameters

    • curValue: Number

    Returns Boolean

stop

  • stop(): void

subSession

  • subSession(numElements: Number, sessionName: String, stoppable?: Boolean): void
  • subSession(numElements: Number, sessionName: String, stoppable?: String): void

  • creates and manages the display of a second ProgressIndicator object in the main ProgressIndicator session being executed

    Parameters

    • numElements: Number
    • sessionName: String
    • Optional stoppable: Boolean

    Returns void

  • creates and manages the display of a second ProgressIndicator object in the main ProgressIndicator session being executed

    Parameters

    • numElements: Number
    • sessionName: String
    • Optional stoppable: String

    Returns void