Name

adams.flow.sink.ProgressBar

Synopsis

Displays a progress bar. The incoming token is used as 'current' value to be displayed. For convenience, the incoming token representing a number can also be in string format.

Additional information

Flow input/output:
- input: java.lang.Number, java.lang.String

Headless execution supported: yes

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	ProgressBar

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• shortTitle
  

  If enabled uses just the name for the title instead of the actor's full name.

  command-line	-short-title <boolean>
  default	false

  
  
• displayType
  

  Determines how to show the display, eg as standalone frame (default) or in the Flow editor window.

  command-line	-display-type <adams.flow.core.displaytype.AbstractDisplayType>
  default	adams.flow.core.displaytype.Default
  min-user-mode	Expert

  
  
• width
  

  The width of the dialog.

  command-line	-width <int>
  default	200
  minimum	-1

  
  
• height
  

  The height of the dialog.

  command-line	-height <int>
  default	100
  minimum	-1

  
  
• x
  

  The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right).

  command-line	-x <int>
  default	-3
  minimum	-3

  
  
• y
  

  The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom).

  command-line	-y <int>
  default	-1
  minimum	-3

  
  
• writer
  

  The writer to use for generating the graphics output.

  command-line	-writer <adams.gui.print.JComponentWriter>
  default	adams.gui.print.NullWriter

  
  
• showFlowControlSubMenu
  

  If enabled, adds a flow control sub-menu to the menubar.

  command-line	-show-flow-control-submenu <boolean>
  default	false
  min-user-mode	Expert

  
  
• minimum
  

  The minimum to use.

  command-line	-min <double>
  default	0.0

  
  
• maximum
  

  The maximum to use.

  command-line	-max <double>
  default	100.0

  
  
• bar
  

  The bar color to use.

  command-line	-bar <java.awt.Color>
  default	#0000ff

  
  
• background
  

  The background color to use.

  command-line	-background <java.awt.Color>
  default	#c0c0c0

  
  
• foreground
  

  The foreground color to use.

  command-line	-foreground <java.awt.Color>
  default	#ffffff

  
  
• prefix
  

  The prefix string to print before the percentage.

  command-line	-prefix <java.lang.String>
  default

  
  
• format
  

  The format string to use for outputting the current value, use empty string to suppress output.

  command-line	-format <adams.data.DecimalFormatString>
  default	#.#%
  more	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/DecimalFormat.html

  
  
• suffix
  

  The suffix string to print before the percentage.

  command-line	-suffix <java.lang.String>
  default

  
  
• font
  

  The font to use for the current value.

  command-line	-font <java.awt.Font>
  default	helvetica-BOLD-16

  
  
• title
  

  The optional title for the progressbar.

  command-line	-title <java.lang.String>
  default

  
  
• titleFont
  

  The font to use for the title.

  command-line	-title-font <java.awt.Font>
  default	helvetica-PLAIN-12

  
  
• showStopButton
  

  If enabled, a button to stop the flow is shown as well.

  command-line	-show-stop-button <boolean>
  default	false