commandbox.system.util

Class ProgressBarGeneric

lucee.Component
    extended by commandbox.system.util.ProgressBarGeneric

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com Prints out a progress bar to the screen.

Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
  • author : Brad Wood, Luis Majano, Denny Valliant
  •  
    Property Summary
    type property default serializable required
    any job


    • access = public
    • returntype = any
    • inject = provider:InteractiveJob
    true false
    any print


    • access = public
    • returntype = any
    • inject = Print
    true false
    any shell


    • access = public
    • returntype = any
    • inject = shell
    true false
    any system


    • access = public
    • returntype = any
    • inject = system@constants
    true false
    Constructor Summary
    init()
    Method Summary
    any clear()
    any update(numeric percent, [any currentCount='0'], [any totalCount='0'])
         Call me to update the screen.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    job

    property any job

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:InteractiveJob
    serializable - true

    print

    property any print

    Attributes:
    access - public
    required - false
    returntype - any
    inject - Print
    serializable - true

    shell

    property any shell

    Attributes:
    access - public
    required - false
    returntype - any
    inject - shell
    serializable - true

    system

    property any system

    Attributes:
    access - public
    required - false
    returntype - any
    inject - system@constants
    serializable - true

    Method Detail

    clear

    public any clear()


    update

    public any update(numeric percent, [any currentCount='0'], [any totalCount='0'])

    Call me to update the screen.

    Parameters:
    percent
    currentCount
    totalCount