Added frame label drawing support.

Author: supercom32

internal/memory/type_tui_style.go

@@ -26,6 +26,7 @@ type TuiStyleEntryType struct {
 	IsWindowFooterDrawn          bool
 	TextForegroundColor          int32
 	TextBackgroundColor          int32
+	TextLabelColor				 int32
 	TextInputForegroundColor     int32
 	TextInputBackgroundColor int32
 	CursorCharacter    			rune
@@ -69,6 +70,7 @@ func NewTuiStyleEntry(existingStyleEntry ...*TuiStyleEntryType) TuiStyleEntryTyp
 		styleEntry.ProgressBarForegroundPattern = existingStyleEntry[0].ProgressBarForegroundPattern
 		styleEntry.TextForegroundColor = existingStyleEntry[0].TextForegroundColor
 		styleEntry.TextBackgroundColor = existingStyleEntry[0].TextBackgroundColor
+		styleEntry.TextLabelColor = existingStyleEntry[0].TextLabelColor
 		styleEntry.TextInputForegroundColor = existingStyleEntry[0].TextInputForegroundColor
 		styleEntry.TextInputBackgroundColor = existingStyleEntry[0].TextInputBackgroundColor
 		styleEntry.CursorCharacter = existingStyleEntry[0].CursorCharacter
@@ -102,6 +104,7 @@ func NewTuiStyleEntry(existingStyleEntry ...*TuiStyleEntryType) TuiStyleEntryTyp
 		styleEntry.ProgressBarForegroundPattern = constants.CharBlockSolid
 		styleEntry.TextForegroundColor = constants.AnsiColorByIndex[15]
 		styleEntry.TextBackgroundColor = constants.AnsiColorByIndex[0]
+		styleEntry.TextLabelColor = constants.AnsiColorByIndex[15]
 		styleEntry.TextInputForegroundColor = constants.AnsiColorByIndex[15]
 		styleEntry.TextInputBackgroundColor = constants.AnsiColorByIndex[0]
 		styleEntry.CursorCharacter = constants.CharBlockSolid

tui_elements.go

@@ -506,6 +506,40 @@ func drawBorder(layerEntry *memory.LayerEntryType, styleEntry memory.TuiStyleEnt
 	drawFrame(layerEntry, styleEntry, localAttributeEntry, constants.FrameStyleNormal, xLocation, yLocation, width, height)
 }
 
+/*
+DrawFrameLabel allows you to draw a label for a frame. The label will
+be automatically enclosed by the characters "[" and "]" to blend in
+with a border of a frame.
+
+- If the frame label to be drawn falls outside the range of the
+specified layer, then only the visible portion of the border will be
+drawn.
+*/
+func DrawFrameLabel(layerAlias string, styleEntry memory.TuiStyleEntryType, label string, xLocation int, yLocation int) {
+	layerEntry := memory.GetLayer(layerAlias)
+	drawFrameLabel(layerEntry, styleEntry, label, xLocation, yLocation)
+}
+
+/*
+DrawFrameLabel allows you to draw a label for a frame. The label will
+be automatically enclosed by the characters "[" and "]" to blend in
+with a border of a frame.
+
+- If the frame label to be drawn falls outside the range of the
+specified layer, then only the visible portion of the border will be
+drawn.
+*/
+func drawFrameLabel(layerEntry *memory.LayerEntryType, styleEntry memory.TuiStyleEntryType, label string, xLocation int, yLocation int) {
+	attributeEntry := memory.NewAttributeEntry()
+	attributeEntry.ForegroundColor= styleEntry.TextForegroundColor
+	attributeEntry.BackgroundColor= styleEntry.TextBackgroundColor
+	printLayer(layerEntry, attributeEntry, xLocation, yLocation, []rune("[ "))
+	printLayer(layerEntry, attributeEntry, xLocation + 2 + len(label), yLocation, []rune(" ]"))
+	attributeEntry.ForegroundColor = styleEntry.TextLabelColor
+	attributeEntry.BackgroundColor = styleEntry.TextBackgroundColor
+	printLayer(layerEntry, attributeEntry, xLocation + 2, yLocation, []rune(label))
+}
+
 /*
 DrawFrame allows you to draw a frame on a given text layer. Frames differ
 from borders since borders are flat shaded and do not have a raised or

tui_elements_test.go

@@ -129,6 +129,29 @@ func TestDrawButton(test *testing.T) {
 	assert.Equalf(test, expectedValue, obtainedValue ,"The updated screen does not match the master original!")
 }
 
+func TestDrawFrameLabel(test *testing.T) {
+	commonResource.isDebugEnabled = true
+	layerAlias1 := "Layer1"
+	layerWidth := 40
+	layerHeight := 20
+	styleEntry := memory.NewTuiStyleEntry()
+	InitializeTerminal(layerWidth, layerHeight)
+	AddLayer(layerAlias1, 0, 0, layerWidth, layerHeight, 1, "")
+	Color(4, 6)
+	FillLayer(layerAlias1, "a1a2a3a4a5")
+	styleEntry.TextForegroundColor = GetRGBColor(62, 128, 128)
+	styleEntry.TextBackgroundColor = GetRGBColor(0, 0, 200)
+	styleEntry.TextLabelColor = GetRGBColor(255,255,255)
+	DrawFrameLabel(layerAlias1, styleEntry, "My Frame", 1, 1)
+	DrawFrameLabel(layerAlias1, styleEntry, "My Frame", -7, 3)
+	DrawFrameLabel(layerAlias1, styleEntry, "My Frame", layerWidth - 7, 3)
+	UpdateDisplay()
+	layerEntry := commonResource.screenLayer
+	obtainedValue := layerEntry.GetBasicAnsiStringAsBase64()
+	expectedValue := "G1szODsyOzA7MDsxMjhtG1s0ODsyOzA7MTI4OzEyOG1hMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTVhMWEyYTNhNGE1G1szODsyOzA7MDswbRtbNDg7MjswOzA7MG0KG1szODsyOzA7MDsxMjhtG1s0ODsyOzA7MTI4OzEyOG1hG1szODsyOzYyOzEyODsxMjhtG1s0ODsyOzA7MDsyMDBtWyAbWzM4OzI7MjU1OzI1NTsyNTVtTXkgRnJhbWUbWzM4OzI7NjI7MTI4OzEyOG0gXRtbMzg7MjswOzA7MTI4bRtbNDg7MjswOzEyODsxMjhtMmEzYTRhNWExYTJhM2E0YTVhMWEyYTNhNGE1G1szODsyOzA7MDswbRtbNDg7MjswOzA7MG0KG1szODsyOzA7MDsxMjhtG1s0ODsyOzA7MTI4OzEyOG1hMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTVhMWEyYTNhNGE1G1szODsyOzA7MDswbRtbNDg7MjswOzA7MG0KG1szODsyOzI1NTsyNTU7MjU1bRtbNDg7MjswOzA7MjAwbWFtZRtbMzg7Mjs2MjsxMjg7MTI4bSBdG1szODsyOzA7MDsxMjhtG1s0ODsyOzA7MTI4OzEyOG0zYTRhNWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhG1szODsyOzYyOzEyODsxMjhtG1s0ODsyOzA7MDsyMDBtWyAbWzM4OzI7MjU1OzI1NTsyNTVtTXkgRnIbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQobWzM4OzI7MDswOzEyOG0bWzQ4OzI7MDsxMjg7MTI4bWExYTJhM2E0YTVhMWEyYTNhNGE1YTFhMmEzYTRhNWExYTJhM2E0YTUbWzM4OzI7MDswOzBtG1s0ODsyOzA7MDswbQo="
+	assert.Equalf(test, expectedValue, obtainedValue ,"The updated screen does not match the master original!")
+}
+
 func TestDrawFrame(test *testing.T) {
 	commonResource.isDebugEnabled = true
 	layerAlias1 := "Layer1"