11. Debugging the Extension

// Available color names and RGB values
var ColorNames = ["Black", "Maroon", "Green", "Olive", "Navy", "Purple", "Teal", "Gray",
                   "Silver", "Red", "Lime", "Yellow", "Blue", "Fuchsia","Aqua", "White",
                   "Money Green", "Sky Blue", "Cream", "Medium Gray", "Orange", "Brown"];

var ColorValues = [0x000000, 0x000080, 0x008000, 0x008080, 0x800000, 0x800080, 0x808000, 0x808080,
                   0xC0C0C0, 0x0000FF, 0x00FF00, 0x00FFFF, 0xFF0000, 0xFF00FF, 0xFFFF00, 0xFFFFFF,
                   0xC0DCC0, 0xF0CAA6, 0xF0FBFF, 0xA4A0A0, 0x00A5FF, 0x004B96];


// This routine is executed when a new operation instance is created.
// It initializes the operation's fields.
function LogAttr_OnCreate(Data)
{
  Data.Description = "Defines the font and color settings for test log items.";
  Data.FontColor = GetColorByName("Black");
  Data.BackColor = GetColorByName("White");
  Data.Bold = false;
  Data.Italic = false;
  Data.Underline = false;
  Data.Strikeout = false;
  Data.PlainTextRemarks = true;
}

// This routine is executed when the operation is being edited.
// It displays the Operation Properties dialog.
function LogAttr_OnSetup(Data)
{
  // Customize the Operation Properties dialog
  var frm = UserForms.laEditForm;

  if (frm.cbFontColor.Properties.Items.Count == 0)
    AddColors(frm.cbFontColor);
  if (frm.cbBackColor.Properties.Items.Count == 0)
    AddColors(frm.cbBackColor);

  frm.cbFontColor.Text = GetColorName(Data.FontColor);
  frm.cbBackColor.Text = GetColorName(Data.BackColor);
  frm.chkBold.Checked = Data.Bold;
  frm.chkItalic.Checked = Data.Italic;
  frm.chkUnderline.Checked = Data.Underline;
  frm.chkStrikeout.Checked = Data.Strikeout;
  frm.cbRemarksFormat.ItemIndex = (Data.PlainTextRemarks ? 1 : 0);

  // Display the Operation Properties dialog and check the results
  if (frm.ShowModal() != mrOk)
    return false;    // No changes were made

  // Save the changes
  Data.FontColor = GetColorByName(frm.cbFontColor.Text);
  Data.BackColor = GetColorByName(frm.cbBackColor.Text);
  Data.Bold = frm.chkBold.Checked;
  Data.Italic = frm.chkItalic.Checked;
  Data.Underline = frm.chkUnderline.Checked;
  Data.Strikeout = frm.chkStrikeout.Checked;
  Data.PlainTextRemarks = (frm.cbRemarksFormat.ItemIndex == 1);

  return true;
}

// This routine is executed by the operation during the test run.
// It creates and returns a new LogAttributes object.
function LogAttr_OnExecute(Data)
{
  var attr = Log.CreateNewAttributes();

  attr.FontColor = Data.FontColor;
  attr.BackColor = Data.BackColor;
  attr.Bold = Data.Bold;
  attr.Italic = Data.Italic;
  attr.Underline = Data.Underline;
  attr.StrikeOut = Data.Strikeout;
  attr.ExtendedMessageAsPlainText = Data.PlainTextRemarks;

  return attr;
}

// Returns the text to be displayed in the Description column of the KDTest editor
function LogAttr_GetDescription(Data)
{
  return Data.Description;
}

// Returns the text to be displayed in the Value column of the KDTest editor
function LogAttr_GetValue(Data)
{
  var str = "Font: " + GetColorName(Data.FontColor);
  if (Data.Bold) str += ", Bold";
  if (Data.Italic) str += ", Italic";
  if (Data.Underline) str += ", Underline";
  if (Data.Strikeout) str += ", Strikeout";
  str += "; Background: " + GetColorName(Data.BackColor);
  str += "; Remarks: " + (Data.PlainTextRemarks ? "Plain text" : "HTML");

  return str;
}

// =====================================================================
// Event handlers for the Operation Properties dialog
// =====================================================================

// Sets the form's focused element
function laEditForm_OnShow(Sender)
{
  UserForms.laEditForm.cbFontColor.SetFocus();
}

// Applies the selected font color to the sample area
function laEditForm_cbFontColor_OnEditValueChanged(Sender)
{
  var frm = UserForms.laEditForm;
  frm.lblSample.Style.Font.Color = GetColorByName(frm.cbFontColor.Text);
}

// Applies the selected background color to the sample area
function laEditForm_cbBackColor_OnEditValueChanged(Sender)
{
  var frm = UserForms.laEditForm;
  frm.lblSample.Style.Color = GetColorByName(frm.cbBackColor.Text);
}

// Applies the specified font style to the sample area
function laEditForm_chkFontStyle_OnClick(Sender)
{
  var frm = UserForms.laEditForm;
  var style = 0;

  if (frm.chkBold.Checked) style |= 0x1;
  if (frm.chkItalic.Checked) style |= 0x2;
  if (frm.chkUnderline.Checked) style |= 0x4;
  if (frm.chkStrikeout.Checked) style |= 0x8;

  frm.lblSample.Style.Font.Style = style;
}

// Displays Help for the Log Attributes operation
function laEditForm_btnHelp_OnClick(Sender)
{
  Help.ShowContext("AQAScriptExtensions.chm", 3041);
}

// =====================================================================
// Event handlers for the in-place editor of the Description column
// =====================================================================

var EditValue;

function GetEditValue(Data)
{
  return EditValue;
}

function SetEditValue(Data, Value)
{
  EditValue = Value;
}

function LogAttr_Description_StartEditing(Data)
{
  EditValue = Data.Description;
}

function LogAttr_Description_ApplyChanges(Data)
{
  Data.Description = EditValue;
}

// =====================================================================
// Helper functions
// =====================================================================

// Populates the specified combo box with predefined color names
function AddColors(Combobox)
{
  var Items = Combobox.Properties.Items;
  Items.Clear();
  for (var i in ColorNames)
    Items.Add(ColorNames[i]);
}

// Returns the RGB value by the color name
function GetColorByName(ColorName)
{
  for (var i in ColorNames)
    if (ColorNames[i] == ColorName)
      return ColorValues[i];

  return ColorValues[0];
}

// Returns the color name by the RGB value
function GetColorName(Color)
{
  for (var i in ColorValues)
    if (ColorValues[i] == Color)
      return ColorNames[i];

  return ColorNames[0];
}