Name

adams.flow.sink.HistoryDisplay

Synopsis

Actor that outputs any object that arrives at its input port via the 'toString()' method in a separate 'history' entry.

Additional information

Flow input/output:
- input: java.lang.Object

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	HistoryDisplay

  
  
• 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	640
  minimum	-1

  
  
• height
  

  The height of the dialog.

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

  
  
• x
  

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

  command-line	-x <int>
  default	-1
  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

  
  
• font
  

  The font of the dialog.

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

  
  
• alwaysClear
  

  If enabled, the display is always cleared before processing a token.

  command-line	-always-clear <boolean>
  default	false

  
  
• 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

  
  
• caretAtStart
  

  If set to true, then the caret will be positioned by default at the start and not the end (can be changed in dialog: View -> Position caret at start).

  command-line	-caret-at-start <boolean>
  default	false

  
  
• lineWrap
  

  If enabled, line wrap is used.

  command-line	-line-wrap <boolean>
  default	false

  
  
• wrapStyleWord
  

  If enabled, wrapping occurs on word boundaries instead of character boundaries.

  command-line	-wrap-style-word <boolean>
  default	false

  
  
• numTokens
  

  The number of tokens to accept per history entry.

  command-line	-num-tokens <int>
  default	1
  minimum	-1

  
  
• entryNameVariable
  

  The variable to use for naming the entries; gets ignored if variable not available; an existing history entry gets replaced if a new one with the same name gets added.

  command-line	-entry-name-variable <adams.core.VariableNameNoUpdate>
  default	entryNameVariable

  
  
• allowMerge
  

  If enabled then entries with the same name (ie when using 'entryNameVariable') get merged.

  command-line	-allow-merge <boolean>
  default	false

  
  
• allowSearch
  

  Whether to allow the user to search the entries.

  command-line	-allow-search <boolean>
  default	false