Skip to content

scProgressBar

  scProgressBar is a waitbar like function

  Examples:
  obj=scProgressBar(value, message)
  obj=scProgressBar(value, message, PropName1, PropName2.....)
    create and display a progress bar

  scProgressBar(value)
    updates the most recently created bar

  scProgressBar(string)
    updates the message of the most recently created bar

  scProgressBar(value, obj)
    updates the bar specified by obj

        obj is a JCONTROL object (you need this class installed -see below)
        value: is a scalar between 0 and 1
        message: is a string which may contain HTML formatting tags

  Valid property name/value pairs are:
        Icon:   specifies the icon to be displayed with the progress bar
                    this should be a javax.swing.ImageIcon object or the 
                    name of a file to load via javax.swing.ImageIcon -
                    typically a gif file
        Name:   the name for the title bar
                    (string)
        Step:   value is scaled to a percentage and rounded. The display
                will be updated only if the scaled value is a multiple of
                step. Set step to 5 or 10% to reduce the CPU overhead when
                scProgressBar is called repeatedly from a loop
                    (scalar - default NaN).
                Note: it is better to include such a test in your code
                        loop and call scProgressBar only when an update
                        is required
        Position: the position for the frame (normalized). Note that 
                    width/height will be overridden
        Progbar: 'on' to show a progressbar within the panel, 'off' to
                suppress it
  See also waitbar

  scProgressBar maintains an internal stack of handles to the created 
  progress bars. This stack can be accessed by calling scProgressBar()
  and cleared with scProgressBar(-1).

  scProgressBar('on'/'off') toggles the display of progress bars. Default
  is 'on'. Set to 'off' to use sigTOOL functions from the command line
  with no Java Runtime Environment.

  Requirements:
  The JCONTROL class and its methods are needed and available from 
  MATLAB Central 
  <a href="http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=15580&objectType=FILE">LinkOut</a>

  -------------------------------------------------------------------------
  Author: Malcolm Lidierth 09/07
  Copyright © The Author & King's College London 2007-
  -------------------------------------------------------------------------

  Revisions:
    25.10.08    Revised for R2008b jcontrol with uipanel
    14.10.09    See within