setCaptionBarText

Sets the display caption on the specified bar.

This also sets the image and text on a taskbar button if:

  • the bar type is jsx3.gui.WindowBar
  • the setTaskButton parameter is true
  • a taskbar button exists

Syntax

setCaptionBarText(bar,
                  textHtml,
                  setTaskButton);

Parameters

  • bar - (jsx3.gui.WindowBar or jsx3.gui.Block) The caption bar.
  • textHtml - (String) A text or HTML string value to set on the caption bar.
  • setTaskButton - (boolean) Pass true if textHtml should be applied to setting the taskbar button. This only applies if caption bar is of type jsx3.gui.WindowBar. If this is set to true, textHtml must be of the form:
    • <img src='path/?.gif'><span style='styles'>Caption String</span>

Returns

none